Flutter HTML

https://pub.dev/documentation/flutter_html/latest
Admin
Flutter HTML is a Flutter widget library for rendering HTML and CSS as native Flutter widgets with...
Tokens:83,698
Snippets:820
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### HtmlPadding.inlineStart

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlPaddings/inlineStart.html

The inlineStart property is a final field of type HtmlPadding? that specifies the padding at the start of the inline axis.

```APIDOC
## Property: inlineStart

### Description
Defines the padding applied to the start edge of an element. This property is layout-direction-aware, meaning it maps to the left in LTR layouts and the right in RTL layouts.

### Type
`HtmlPadding?`

### Implementation
```dart
final HtmlPadding? inlineStart;
```
```

--------------------------------

### Define inlineStart property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Margins/inlineStart.html

Declaration of the optional Margin property for inline start spacing.

```dart
final Margin? inlineStart;
```

--------------------------------

### void setupParentData(RenderBox child)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/setupParentData.html

Overrides the setupParentData method to ensure that the child's parentData is correctly initialized as a CSSBoxParentData instance.

```APIDOC
## void setupParentData(RenderBox child)

### Description
Initializes the parent data for a child RenderBox. This method checks if the child's current parentData is an instance of CSSBoxParentData; if not, it assigns a new instance of CSSBoxParentData to the child.

### Parameters
- **child** (RenderBox) - The child element for which the parent data needs to be configured.
```

--------------------------------

### Get textDirection property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/textDirection.html

Retrieves the current TextDirection value.

```dart
TextDirection get textDirection => _textDirection;
```

--------------------------------

### Size get paddingSize

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/paddingSize.html

Retrieves the current Size of the padding.

```APIDOC
## Size get paddingSize

### Description
Returns the current Size object representing the padding dimensions.

### Signature
`Size get paddingSize`
```

--------------------------------

### prepareFromExtension Implementation

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlParser/prepareFromExtension.html

The core logic for matching an ExtensionContext against available extensions and built-ins to return a StyledElement.

```dart
StyledElement prepareFromExtension(
  ExtensionContext extensionContext,
  List<StyledElement> children, {
  Set<HtmlExtension> extensionsToIgnore = const {},
}) {
  // Loop through every extension and see if it can handle this node
  for (final extension in extensions) {
    if (!extensionsToIgnore.contains(extension) &&
        extension.matches(extensionContext)) {
      return extension.prepare(extensionContext, children);
    }
  }

  // Loop through built in elements and see if they can handle this node.
  for (final builtIn in builtIns) {
    if (!extensionsToIgnore.contains(builtIn) &&
        builtIn.matches(extensionContext)) {
      return builtIn.prepare(extensionContext, children);
    }
  }

  // If no extension or built-in matches, then return an empty content element.
  return EmptyContentElement(node: extensionContext.node);
}
```

--------------------------------

### Get paddingSize

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/paddingSize.html

Retrieves the current padding size value.

```dart
Size get paddingSize => _paddingSize;
```

--------------------------------

### OnImageTapExtension Constructor

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/OnImageTapExtension-class.html

Initializes the OnImageTapExtension with a required tap handler.

```APIDOC
## Constructor: OnImageTapExtension

### Description
Creates an instance of OnImageTapExtension to handle image tap interactions.

### Parameters
- **onImageTap** (OnTap) - Required - The callback function triggered when an image is tapped.
```

--------------------------------

### Size get borderSize

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/borderSize.html

Retrieves the current size of the border.

```APIDOC
### Size get borderSize

#### Description
Returns the current Size object representing the border dimensions.

#### Signature
`Size get borderSize`
```

--------------------------------

### Initialize ImageExtension

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ImageExtension/ImageExtension.html

The constructor allows configuration of asset, data, and network image handling, as well as custom builder logic.

```dart
ImageExtension({
  super.assetBundle,
  super.assetPackage,
  super.assetSchema = "asset:",
  super.dataEncoding,
  super.fileExtensions,
  super.mimeTypes,
  super.networkDomains,
  super.networkHeaders,
  super.networkSchemas = const {"http", "https"},
  super.handleAssetImages = true,
  super.handleDataImages = true,
  super.handleNetworkImages = true,
  Widget? child,
  Widget Function(ExtensionContext)? builder,
}) {
  if (child != null) {
    this.builder = (_) => WidgetSpan(child: child);
  } else {
    this.builder = (context) => WidgetSpan(child: builder!.call(context));
  }
}
```

--------------------------------

### Get borderSize property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/borderSize.html

Retrieves the current Size of the border.

```dart
Size get borderSize => _borderSize;
```

--------------------------------

### prepareFromExtension(ExtensionContext extensionContext, List<StyledElement> children, {Set<HtmlExtension> extensionsToIgnore})

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlParser/prepareFromExtension.html

Prepares the html node using one of the built-ins or HtmlExtensions available. If none of the extensions matches, returns an EmptyContentElement.

```APIDOC
## prepareFromExtension

### Description
Prepares the html node using one of the built-ins or HtmlExtensions available. If none of the extensions matches, returns an EmptyContentElement.

### Signature
StyledElement prepareFromExtension(
  ExtensionContext extensionContext, 
  List<StyledElement> children, {
  Set<HtmlExtension> extensionsToIgnore = const {},
})

### Parameters
- **extensionContext** (ExtensionContext) - Required - The context of the HTML node being processed.
- **children** (List<StyledElement>) - Required - The list of child elements associated with the node.
- **extensionsToIgnore** (Set<HtmlExtension>) - Optional - A set of extensions to exclude from the matching process.
```

--------------------------------

