gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update register preview template description (#1667)

Browse Source
This commit is contained in:
Andrew Garcia 2018-08-28 12:12:56 -07:00 committed by Shawn Erquhart
parent 07c44035e1
commit bb9fe88e78
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/content/docs/customization.md
View File

@ -54,13 +54,15 @@ body {
## `registerPreviewTemplate` ## `registerPreviewTemplate`
Registers a template for a collection. Registers a template for a folder collection or an individual file in a file collection.
`CMS.registerPreviewTemplate(collection, react_component);` `CMS.registerPreviewTemplate(name, react_component);`
**Params:** **Params:**
* collection: The name of the collection which this preview component will be used for. * name: The name of the collection (or file for file collections) which this preview component will be used for.
* Folder collections: Use the name of the collection
* File collections: Use the name of the file
* react_component: A React component that renders the collection data. Four props will be passed to your component during render: * react_component: A React component that renders the collection data. Four props will be passed to your component during render:
* entry: Immutable collection containing the entry data. * entry: Immutable collection containing the entry data.
* widgetFor: Returns the appropriate widget preview component for a given field. * widgetFor: Returns the appropriate widget preview component for a given field.