Skip to content

Commit 642494c

Browse files
author
Ben Taylor
authored
Updating Readme
1 parent 2f78f85 commit 642494c

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,27 @@ will add the following to your markup (will be minified):
9393

9494
## Reference
9595

96+
### PropTypes
97+
98+
#### Generic Component PropTypes
99+
100+
| PropType | Value | Description |
101+
| ------------- |:-------------:|:------|
102+
| type | String | The @type description in the json-ld body: ```"@type": "Product"``` |
103+
| jsonldtype | String | The value of the @type description in the json-ld body: ```"@type": "Product"``` |
104+
| schema | Object (json) | This should be the schema that you want for your structured data node: ```{name: "It is awesome", reviewBody: "This is great!"}```|
105+
106+
#### JSONLD node propTypes
107+
| PropType | Value | Description |
108+
| ------------- |:-------------:|:------|
109+
| dangerouslyExposeHtml | Boolean | Set this to render the json within script tag using ```dangerouslySetInnerHTML``` |
110+
111+
#### Schema node PropTypes
112+
| PropType | Value | Description |
113+
| ------------- |:-------------:|:------|
114+
| parentID | String | This sets the id of the schema that becomes a reference that the children point to ```"@id": "product-x"``` |
115+
| id | String | similar to parentID but uses the ID on itself |
116+
96117
### Preset Components
97118
There are several preset schema components that can be used
98119

0 commit comments

Comments
 (0)