### HtmlParser(Key? key, Element htmlData, OnTap? onLinkTap, OnTap? onAnchorTap, OnCssParseError? onCssParseError, bool shrinkWrap, Map<String, Style> style, List<HtmlExtension> extensions, Set<String>? doNotRenderTheseTags, Set<String>? onlyRenderTheseTags, Html? root)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlParser/HtmlParser.html

Initializes a new instance of the HtmlParser widget with configuration for rendering behavior, styling, and event handling.

```APIDOC
## HtmlParser Constructor

### Description
Initializes the HtmlParser widget to parse and render HTML elements. It provides hooks for link interaction, CSS error handling, and fine-grained control over which tags are rendered.

### Parameters
- **key** (Key?) - Required - The widget key.
- **htmlData** (Element) - Required - The HTML element data to be parsed.
- **onLinkTap** (OnTap?) - Required - Callback triggered when a link is tapped.
- **onAnchorTap** (OnTap?) - Required - Callback triggered when an anchor is tapped.
- **onCssParseError** (OnCssParseError?) - Required - Callback for handling CSS parsing errors.
- **shrinkWrap** (bool) - Required - Whether the widget should shrink-wrap its content.
- **style** (Map<String, Style>) - Required - A map defining styles for specific HTML tags.
- **extensions** (List<HtmlExtension>) - Required - A list of extensions to customize rendering behavior.
- **doNotRenderTheseTags** (Set<String>?) - Required - A set of tags that should be excluded from rendering.
- **onlyRenderTheseTags** (Set<String>?) - Required - A set of tags that are exclusively rendered.
- **root** (Html?) - Optional - The root HTML node.
```

--------------------------------

### Width get width

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/width.html

Retrieves the current Width configuration of the RenderCSSBox.

```APIDOC
## Width get width

### Description
Returns the current width value associated with the RenderCSSBox.

### Signature
`Width get width`
```

--------------------------------

### Content(String? replacementContent)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Content/Content.html

Initializes a new instance of the Content class with optional replacement content.

```APIDOC
## Content Constructor

### Description
Creates a new Content instance. This constructor is constant and sets the internal display state to true.

### Signature
`const Content(String? replacementContent)`

### Parameters
- **replacementContent** (String?) - Optional - The content to be used as a replacement.
```

--------------------------------

### Get width property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/width.html

Retrieves the current width value from the RenderCSSBox.

```dart
Width get width => _width;
```

--------------------------------

### MatcherExtension(required bool matcher, Widget? child, Widget builder?)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/MatcherExtension/MatcherExtension.html

Creates a new MatcherExtension instance. You must provide a matcher function and either a child widget or a builder function to define the rendering logic.

```APIDOC
## MatcherExtension Constructor

### Description
Initializes a new MatcherExtension. This extension evaluates HTML elements using the `matcher` function and renders them using either a static `child` or a dynamic `builder` function.

### Parameters
- **matcher** (bool Function(ExtensionContext)) - Required - A function that returns true if the extension should apply to the current element.
- **child** (Widget?) - Optional - A static widget to render if the matcher returns true. Either this or `builder` must be provided.
- **builder** (Widget Function(ExtensionContext)?) - Optional - A function that returns a widget to render based on the current context. Either this or `child` must be provided.
```

--------------------------------

### bool get shrinkWrap

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/shrinkWrap.html

Retrieves the current shrinkWrap state of the RenderCSSBox.

```APIDOC
## bool get shrinkWrap

### Description
Returns the current boolean value indicating if the box is set to shrink-wrap its content.

### Signature
`bool get shrinkWrap`
```

--------------------------------

### ImageTapExtensionElement(constructor)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ImageTapExtensionElement/ImageTapExtensionElement.html

Initializes a new ImageTapExtensionElement with the provided node, style, and optional metadata.

```APIDOC
## ImageTapExtensionElement

### Description
Creates a new instance of ImageTapExtensionElement for handling image tap interactions within the flutter_html rendering engine.

### Constructor Signature
ImageTapExtensionElement({
  List<StyledElement> children = const [],
  List<String> elementClasses = const [],
  String elementId = "[[No ID]]",
  String name = "[[No name]]",
  required Node node,
  required Style style
})

### Parameters
- **children** (List<StyledElement>) - Optional - A list of child elements contained within this element.
- **elementClasses** (List<String>) - Optional - A list of CSS classes associated with the element.
- **elementId** (String) - Optional - The unique identifier for the element.
- **name** (String) - Optional - The name of the element.
- **node** (Node) - Required - The underlying DOM node associated with this element.
- **style** (Style) - Required - The style configuration applied to this element.
```

--------------------------------

### Get margins property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/margins.html

Retrieves the current margins value from the RenderCSSBox.

```dart
Margins get margins => _margins;
```

--------------------------------

### Height get height

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/height.html

Retrieves the current Height configuration of the RenderCSSBox.

```APIDOC
## Height get height

### Description
Returns the current `Height` object associated with the `RenderCSSBox`.

### Signature
`Height get height`
```

--------------------------------

### Add VideoHtmlExtension dependency

Source: https://pub.dev/documentation/flutter_html/latest/index.html

Command to add the video extension package to your project.

```bash
flutter pub add flutter_html_video
```

--------------------------------

### Define HtmlPadding inlineStart

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlPaddings/inlineStart.html

Implementation of the inlineStart property as a nullable HtmlPadding type.

```dart
final HtmlPadding? inlineStart;
```

--------------------------------

### Get height property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/height.html

Retrieves the current height value from the RenderCSSBox.

```dart
Height get height => _height;
```

--------------------------------

### Display get display

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/display.html

Retrieves the current display configuration for the RenderCSSBox.

