Skip to content

Commit a274abe

Browse files
authored
Minor changes to README
1 parent 9c0bbc9 commit a274abe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,14 +163,14 @@ If you would like to modify or sanitize the HTML before rendering it, then `Html
163163
| `omMathError` | A function that defines what the widget should do when a math fails to render. The function exposes the parsed Tex `String`, as well as the error and error with type from `flutter_math` as a `String`. |
164164
| `shrinkWrap` | A `bool` used while rendering different widgets to specify whether they should be shrink-wrapped or not, like `ContainerSpan` |
165165
| `onImageTap` | A function that defines what the widget should do when an image is tapped. The function exposes the `src` of the image as a `String` to use in your implementation. |
166-
| `tagsList` | A list of elements the `Html` widget should render. The list should contain the tags of the HTML elements you wish to whitelist. |
166+
| `tagsList` | A list of elements the `Html` widget should render. The list should contain the tags of the HTML elements you wish to include. |
167167
| `style` | A powerful API that allows you to customize the style that should be used when rendering a specific HTMl tag. |
168168
| `navigationDelegateForIframe` | Allows you to set the `NavigationDelegate` for the `WebView`s of all the iframes rendered by the `Html` widget. |
169169
| `customImageRender` | A powerful API that allows you to fully customize how images are loaded. |
170170

171171
### Getters:
172172

173-
Currently the only getter is `Html.tags`. This provides a list of all the tags the package renders. The main use case is to assist in blacklisting elements using `tagsList`. See an [example](#example-usage---tagslist---blacklisting) below.
173+
Currently the only getter is `Html.tags`. This provides a list of all the tags the package renders. The main use case is to assist in blacklisting elements using `tagsList`. See an [example](#example-usage---tagslist---excluding-tags) below.
174174

175175
### Data:
176176

@@ -385,7 +385,7 @@ Widget html = Html(
385385

386386
A list of elements the `Html` widget should render. The list should contain the tags of the HTML elements you wish to whitelist.
387387

388-
#### Example Usage - tagsList - Blacklisting:
388+
#### Example Usage - tagsList - Excluding Tags:
389389
You may have instances where you can choose between two different types of HTML tags to display the same content. In the example below, the `<video>` and `<iframe>` elements are going to display the same content.
390390

391391
The `blacklistedElements` parameter allows you to change which element is rendered. Iframes can be advantageous because they allow parallel loading - Flutter just has to wait for the webview to be initialized before rendering the page, possibly cutting down on load time. Video can be advantageous because it provides a 100% native experience with Flutter widgets, but it may take more time to render the page. You may know that Flutter webview is a little janky in its current state on Android, so using `blacklistedElements` and a simple condition, you can get the best of both worlds - choose the video widget to render on Android and the iframe webview to render on iOS.
@@ -403,7 +403,7 @@ Widget html = Html(
403403

404404
`Html.tags` provides easy access to a list of all the tags the package can render, and you can remove specific tags from this list to blacklist them.
405405

406-
#### Example Usage - tagsList - Whitelisting:
406+
#### Example Usage - tagsList - Allowing Tags:
407407
You may also have instances where you would only like the package to render a handful of html tags. You can do that like so:
408408
```dart
409409
Widget html = Html(

0 commit comments

Comments
 (0)