Skip to content

Commit e491b6e

Browse files
committed
doc(README): document new renderersProps prop
1 parent 4a1cbec commit e491b6e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ export default class Demo extends Component {
6969
Prop | Description | Type | Required/Default
7070
------ | ------ | ------ | ------
7171
`renderers` | Your [custom renderers](#creating-custom-renderers) | `object` | Optional, some default ones are supplied (`<a>`, `<img>`...)
72+
`renderersProps` | Set of props accessible into your [custom renderers](#creating-custom-renderers) in `passProps` (4th argument) | `object` | Optional
7273
`html` | HTML string to parse and render | `string` | Required
7374
`uri` | *(experimental)* remote website to parse and render | `string` | Optional
7475
`decodeEntities` | Decode HTML entities of your content | `bool` | Optional, defaults to `true`
@@ -137,7 +138,7 @@ Your renderers functions receive several arguments that will be very useful to m
137138
* `htmlAttribs`: attributes attached to the node, parsed in a react-native way
138139
* `children` : array with the children of the node
139140
* `convertedCSSStyles` : conversion of the `style` attribute from CSS to react-native's stylesheet
140-
* `passProps` : various useful information : `groupInfo`, `parentTagName`, `parentIsText`...
141+
* `passProps` : various useful information : your `renderersProps`, `groupInfo`, `parentTagName`, `parentIsText`...
141142

142143
### Making your custom component block or inline
143144

0 commit comments

Comments
 (0)