```APIDOC
## Display get display

### Description
Returns the current `Display` value associated with the `RenderCSSBox`.

### Signature
`Display get display`
```

--------------------------------

### Get display property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/display.html

Retrieves the current display state of the RenderCSSBox.

```dart
Display get display => _display;
```

--------------------------------

### Marker.new

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Marker/Marker.html

Initializes a new instance of the Marker class with optional content and style configurations.

```APIDOC
## Marker.new

### Signature
Marker({Content content = Content.normal, Style? style})

### Parameters
- **content** (Content) - Optional - The content type for the marker, defaults to Content.normal.
- **style** (Style) - Optional - The style configuration for the marker.
```

--------------------------------

### StyledElement prepare(ExtensionContext context, List<StyledElement> children)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ImageExtension/prepare.html

Converts parsed HTML context and children into an ImageElement.

```APIDOC
## prepare(ExtensionContext context, List<StyledElement> children)

### Description
Converts parsed HTML into a StyledElement. This method extracts image-specific attributes such as width, height, src, and alt from the provided ExtensionContext to construct an ImageElement.

### Parameters
- **context** (ExtensionContext) - The context containing the HTML element attributes and node information.
- **children** (List<StyledElement>) - The list of child elements associated with the current node.

### Returns
- **StyledElement** - An ImageElement instance representing the processed image.
```

--------------------------------

### HtmlPaddings get htmlPadding

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/PaddingsFromEdgeInsets/htmlPadding.html

Retrieves the padding configuration as an HtmlPaddings object.

```APIDOC
## HtmlPaddings get htmlPadding

### Description
Returns an `HtmlPaddings` object initialized with the current top, bottom, left, and right padding values.

### Signature
`HtmlPaddings get htmlPadding`
```

--------------------------------

### GET /WhiteSpace/values

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/WhiteSpace/values-constant.html

Retrieves the constant list of all values defined in the WhiteSpace enum.

```APIDOC
## GET /WhiteSpace/values

### Description
Returns a constant List of the values in the WhiteSpace enum, ordered by their declaration.

### Method
GET

### Endpoint
/WhiteSpace/values

### Response
#### Success Response (200)
- **values** (List<WhiteSpace>) - A constant list of all enum members.
```

--------------------------------

### Width Class Constructors

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Width-class.html

Details on how to instantiate the Width class.

```APIDOC
## Width Constructors

### Description
Constructors for creating a Width object with specific values or automatic sizing.

### Constructors
- **Width(double value, [Unit unit = Unit.px])** - Creates a Width instance with a specific value and unit (defaults to px).
- **Width.auto()** - Creates a Width instance set to auto.
```

--------------------------------

### Implement the prepare method

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlExtension/prepare.html

This method constructs a StyledElement using the provided ExtensionContext and child elements.

```dart
StyledElement prepare(
    ExtensionContext context, List<StyledElement> children) {
  return StyledElement(
    node: context.node,
    style: Style(),
    elementClasses: context.classes.toList(),
    elementId: context.id,
    children: children,
    name: context.elementName,
  );
}
```

--------------------------------

### GET /Unit/values

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Unit/values-constant.html

Retrieves the constant list of all values defined in the Unit enum.

```APIDOC
## GET /Unit/values

### Description
Returns a constant List of the values in the Unit enum, ordered by their declaration.

### Method
GET

### Endpoint
/Unit/values

### Response
#### Success Response (200)
- **values** (List<Unit>) - A constant list of all enum members in order of declaration.
```

--------------------------------

### Get shrinkWrap property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/shrinkWrap.html

Retrieves the current boolean value of the shrinkWrap property.

```dart
bool get shrinkWrap => _shrinkWrap;
```

--------------------------------

### Add AudioHtmlExtension dependency

Source: https://pub.dev/documentation/flutter_html/latest/index.html

Command to add the audio extension package to your project.

```bash
flutter pub add flutter_html_audio
```

--------------------------------

### Margins get margins

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/margins.html

Retrieves the current Margins object associated with the RenderCSSBox.

```APIDOC
## Margins get margins

### Description
Returns the current `Margins` object applied to the box.

### Signature
`Margins get margins`
```

--------------------------------

### Html Widget Constructors

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Html-class.html

This section details the different ways to create an Html widget instance.

```APIDOC
## Html Constructors

### Html

```dart
Html({
  Key? key,
  GlobalKey<State<StatefulWidget>>? anchorKey,
  required String? data,
  OnTap? onLinkTap,
  OnTap? onAnchorTap,
  List<HtmlExtension> extensions = const [],
  OnCssParseError? onCssParseError,
  bool shrinkWrap = false,
  Set<String>? onlyRenderTheseTags,
  Set<String>? doNotRenderTheseTags,
  Map<String, Style> style = const {},
})
```

**Description**: The `Html` widget takes HTML as input and displays a RichText tree of the parsed HTML content.

### Html.fromDom

```dart
Html.fromDom({
  Key? key,
  GlobalKey<State<StatefulWidget>>? anchorKey,
  required Document? document,
  OnTap? onLinkTap,
  OnTap? onAnchorTap,
  List<HtmlExtension> extensions = const [],
  OnCssParseError? onCssParseError,
  bool shrinkWrap = false,
  Set<String>? doNotRenderTheseTags,
  Set<String>? onlyRenderTheseTags,
  Map<String, Style> style = const {},
})
```

### Html.fromElement

```dart
Html.fromElement({
  Key? key,
  GlobalKey<State<StatefulWidget>>? anchorKey,
  required Element? documentElement,
  OnTap? onLinkTap,
  OnTap? onAnchorTap,
  List<HtmlExtension> extensions = const [],
  OnCssParseError? onCssParseError,
  bool shrinkWrap = false,
  Set<String>? doNotRenderTheseTags,
  Set<String>? onlyRenderTheseTags,
  Map<String, Style> style = const {},
})
```
```

--------------------------------

### double get emValue

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/FontSize/emValue.html

Retrieves the numerical value of the font size as a double.

```APIDOC
## double get emValue

### Description
Returns the underlying double value of the FontSize instance.

### Signature
`double get emValue`

### Returns
- **double**: The font size value.
```

--------------------------------

### HtmlPadding Constructors

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlPadding-class.html

Provides information on how to create instances of the HtmlPadding class.

```APIDOC
## HtmlPadding Constructors

### HtmlPadding(double value, [Unit? unit = Unit.px])

Creates a new HtmlPadding instance with a specified value and unit.

### HtmlPadding.zero()

Creates a new HtmlPadding instance with a value of zero.
```

--------------------------------

### bool get isBlock

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Display/isBlock.html

A getter that returns true if the displayOutside property is equal to DisplayOutside.block.

```APIDOC
## bool get isBlock

### Description
Evaluates whether the current display context is a block-level element by checking if `displayOutside` is equal to `DisplayOutside.block`.

### Returns
- **bool**: Returns `true` if the element is a block, otherwise `false`.
```

--------------------------------

### Implementation of buildFromExtension

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlParser/buildFromExtension.html

This method checks extensions and built-in handlers to determine how to render a node, returning an empty TextSpan if no match is found.

```dart
InlineSpan buildFromExtension(
  ExtensionContext extensionContext, {
  Set<HtmlExtension> extensionsToIgnore = const {},
}) {
  // Loop through every extension and see if it can handle this node
  for (final extension in extensions) {
    if (!extensionsToIgnore.contains(extension) &&
        extension.matches(extensionContext)) {
      return extension.build(extensionContext);
    }
  }

  // Loop through built in elements and see if they can handle this node.
  for (final builtIn in builtIns) {
    if (!extensionsToIgnore.contains(builtIn) &&
        builtIn.matches(extensionContext)) {
      return builtIn.build(extensionContext);
    }
  }

  return const TextSpan(text: "");
}
```

--------------------------------

### Get childIsReplaced property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox/childIsReplaced.html

Retrieves the current boolean state indicating if the child is a replaced element.

```dart
bool get childIsReplaced => _childIsReplaced;
```

--------------------------------

### StyledElement prepare(ExtensionContext context, List<StyledElement> children)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/OnImageTapExtension/prepare.html

Converts parsed HTML to a StyledElement by returning an ImageTapExtensionElement with the provided context and children.

```APIDOC
## Method: prepare

### Description
Converts parsed HTML to a StyledElement. This method is used to wrap existing elements in an `ImageTapExtensionElement` to enable tap functionality.

### Signature
`StyledElement prepare(ExtensionContext context, List<StyledElement> children)`

### Parameters
- **context** (ExtensionContext) - The context containing information about the current HTML element, such as ID and classes.
- **children** (List<StyledElement>) - The list of child elements to be processed.

### Returns
- **StyledElement** - An `ImageTapExtensionElement` containing the processed children and metadata.
```

--------------------------------

### blockStart property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Margins/blockStart.html

The blockStart property is a final Margin object that specifies the margin at the start of a block element.

```APIDOC
## blockStart

### Description
Defines the margin at the start of a block element.

### Signature
`final Margin? blockStart;`
```

--------------------------------

### Initialize HtmlExtension

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlExtension/HtmlExtension.html

Use the constant constructor to create an instance of HtmlExtension.

```dart
const HtmlExtension();
```

--------------------------------

### Implementing the prepare method

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/OnImageTapExtension/prepare.html

This method overrides the base prepare function to return an ImageTapExtensionElement, incorporating the original children and context metadata.

```dart
@override
StyledElement prepare(
    ExtensionContext context, List<StyledElement> children) {
  return ImageTapExtensionElement(
    node: html.Element.tag("img-tap"),
    style: Style(),
    children: [
      super.prepare(context, children),
    ],
    name: "img-tap",
    elementId: context.id,
    elementClasses: context.classes.toList(),
  );
}
```

--------------------------------

### RenderBox Methods

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox-class.html

A collection of methods for managing children, computing layouts, and debugging RenderBox objects.

```APIDOC
## Methods

### add(RenderBox child)
- **Description**: Append child to the end of this render object's child list.

### addAll(List<RenderBox>? children)
- **Description**: Add all the children to the end of this render object's child list.

### adoptChild(RenderObject child)
- **Description**: Called by subclasses when they decide a render object is a child.

### computeDryLayout(BoxConstraints constraints)
- **Description**: Computes the value returned by getDryLayout. Do not call this function directly, instead, call getDryLayout.
- **Returns**: Size

### computeMaxIntrinsicHeight(double width)
- **Description**: Computes the value returned by getMaxIntrinsicHeight. Do not call this function directly, instead, call getMaxIntrinsicHeight.
- **Returns**: double

### computeMinIntrinsicWidth(double height)
- **Description**: Computes the value returned by getMinIntrinsicWidth. Do not call this function directly, instead, call getMinIntrinsicWidth.
- **Returns**: double
```

--------------------------------

### int get hashCode

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/AnchorKey/hashCode.html

Returns the hash code for the AnchorKey object, calculated based on the parentKey and id properties.

```APIDOC
## int get hashCode

### Description
The hash code for this object. A hash code is a single integer which represents the state of the object that affects operator == comparisons.

### Implementation
```dart
@override
int get hashCode => parentKey.hashCode ^ id.hashCode;
```
```

--------------------------------

### Implementation of htmlPadding property

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/PaddingsFromEdgeInsetsDirectional/htmlPadding.html

This getter constructs an HtmlPaddings object using the current top, bottom, start, and end values.

```dart
HtmlPaddings get htmlPadding {
  return HtmlPaddings(
    top: HtmlPadding(top),
    bottom: HtmlPadding(bottom),
    inlineStart: HtmlPadding(start),
    inlineEnd: HtmlPadding(end),
  );
}
```

--------------------------------

### ImageElement Constructor

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ImageElement-class.html

Details for initializing an ImageElement instance.

```APIDOC
## Constructor: ImageElement

### Description
Creates an instance of ImageElement to display an image within the styled document structure.

### Parameters
- **name** (String) - Required - The name of the element.
- **children** (List<StyledElement>) - Required - The child elements.
- **style** (Style) - Required - The style configuration for the element.
- **node** (Node) - Required - The underlying DOM node.
- **elementId** (String) - Required - The unique identifier for the element.
- **src** (String) - Required - The source URL of the image.
- **alt** (String?) - Required - The alternative text for the image.
- **width** (Width?) - Required - The width of the image.
- **height** (Height?) - Required - The height of the image.
```

--------------------------------

### OnImageTapExtension(OnTap onImageTap)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/OnImageTapExtension/OnImageTapExtension.html

Initializes a new instance of OnImageTapExtension with a required callback function for image tap events.

```APIDOC
## OnImageTapExtension(OnTap onImageTap)

### Description
Creates an instance of OnImageTapExtension to handle image tap interactions.

### Parameters
- **onImageTap** (OnTap) - Required - A callback function executed when an image is tapped.
```

--------------------------------

### double get horizontal

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Margins/horizontal.html

Retrieves the total horizontal margin by calculating the sum of the left (or inlineStart) and right (or inlineEnd) margin values.

```APIDOC
## double get horizontal

### Description
Returns the total margin in the horizontal direction. It calculates the sum of the left and right margins, falling back to inlineStart and inlineEnd respectively if the primary values are null.

### Return Value
- **double** - The calculated total horizontal margin.
```

--------------------------------

### HtmlPaddings.all(double value, [Unit? unit])

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlPaddings/HtmlPaddings.all.html

Creates an instance of HtmlPaddings where all sides are initialized with the same padding value and unit.

```APIDOC
## HtmlPaddings.all

### Description
Creates an HtmlPaddings object with uniform padding applied to all sides (left, right, top, and bottom).

### Signature
`HtmlPaddings.all(double value, [Unit? unit])`

### Parameters
- **value** (double) - Required - The numeric value for the padding.
- **unit** (Unit?) - Optional - The unit of measurement for the padding (e.g., px, em, %). Defaults to null.
```

--------------------------------

### String get id

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ExtensionContext/id.html

Retrieves the ID of the current element. If the node is not an HTML element or the ID is missing, it returns an empty string.

```APIDOC
## String get id

### Description
Returns the id of the element, or an empty string if it is not present or this Node is not an html Element.

### Signature
`String get id`
```

--------------------------------

### LineHeight Class Overview

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/LineHeight-class.html

Provides an overview of the LineHeight class, its constructors, properties, and methods.

```APIDOC
## LineHeight Class

### Description
Represents a line height value, which can be defined using various units like pixels, em, rem, percent, or as a unitless number.

### Constructors

- **LineHeight(double? size, {String units = ""})**
  - Creates a LineHeight object with a given size and units.

- **LineHeight.em(double em)**
  - Factory constructor to create a LineHeight object with 'em' units.

- **LineHeight.number(double num)**
  - Factory constructor to create a LineHeight object with a unitless number.

- **LineHeight.percent(double percent)**
  - Factory constructor to create a LineHeight object with '%' units.

- **LineHeight.rem(double rem)**
  - Factory constructor to create a LineHeight object with 'rem' units.

### Properties

- **size** (double?)
  - The numerical value of the line height.

- **units** (String)
  - The unit of the line height (e.g., "px", "em", "rem", "%").

### Methods

- **noSuchMethod(Invocation invocation) → dynamic**
  - Invoked when a nonexistent method or property is accessed. (Inherited)

- **toString() → String**
  - Returns a string representation of the object. (Inherited)

### Operators

- **operator ==(Object other) → bool**
  - Checks for equality with another object. (Inherited)

### Constants

- **normal** (const LineHeight)
  - A predefined constant for a normal line height.
```

--------------------------------

### Implement numberToFontSize function

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/numberToFontSize.html

Maps string inputs to FontSize constants, handling absolute values 1-7 and relative adjustments starting with + or -.

```dart
FontSize numberToFontSize(String num) {
  switch (num) {
    case "1":
      return FontSize.xxSmall;
    case "2":
      return FontSize.xSmall;
    case "3":
      return FontSize.small;
    case "4":
      return FontSize.medium;
    case "5":
      return FontSize.large;
    case "6":
      return FontSize.xLarge;
    case "7":
      return FontSize.xxLarge;
  }
  if (num.startsWith("+")) {
    final relativeNum = double.tryParse(num.substring(1)) ?? 0;
    return numberToFontSize((3 + relativeNum).toString());
  }
  if (num.startsWith("-")) {
    final relativeNum = double.tryParse(num.substring(1)) ?? 0;
    return numberToFontSize((3 - relativeNum).toString());
  }
  return FontSize.medium;
}
```

--------------------------------

### Size get collapsedSize

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Margins/collapsedSize.html

Returns the Size that this Margins object would occupy with an empty interior, calculated based on horizontal and vertical margins.

```APIDOC
## Size get collapsedSize

### Description
Returns the Size that this Margins object would occupy with an empty interior.

### Implementation
```dart
Size get collapsedSize => Size(horizontal, vertical);
```
```

--------------------------------

### WrapperElement Class Overview

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/WrapperElement-class.html

Provides a structured overview of the WrapperElement class, detailing its inheritance, constructors, properties, and methods.

```APIDOC
## WrapperElement Class

### Description
Represents a wrapper element in the HTML rendering process, inheriting from StyledElement.

### Inheritance
* Object
* StyledElement
* WrapperElement

### Constructors
#### WrapperElement
```dart
WrapperElement({required StyledElement child})
```
Creates a new WrapperElement with a specified child StyledElement.

### Properties
#### attributes
- **attributes** (Map<String, String>) - Read-only. Returns the attributes of the element.

#### children
- **children** (List<StyledElement>) - Getter/Setter. Returns or sets the children of the element.

#### counters
- **counters** (ListQueue<Counter>) - Read-only. Returns the counters associated with the element.

#### element
- **element** (Element?) - Read-only. Returns the underlying DOM element if available.

#### elementClasses
- **elementClasses** (List<String>) - Read-only. Returns the CSS classes applied to the element.

#### elementId
- **elementId** (String) - Read-only. Returns the ID of the element.

#### hashCode
- **hashCode** (int) - Read-only. Returns the hash code of the object.

#### name
- **name** (String) - Read-only. Returns the tag name of the element.

#### node
- **node** (Node) - Read-only. Returns the DOM node associated with the element.

#### runtimeType
- **runtimeType** (Type) - Read-only. Returns the runtime type of the object.

#### style
- **style** (Style) - Getter/Setter. Returns or sets the style of the element.

### Methods
#### matches
```dart
matches(Element element, String selector)
```
Checks if the given element matches the specified selector. Inherited from StyledElement.

#### matchesSelector
```dart
matchesSelector(String selector)
```
Checks if the element matches the specified selector. Inherited from StyledElement.

#### noSuchMethod
```dart
noSuchMethod(Invocation invocation)
```
Invoked when a nonexistent method or property is accessed. Inherited from Object.

#### toString
```dart
toString()
```
Returns a string representation of this object. Inherited from Object.

### Operators
#### operator ==
```dart
operator ==(Object other)
```
The equality operator. Inherited from Object.
```

--------------------------------

### int get hashCode

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Margin/hashCode.html

Returns the hash code for the Margin object, calculated based on its value and unit properties to ensure consistency with the equality operator.

```APIDOC
## int get hashCode

### Description
The hash code for this object. A hash code is a single integer which represents the state of the object that affects operator == comparisons.

### Implementation
```dart
@override
int get hashCode => Object.hash(value, unit);
```
```

--------------------------------

### ExtensionContext(required CurrentStep currentStep, required Node node, required HtmlParser parser, StyledElement? styledElement, BuildContext? buildContext, BuildChildrenCallback? buildChildrenCallback)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ExtensionContext/ExtensionContext.html

Constructs a new ExtensionContext object with the provided parsing and build information.

```APIDOC
## ExtensionContext Constructor

### Description
Constructs a new ExtensionContext object with the given information required for parsing and building HTML elements.

### Parameters
- **currentStep** (CurrentStep) - Required - The current step in the parsing process.
- **node** (Node) - Required - The HTML node being processed.
- **parser** (HtmlParser) - Required - The instance of the HtmlParser.
- **styledElement** (StyledElement?) - Optional - The styled element associated with this context.
- **buildContext** (BuildContext?) - Optional - The Flutter BuildContext for the widget tree.
- **buildChildrenCallback** (BuildChildrenCallback?) - Optional - A callback function to build child widgets.
```

--------------------------------

### int get hashCode

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlPadding/hashCode.html

Returns the hash code for the HtmlPadding object, calculated based on its value and unit properties to ensure consistency with the equality operator.

```APIDOC
## int get hashCode

### Description
Returns the hash code for this object. A hash code is a single integer which represents the state of the object that affects operator == comparisons.

### Implementation
```dart
@override
int get hashCode => Object.hash(value, unit);
```
```

--------------------------------

### beforeStyle(ExtensionContext context)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlExtension/beforeStyle.html

This method is invoked before styles are applied to the tree. By default, it performs no action, but it can be overridden to implement custom behavior.

```APIDOC
## void beforeStyle(ExtensionContext context)

### Description
Called before styles are applied to the tree. Default behavior is to do nothing.

### Parameters
- **context** (ExtensionContext) - Required - The context provided to the extension before style application.
```

--------------------------------

### String get elementName

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ExtensionContext/elementName.html

Returns the name of the HTML element, or an empty string if the node is a text content node, comment node, or any other node without a name.

```APIDOC
## String get elementName

### Description
Returns the name of the HTML element. If the node is a text content node, comment node, or any other node without a name, it returns an empty string.

### Return Type
String
```

--------------------------------

### Initialize ExtensionContext

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ExtensionContext/ExtensionContext.html

Constructs a new ExtensionContext object with the required parsing and build information.

```dart
ExtensionContext({
  required this.currentStep,
  required this.node,
  required this.parser,
  this.styledElement,
  this.buildContext,
  BuildChildrenCallback? buildChildrenCallback,
}) : _callbackToBuildChildren = buildChildrenCallback;
```

--------------------------------

### int get hashCode

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Margins/hashCode.html

Returns the hash code for the Margins object based on its internal properties (left, right, inlineStart, inlineEnd, top, bottom, blockStart, blockEnd).

```APIDOC
## int get hashCode

### Description
The hash code for this object. A hash code is a single integer which represents the state of the object that affects operator == comparisons.

### Implementation
```dart
@override
int get hashCode {
  return Object.hash(
      left, right, inlineStart, inlineEnd, top, bottom, blockStart, blockEnd);
}
```
```

--------------------------------

### StyledElement prepare(ExtensionContext context, List<StyledElement> children)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlExtension/prepare.html

Converts a parsed HTML node into a StyledElement by mapping the context and children.

```APIDOC
## prepare(ExtensionContext context, List<StyledElement> children)

### Description
Converts parsed HTML to a StyledElement. This method is used to transform the extension context and its children into a structured element that the library can render.

### Parameters
- **context** (ExtensionContext) - Required - The context containing the node, classes, ID, and element name.
- **children** (List<StyledElement>) - Required - A list of child StyledElements to be associated with the new element.

### Returns
- **StyledElement** - The resulting StyledElement object containing the node, style, classes, ID, children, and name.
```

--------------------------------

### Set<String> get supportedTags

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ImageExtension/supportedTags.html

Returns a set of strings representing the HTML tags supported by the extension. This property is intended to be overridden by extension creators to register custom tags.

```APIDOC
## Property: supportedTags

### Description
Returns a `Set<String>` containing the HTML tags that the extension supports. This property informs the `HtmlParser` which tags should be processed by this extension.

### Signature
`Set<String> get supportedTags`

### Usage
Extension creators should override this getter to return a set of tags that the extension is designed to handle. Note that the end user can still override this behavior by providing an explicit `tagList` on the `Html` widget.
```

--------------------------------

### ListStyleImage Class Overview

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ListStyleImage-class.html

Provides details on the ListStyleImage class, including its constructors, properties, and methods.

```APIDOC
## ListStyleImage Class

### Description
Represents an image used within a list item's style.

### Constructors
#### ListStyleImage(String uriText)
Creates a new ListStyleImage instance.

### Properties
- **hashCode** (int) - The hash code for this object.
- **runtimeType** (Type) - A representation of the runtime type of the object.
- **uriText** (String) - The text representation of the image URI.

### Methods
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed.
- **toString()** (String) - Returns a string representation of this object.

### Operators
- **operator ==(Object other)** (bool) - Checks for equality with another object.
```

--------------------------------

### String get innerHtml

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ExtensionContext/innerHtml.html

Retrieves the HTML content within the current element. If the node is an HTML element, it returns its innerHtml; otherwise, it returns the node's text content or an empty string.

```APIDOC
## String get innerHtml

### Description
Returns the HTML within this element. If the underlying node is not an HTML element, it returns the text content of the node.

### Returns
- **String** - The inner HTML string or the node's text content.
```

--------------------------------

### HtmlParser Constructor

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlParser-class.html

Initializes the HtmlParser widget with necessary configuration for rendering HTML data.

```APIDOC
## Constructor: HtmlParser

### Description
Creates a new instance of the HtmlParser widget to process and display HTML content.

### Parameters
- **key** (Key?) - Optional - Controls how one widget replaces another widget in the tree.
- **htmlData** (Element) - Required - The parsed HTML DOM element to render.
- **onLinkTap** (OnTap?) - Required - Callback triggered when a link is tapped.
- **onAnchorTap** (OnTap?) - Required - Callback triggered when an anchor is tapped.
- **onCssParseError** (OnCssParseError?) - Required - Callback for handling CSS parsing errors.
- **shrinkWrap** (bool) - Required - Whether the widget should shrink-wrap its content.
- **style** (Map<String, Style>) - Required - CSS styles to apply to the HTML elements.
- **extensions** (List<HtmlExtension>) - Required - Custom extensions for rendering specific tags.
- **doNotRenderTheseTags** (Set<String>?) - Required - Tags to exclude from rendering.
- **onlyRenderTheseTags** (Set<String>?) - Required - Tags to exclusively render.
- **root** (Html?) - Optional - The root HTML context.
```

--------------------------------

### numberToFontSize(String num)

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/numberToFontSize.html

Converts a string input representing a font size into a FontSize enum. It handles standard HTML font size values (1-7) and relative adjustments starting with '+' or '-'.

```APIDOC
## numberToFontSize(String num)

### Description
Converts a string input representing a font size into a FontSize enum. It maps standard HTML font size strings (1-7) to their corresponding FontSize values and calculates relative sizes if the input starts with '+' or '-'.

### Parameters
- **num** (String) - Required - The font size string to convert (e.g., "1"-"7", "+1", "-1").

### Returns
- **FontSize** - The corresponding FontSize enum value. Defaults to FontSize.medium if the input is unrecognized.
```

--------------------------------

### Static Methods and Operators

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/RenderCSSBox-class.html

Utility methods and equality operators for RenderObject.

```APIDOC
## operator ==

### Description
The equality operator.

## getIntrinsicDimension

### Description
Static method to calculate intrinsic dimensions.

### Parameters
#### Request Body
- **firstChild** (RenderBox) - Required - The first child to consider.
- **mainChildSizeGetter** (Function) - Required - Callback to get the size of a child.
- **marginSpaceNeeded** (double) - Required - The margin space required.
```

--------------------------------

### Html.fromDom Implementation

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Html/Html.fromDom.html

The internal implementation of the Html.fromDom constructor.

```dart
Html.fromDom({
  super.key,
  GlobalKey? anchorKey,
  required dom.Document? document,
  this.onLinkTap,
  this.onAnchorTap,
  this.extensions = const [],
  this.onCssParseError,
  this.shrinkWrap = false,
  this.doNotRenderTheseTags,
  this.onlyRenderTheseTags,
  this.style = const {},
})  : data = null,
      assert(document != null),
      documentElement = document!.documentElement,
      _anchorKey = anchorKey ?? GlobalKey();
```

--------------------------------

### OnImageTapExtension Constructor Implementation

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/OnImageTapExtension/OnImageTapExtension.html

The constructor requires an onImageTap callback to be provided.

```dart
OnImageTapExtension({required this.onImageTap});
```

--------------------------------

### buildFromExtension(ExtensionContext extensionContext, {Set<HtmlExtension> extensionsToIgnore})

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlParser/buildFromExtension.html

Builds the StyledElement into an InlineSpan using one of the built-ins or HtmlExtensions available. If no extension matches, it returns an empty TextSpan.

```APIDOC
## buildFromExtension

### Description
Builds the StyledElement into an InlineSpan using one of the built-ins or HtmlExtensions available. If none of the extensions matches, returns an empty TextSpan.

### Signature
`InlineSpan buildFromExtension(ExtensionContext extensionContext, {Set<HtmlExtension> extensionsToIgnore = const {}})`

### Parameters
- **extensionContext** (ExtensionContext) - The context containing the element to be built.
- **extensionsToIgnore** (Set<HtmlExtension>) - Optional. A set of extensions to skip during the matching process.
```

--------------------------------

### HtmlPaddings.all Implementation

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/HtmlPaddings/HtmlPaddings.all.html

The constructor initializes all sides of the padding with the same value and unit, leaving block and inline properties as null.

```dart
HtmlPaddings.all(double value, [Unit? unit])
    : left = HtmlPadding(value, unit),
      right = HtmlPadding(value, unit),
      inlineEnd = null,
      inlineStart = null,
      top = HtmlPadding(value, unit),
      bottom = HtmlPadding(value, unit),
      blockEnd = null,
      blockStart = null;
```

--------------------------------

### ImageTapExtensionElement Class Overview

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/ImageTapExtensionElement-class.html

This snippet provides a structured overview of the ImageTapExtensionElement class, detailing its inheritance, constructors, properties, and methods as found in the provided documentation.

```APIDOC
## ImageTapExtensionElement Class

### Description
Represents an extension element for handling image taps, likely within an HTML rendering context in Flutter.

### Inheritance
* Object
* StyledElement
* ImageTapExtensionElement

### Constructors
#### ImageTapExtensionElement
```dart
ImageTapExtensionElement({
  List<StyledElement> children = const [],
  List<String> elementClasses = const [],
  String elementId = "[[No ID]]",
  String name = "[[No name]]",
  required Node node,
  required Style style
})
```

### Properties
* **attributes** (Map<String, String>) - Read-only. Inherited.
* **children** (List<StyledElement>) - Getter/setter pair. Inherited.
* **counters** (ListQueue<Counter>) - Final. Inherited.
* **element** (Element?) - Read-only. Inherited.
* **elementClasses** (List<String>) - Final. Inherited.
* **elementId** (String) - Final. Inherited.
* **hashCode** (int) - The hash code for this object. Read-only. Inherited.
* **name** (String) - Final. Inherited.
* **node** (Node) - Final. Inherited.
* **runtimeType** (Type) - A representation of the runtime type of the object. Read-only. Inherited.
* **style** (Style) - Getter/setter pair. Inherited.

### Methods
* **matches**(Element element, String selector) → bool - Inherited.
* **matchesSelector**(String selector) → bool - Inherited.
* **noSuchMethod**(Invocation invocation) → dynamic - Invoked when a nonexistent method or property is accessed. Inherited.
* **toString**() → String - A string representation of this object. Inherited.

### Operators
* **operator ==**(Object other) → bool - The equality operator. Inherited.
```

--------------------------------

### Html.fromDom() Constructor

Source: https://pub.dev/documentation/flutter_html/latest/index.html

Constructor for rendering HTML content from a pre-parsed DOM Document.

```APIDOC
## Html.fromDom(document: Document, ...)

### Description
Constructs an Html widget using a pre-parsed DOM Document, useful for sanitized or modified HTML content.

### Parameters
- **document** (Document) - Required - The DOM document to be rendered.
- **onLinkTap** (Function) - Optional - Callback triggered when a link is tapped.
- **extensions** (List) - Optional - API for customizing rendering of specific HTML tags.
- **shrinkWrap** (bool) - Optional - Specifies if widgets should be shrink-wrapped.
- **onlyRenderTheseTags** (Set) - Optional - Exclusive set of tags to render.
- **doNotRenderTheseTags** (Set) - Optional - Set of tags to exclude from rendering.
- **style** (Map) - Optional - API for customizing styles of specific HTML tags.
```

--------------------------------

### Content Constructor Implementation

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Content/Content.html

The constructor initializes the replacementContent and sets default values for _normal and display properties.

```dart
const Content(this.replacementContent)
    : _normal = false,
      display = true;
```

--------------------------------

### Static Style Utilities

Source: https://pub.dev/documentation/flutter_html/latest/flutter_html/Style-class.html

Static methods for creating Style maps from external sources.

```APIDOC
## fromCss

### Description
Parses a CSS string into a Map of Style objects.

### Parameters
- **css** (String) - Required - The CSS string to parse.
- **onCssParseError** (OnCssParseError) - Optional - Callback for parsing errors.

## fromThemeData

### Description
Creates a Map of Style objects based on the provided ThemeData.

### Parameters
- **theme** (ThemeData) - Required - The theme data to convert.
```
Tokens:
Raw