From 811b1221b4a9d607ad5e93b26ee471c1c7b73e07 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 12:59:56 -0700 Subject: [PATCH 01/14] feat: Add method examples to the reference template --- src/hooks/useComponentDoc.js | 1 + src/templates/ReferenceTemplate.js | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/src/hooks/useComponentDoc.js b/src/hooks/useComponentDoc.js index abaed6a74..36da0b7d5 100644 --- a/src/hooks/useComponentDoc.js +++ b/src/hooks/useComponentDoc.js @@ -209,6 +209,7 @@ const useComponentDoc = (componentName) => { description: methodDocs?.text, returnValue: methodDocs?.tags.return?.[0] ?? { type: 'undefined' }, params: methodDocs?.tags.param, + examples: methodDocs?.tags.examples ?? [], }; }), }; diff --git a/src/templates/ReferenceTemplate.js b/src/templates/ReferenceTemplate.js index 1c29b70a8..081bb1503 100644 --- a/src/templates/ReferenceTemplate.js +++ b/src/templates/ReferenceTemplate.js @@ -94,6 +94,13 @@ const ReferenceTemplate = ({ data }) => { params={method.params} returnValue={method.returnValue} /> + {method.examples.map((example, i) => ( + + ))} ))} From d4453d6caa9d9adfb4e3d8103fba16170604be88 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 13:08:51 -0700 Subject: [PATCH 02/14] fix: Handle spread args on function definitions --- src/components/FunctionDefinition.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/components/FunctionDefinition.js b/src/components/FunctionDefinition.js index cee1ea8ab..82ccdd67e 100644 --- a/src/components/FunctionDefinition.js +++ b/src/components/FunctionDefinition.js @@ -21,7 +21,9 @@ const FunctionDefinition = ({ params, returnValue }) => { {params.map((param, i) => (
- {param.name}: + + {param.type.startsWith('...') ? `...${param.name}` : param.name}:{' '} + {param.type} Date: Fri, 5 Jun 2020 13:09:00 -0700 Subject: [PATCH 03/14] feat: Add logger api --- src/data/sidenav.json | 4 ++++ src/markdown-pages/components/logger.mdx | 7 +++++++ 2 files changed, 11 insertions(+) create mode 100644 src/markdown-pages/components/logger.mdx diff --git a/src/data/sidenav.json b/src/data/sidenav.json index d5b785283..1b0ca6902 100644 --- a/src/data/sidenav.json +++ b/src/data/sidenav.json @@ -348,6 +348,10 @@ { "displayName": "PlatformStateContext", "url": "/components/platform-state-context" + }, + { + "displayName": "logger", + "url": "/apis/logger" } ] } diff --git a/src/markdown-pages/components/logger.mdx b/src/markdown-pages/components/logger.mdx new file mode 100644 index 000000000..ff8d7ef7f --- /dev/null +++ b/src/markdown-pages/components/logger.mdx @@ -0,0 +1,7 @@ +--- +path: '/apis/logger' +title: 'PlatformStateContext' +description: 'A logger component!' +component: 'logger' +template: 'ReferenceTemplate' +--- From a8bbf091485a1dd836f475043adb9b48f832af13 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 13:18:21 -0700 Subject: [PATCH 04/14] feat: Add nerdlet API doc --- src/data/sidenav.json | 4 ++++ src/markdown-pages/{components => apis}/logger.mdx | 0 src/markdown-pages/apis/nerdlet.mdx | 7 +++++++ 3 files changed, 11 insertions(+) rename src/markdown-pages/{components => apis}/logger.mdx (100%) create mode 100644 src/markdown-pages/apis/nerdlet.mdx diff --git a/src/data/sidenav.json b/src/data/sidenav.json index 1b0ca6902..44556fdc5 100644 --- a/src/data/sidenav.json +++ b/src/data/sidenav.json @@ -352,6 +352,10 @@ { "displayName": "logger", "url": "/apis/logger" + }, + { + "displayName": "nerdlet", + "url": "/apis/nerdlet" } ] } diff --git a/src/markdown-pages/components/logger.mdx b/src/markdown-pages/apis/logger.mdx similarity index 100% rename from src/markdown-pages/components/logger.mdx rename to src/markdown-pages/apis/logger.mdx diff --git a/src/markdown-pages/apis/nerdlet.mdx b/src/markdown-pages/apis/nerdlet.mdx new file mode 100644 index 000000000..e8fbe9cdf --- /dev/null +++ b/src/markdown-pages/apis/nerdlet.mdx @@ -0,0 +1,7 @@ +--- +path: '/apis/nerdlet' +title: 'Nerdlet' +description: 'The nerdlet API' +component: 'nerdlet' +template: 'ReferenceTemplate' +--- From a2ff76d90c6b1d88ff3b84c9e4011a43e101ae3c Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 17:15:31 -0700 Subject: [PATCH 05/14] feat: Separate component/api doc templates. Use API template for logger and nerdlet apis --- src/markdown-pages/apis/logger.mdx | 2 +- src/markdown-pages/apis/nerdlet.mdx | 2 +- .../components/account-picker.mdx | 2 +- .../components/account-storage-mutation.mdx | 2 +- .../components/account-storage-query.mdx | 2 +- .../components/accounts-query.mdx | 2 +- src/markdown-pages/components/area-chart.mdx | 2 +- src/markdown-pages/components/auto-sizer.mdx | 2 +- src/markdown-pages/components/bar-chart.mdx | 2 +- .../components/billboard-chart.mdx | 2 +- src/markdown-pages/components/block-text.mdx | 2 +- src/markdown-pages/components/button.mdx | 2 +- src/markdown-pages/components/card-body.mdx | 2 +- src/markdown-pages/components/card-header.mdx | 2 +- src/markdown-pages/components/card.mdx | 2 +- src/markdown-pages/components/chart-group.mdx | 2 +- src/markdown-pages/components/checkbox.mdx | 2 +- .../components/dropdown-item.mdx | 2 +- src/markdown-pages/components/dropdown.mdx | 2 +- .../entities-by-domain-type-query.mdx | 2 +- .../components/entities-by-guids-query.mdx | 2 +- .../components/entities-by-name-query.mdx | 2 +- .../components/entity-by-guid-query.mdx | 2 +- .../components/entity-count-query.mdx | 2 +- .../components/entity-search-query.mdx | 2 +- .../components/entity-storage-mutation.mdx | 2 +- .../components/entity-storage-query.mdx | 2 +- .../entity-title-table-row-cell.mdx | 2 +- .../components/funnel-chart.mdx | 2 +- src/markdown-pages/components/grid-item.mdx | 2 +- src/markdown-pages/components/grid.mdx | 2 +- .../components/heading-text.mdx | 2 +- .../components/heatmap-component.mdx | 2 +- .../components/histogram-chart.mdx | 2 +- src/markdown-pages/components/icon.mdx | 2 +- src/markdown-pages/components/json-chart.mdx | 2 +- src/markdown-pages/components/line-chart.mdx | 2 +- src/markdown-pages/components/link.mdx | 2 +- src/markdown-pages/components/list-item.mdx | 2 +- src/markdown-pages/components/list.mdx | 2 +- .../components/metric-table-row-cell.mdx | 2 +- src/markdown-pages/components/modal.mdx | 2 +- .../components/nerd-graph-mutation.mdx | 2 +- .../components/nerd-graph-query.mdx | 2 +- .../components/nerdlet-state-context.mdx | 2 +- src/markdown-pages/components/nrql-query.mdx | 2 +- src/markdown-pages/components/pie-chart.mdx | 2 +- .../components/platform-state-context.mdx | 2 +- src/markdown-pages/components/radio-group.mdx | 2 +- src/markdown-pages/components/radio.mdx | 2 +- .../components/scatter-chart.mdx | 2 +- src/markdown-pages/components/select-item.mdx | 2 +- src/markdown-pages/components/select.mdx | 2 +- src/markdown-pages/components/spacing.mdx | 2 +- .../components/sparkline-chart.mdx | 2 +- .../components/sparkline-table-row-cell.mdx | 2 +- src/markdown-pages/components/spinner.mdx | 2 +- src/markdown-pages/components/stack-item.mdx | 2 +- src/markdown-pages/components/stack.mdx | 2 +- .../components/stacked-bar-chart.mdx | 2 +- src/markdown-pages/components/table-chart.mdx | 2 +- .../components/table-header-cell.mdx | 2 +- .../components/table-header.mdx | 2 +- .../components/table-row-cell.mdx | 2 +- src/markdown-pages/components/table-row.mdx | 2 +- src/markdown-pages/components/table.mdx | 2 +- src/markdown-pages/components/tabs-item.mdx | 2 +- src/markdown-pages/components/tabs.mdx | 2 +- src/markdown-pages/components/text-field.mdx | 2 +- src/markdown-pages/components/toast.mdx | 2 +- src/markdown-pages/components/tooltip.mdx | 2 +- src/markdown-pages/components/user-query.mdx | 2 +- .../components/user-storage-mutation.mdx | 2 +- .../components/user-storage-query.mdx | 2 +- .../components/user-table-row-cell.mdx | 2 +- ...ReferenceTemplate.js => ApiDocTemplate.js} | 8 +- ...module.scss => ApiDocTemplate.module.scss} | 0 src/templates/ComponentDocTemplate.js | 132 ++++++++++++++++++ .../ComponentDocTemplate.module.scss | 67 +++++++++ 79 files changed, 278 insertions(+), 79 deletions(-) rename src/templates/{ReferenceTemplate.js => ApiDocTemplate.js} (95%) rename src/templates/{ReferenceTemplate.module.scss => ApiDocTemplate.module.scss} (100%) create mode 100644 src/templates/ComponentDocTemplate.js create mode 100644 src/templates/ComponentDocTemplate.module.scss diff --git a/src/markdown-pages/apis/logger.mdx b/src/markdown-pages/apis/logger.mdx index ff8d7ef7f..def6b5c6e 100644 --- a/src/markdown-pages/apis/logger.mdx +++ b/src/markdown-pages/apis/logger.mdx @@ -3,5 +3,5 @@ path: '/apis/logger' title: 'PlatformStateContext' description: 'A logger component!' component: 'logger' -template: 'ReferenceTemplate' +template: 'ApiDocTemplate' --- diff --git a/src/markdown-pages/apis/nerdlet.mdx b/src/markdown-pages/apis/nerdlet.mdx index e8fbe9cdf..a87056f73 100644 --- a/src/markdown-pages/apis/nerdlet.mdx +++ b/src/markdown-pages/apis/nerdlet.mdx @@ -3,5 +3,5 @@ path: '/apis/nerdlet' title: 'Nerdlet' description: 'The nerdlet API' component: 'nerdlet' -template: 'ReferenceTemplate' +template: 'ApiDocTemplate' --- diff --git a/src/markdown-pages/components/account-picker.mdx b/src/markdown-pages/components/account-picker.mdx index eca4805ff..a14cd11e8 100644 --- a/src/markdown-pages/components/account-picker.mdx +++ b/src/markdown-pages/components/account-picker.mdx @@ -3,5 +3,5 @@ path: '/components/account-picker' title: 'AccountPicker' description: 'An AccountPicker component!' component: 'AccountPicker' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/account-storage-mutation.mdx b/src/markdown-pages/components/account-storage-mutation.mdx index b6958e747..7e800646b 100644 --- a/src/markdown-pages/components/account-storage-mutation.mdx +++ b/src/markdown-pages/components/account-storage-mutation.mdx @@ -3,5 +3,5 @@ path: '/components/account-storage-mutation' title: 'AccountStorageMutation' description: 'An AccountStorageMutation component!' component: 'AccountStorageMutation' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/account-storage-query.mdx b/src/markdown-pages/components/account-storage-query.mdx index b918ba0b7..a10482beb 100644 --- a/src/markdown-pages/components/account-storage-query.mdx +++ b/src/markdown-pages/components/account-storage-query.mdx @@ -3,5 +3,5 @@ path: '/components/account-storage-query' title: 'AccountStorageQuery' description: 'An AccountStorageQuery component!' component: 'AccountStorageQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/accounts-query.mdx b/src/markdown-pages/components/accounts-query.mdx index 7a0ac5744..c5e7a7b80 100644 --- a/src/markdown-pages/components/accounts-query.mdx +++ b/src/markdown-pages/components/accounts-query.mdx @@ -3,5 +3,5 @@ path: '/components/accounts-query' title: 'AccountsQuery' description: 'A AccountsQuery component!' component: 'AccountsQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/area-chart.mdx b/src/markdown-pages/components/area-chart.mdx index 7acd51425..86bb65a6d 100644 --- a/src/markdown-pages/components/area-chart.mdx +++ b/src/markdown-pages/components/area-chart.mdx @@ -3,5 +3,5 @@ path: '/components/area-chart' title: 'AreaChart' description: 'An AreaChart component!' component: 'AreaChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/auto-sizer.mdx b/src/markdown-pages/components/auto-sizer.mdx index e4152ddf5..151fe4dde 100644 --- a/src/markdown-pages/components/auto-sizer.mdx +++ b/src/markdown-pages/components/auto-sizer.mdx @@ -3,5 +3,5 @@ path: '/components/auto-sizer' title: 'AutoSizer' description: 'An AutoSizer component!' component: 'AutoSizer' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/bar-chart.mdx b/src/markdown-pages/components/bar-chart.mdx index ae89681e9..591d4559d 100644 --- a/src/markdown-pages/components/bar-chart.mdx +++ b/src/markdown-pages/components/bar-chart.mdx @@ -3,5 +3,5 @@ path: '/components/bar-chart' title: 'BarChart' description: 'A BarChart component!' component: 'BarChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/billboard-chart.mdx b/src/markdown-pages/components/billboard-chart.mdx index 63bccbc13..fc3b13d4a 100644 --- a/src/markdown-pages/components/billboard-chart.mdx +++ b/src/markdown-pages/components/billboard-chart.mdx @@ -3,5 +3,5 @@ path: '/components/billboard-chart' title: 'BillboardChart' description: 'A BillboardChart component!' component: 'BillboardChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/block-text.mdx b/src/markdown-pages/components/block-text.mdx index 4f37cb5d3..3edd3e7c9 100644 --- a/src/markdown-pages/components/block-text.mdx +++ b/src/markdown-pages/components/block-text.mdx @@ -3,5 +3,5 @@ path: '/components/block-text' title: 'BlockText' description: 'A BlockText component!' component: 'BlockText' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/button.mdx b/src/markdown-pages/components/button.mdx index 109af88ef..06d78d5c8 100644 --- a/src/markdown-pages/components/button.mdx +++ b/src/markdown-pages/components/button.mdx @@ -3,5 +3,5 @@ path: '/components/button' title: 'Button' description: 'A button component!' component: 'Button' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- \ No newline at end of file diff --git a/src/markdown-pages/components/card-body.mdx b/src/markdown-pages/components/card-body.mdx index ee606a264..f8bb7d985 100644 --- a/src/markdown-pages/components/card-body.mdx +++ b/src/markdown-pages/components/card-body.mdx @@ -3,5 +3,5 @@ path: '/components/card-body' title: 'CardBody' description: 'A CardBody component!' component: 'CardBody' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/card-header.mdx b/src/markdown-pages/components/card-header.mdx index a961c2ac6..b33c21b80 100644 --- a/src/markdown-pages/components/card-header.mdx +++ b/src/markdown-pages/components/card-header.mdx @@ -3,5 +3,5 @@ path: '/components/card-header' title: 'CardHeader' description: 'A CardHeader component!' component: 'CardHeader' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/card.mdx b/src/markdown-pages/components/card.mdx index d616164cd..b50862f46 100644 --- a/src/markdown-pages/components/card.mdx +++ b/src/markdown-pages/components/card.mdx @@ -3,5 +3,5 @@ path: '/components/card' title: 'Card' description: 'A Card component!' component: 'Card' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/chart-group.mdx b/src/markdown-pages/components/chart-group.mdx index f8edd75b5..0b85dd0d6 100644 --- a/src/markdown-pages/components/chart-group.mdx +++ b/src/markdown-pages/components/chart-group.mdx @@ -3,5 +3,5 @@ path: '/components/chart-group' title: 'ChartGroup' description: 'A ChartGroup component!' component: 'ChartGroup' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/checkbox.mdx b/src/markdown-pages/components/checkbox.mdx index 5f6bb505c..f2899f228 100644 --- a/src/markdown-pages/components/checkbox.mdx +++ b/src/markdown-pages/components/checkbox.mdx @@ -3,5 +3,5 @@ path: '/components/checkbox' title: 'Checkbox' description: 'A Checkbox component!' component: 'Checkbox' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/dropdown-item.mdx b/src/markdown-pages/components/dropdown-item.mdx index 7a8a88040..93d94d98b 100644 --- a/src/markdown-pages/components/dropdown-item.mdx +++ b/src/markdown-pages/components/dropdown-item.mdx @@ -3,5 +3,5 @@ path: '/components/dropdown-item' title: 'DropdownItem' description: 'A DropdownItem component!' component: 'DropdownItem' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/dropdown.mdx b/src/markdown-pages/components/dropdown.mdx index d94729531..6318fa6b1 100644 --- a/src/markdown-pages/components/dropdown.mdx +++ b/src/markdown-pages/components/dropdown.mdx @@ -3,5 +3,5 @@ path: '/components/dropdown' title: 'Dropdown' description: 'A Dropdown component!' component: 'Dropdown' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entities-by-domain-type-query.mdx b/src/markdown-pages/components/entities-by-domain-type-query.mdx index 60ed9990e..1f9f3c7c2 100644 --- a/src/markdown-pages/components/entities-by-domain-type-query.mdx +++ b/src/markdown-pages/components/entities-by-domain-type-query.mdx @@ -3,5 +3,5 @@ path: '/components/entities-by-domain-type-query' title: 'EntitiesByDomainTypeQuery' description: 'An EntitiesByDomainTypeQuery component!' component: 'EntitiesByDomainTypeQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entities-by-guids-query.mdx b/src/markdown-pages/components/entities-by-guids-query.mdx index a51baedf2..a906b7e36 100644 --- a/src/markdown-pages/components/entities-by-guids-query.mdx +++ b/src/markdown-pages/components/entities-by-guids-query.mdx @@ -3,5 +3,5 @@ path: '/components/entities-by-guids-query' title: 'EntitiesByGuidsQuery' description: 'An EntitiesByGuidsQuery component!' component: 'EntitiesByGuidsQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entities-by-name-query.mdx b/src/markdown-pages/components/entities-by-name-query.mdx index 425317b85..2293fd1d4 100644 --- a/src/markdown-pages/components/entities-by-name-query.mdx +++ b/src/markdown-pages/components/entities-by-name-query.mdx @@ -3,5 +3,5 @@ path: '/components/entities-by-name-query' title: 'EntitiesByNameQuery' description: 'An EntitiesByNameQuery component!' component: 'EntitiesByNameQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entity-by-guid-query.mdx b/src/markdown-pages/components/entity-by-guid-query.mdx index 74df7e824..c49830693 100644 --- a/src/markdown-pages/components/entity-by-guid-query.mdx +++ b/src/markdown-pages/components/entity-by-guid-query.mdx @@ -3,5 +3,5 @@ path: '/components/entity-by-guid-query' title: 'EntityByGuidQuery' description: 'An EntityByGuidQuery component!' component: 'EntityByGuidQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entity-count-query.mdx b/src/markdown-pages/components/entity-count-query.mdx index efc01003b..db6e01b2c 100644 --- a/src/markdown-pages/components/entity-count-query.mdx +++ b/src/markdown-pages/components/entity-count-query.mdx @@ -3,5 +3,5 @@ path: '/components/entity-count-query' title: 'EntityCountQuery' description: 'An EntityCountQuery component!' component: 'EntityCountQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entity-search-query.mdx b/src/markdown-pages/components/entity-search-query.mdx index 4c37d9515..59d96a4c6 100644 --- a/src/markdown-pages/components/entity-search-query.mdx +++ b/src/markdown-pages/components/entity-search-query.mdx @@ -3,5 +3,5 @@ path: '/components/entity-search-query' title: 'EntitySearchQuery' description: 'An EntitySearchQuery component!' component: 'EntitySearchQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entity-storage-mutation.mdx b/src/markdown-pages/components/entity-storage-mutation.mdx index 0800875d8..15b240378 100644 --- a/src/markdown-pages/components/entity-storage-mutation.mdx +++ b/src/markdown-pages/components/entity-storage-mutation.mdx @@ -3,5 +3,5 @@ path: '/components/entity-storage-mutation' title: 'EntityStorageMutation' description: 'An EntityStorageMutation component!' component: 'EntityStorageMutation' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entity-storage-query.mdx b/src/markdown-pages/components/entity-storage-query.mdx index 995627b97..36b93829a 100644 --- a/src/markdown-pages/components/entity-storage-query.mdx +++ b/src/markdown-pages/components/entity-storage-query.mdx @@ -3,5 +3,5 @@ path: '/components/entity-storage-query' title: 'EntityStorageQuery' description: 'An EntityStorageQuery component!' component: 'EntityStorageQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/entity-title-table-row-cell.mdx b/src/markdown-pages/components/entity-title-table-row-cell.mdx index f61cb6bec..bf573701b 100644 --- a/src/markdown-pages/components/entity-title-table-row-cell.mdx +++ b/src/markdown-pages/components/entity-title-table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/entity-title-table-row-cell' title: 'EntityTitleTableRowCell' description: 'An EntityTitleTableRowCell component!' component: 'EntityTitleTableRowCell' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/funnel-chart.mdx b/src/markdown-pages/components/funnel-chart.mdx index 25e2c7469..dbe80d75c 100644 --- a/src/markdown-pages/components/funnel-chart.mdx +++ b/src/markdown-pages/components/funnel-chart.mdx @@ -3,5 +3,5 @@ path: '/components/funnel-chart' title: 'FunnelChart' description: 'A FunnelChart component!' component: 'FunnelChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/grid-item.mdx b/src/markdown-pages/components/grid-item.mdx index 868a8ef11..88641ca9f 100644 --- a/src/markdown-pages/components/grid-item.mdx +++ b/src/markdown-pages/components/grid-item.mdx @@ -3,5 +3,5 @@ path: '/components/grid-item' title: 'GridItem' description: 'A GridItem component!' component: 'GridItem' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/grid.mdx b/src/markdown-pages/components/grid.mdx index 726d37925..f19509e9a 100644 --- a/src/markdown-pages/components/grid.mdx +++ b/src/markdown-pages/components/grid.mdx @@ -3,5 +3,5 @@ path: '/components/grid' title: 'Grid' description: 'A Grid component!' component: 'Grid' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/heading-text.mdx b/src/markdown-pages/components/heading-text.mdx index 1ae935355..656958969 100644 --- a/src/markdown-pages/components/heading-text.mdx +++ b/src/markdown-pages/components/heading-text.mdx @@ -3,6 +3,6 @@ path: '/components/heading-text' title: 'BlockText' description: 'A HeadingText component!' component: 'HeadingText' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/heatmap-component.mdx b/src/markdown-pages/components/heatmap-component.mdx index 1e4af2884..3d82da12c 100644 --- a/src/markdown-pages/components/heatmap-component.mdx +++ b/src/markdown-pages/components/heatmap-component.mdx @@ -3,5 +3,5 @@ path: '/components/heatmap-chart' title: 'HeatmapChart' description: 'A HeatmapChart component!' component: 'HeatmapChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/histogram-chart.mdx b/src/markdown-pages/components/histogram-chart.mdx index 38a64d878..dcf08050e 100644 --- a/src/markdown-pages/components/histogram-chart.mdx +++ b/src/markdown-pages/components/histogram-chart.mdx @@ -3,5 +3,5 @@ path: '/components/histogram-chart' title: 'HistogramChart' description: 'A HistogramChart component!' component: 'HistogramChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/icon.mdx b/src/markdown-pages/components/icon.mdx index e20658a14..f25451ac5 100644 --- a/src/markdown-pages/components/icon.mdx +++ b/src/markdown-pages/components/icon.mdx @@ -3,5 +3,5 @@ path: '/components/icon' title: 'Icon' description: 'An Icon component!' component: 'Icon' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/json-chart.mdx b/src/markdown-pages/components/json-chart.mdx index fb111ac24..9186803fa 100644 --- a/src/markdown-pages/components/json-chart.mdx +++ b/src/markdown-pages/components/json-chart.mdx @@ -3,5 +3,5 @@ path: '/components/json-chart' title: 'JsonChart' description: 'A JsonChart component!' component: 'JsonChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/line-chart.mdx b/src/markdown-pages/components/line-chart.mdx index de5d21eb0..bbce3fecb 100644 --- a/src/markdown-pages/components/line-chart.mdx +++ b/src/markdown-pages/components/line-chart.mdx @@ -3,5 +3,5 @@ path: '/components/line-chart' title: 'LineChart' description: 'A LineChart component!' component: 'LineChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/link.mdx b/src/markdown-pages/components/link.mdx index 99774f778..7e16c254c 100644 --- a/src/markdown-pages/components/link.mdx +++ b/src/markdown-pages/components/link.mdx @@ -3,5 +3,5 @@ path: '/components/link' title: 'Link' description: 'A Link component!' component: 'Link' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/list-item.mdx b/src/markdown-pages/components/list-item.mdx index d5d4bff6e..fbd6ec4ab 100644 --- a/src/markdown-pages/components/list-item.mdx +++ b/src/markdown-pages/components/list-item.mdx @@ -3,5 +3,5 @@ path: '/components/list-item' title: 'ListItem' description: 'A ListItem component!' component: 'ListItem' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/list.mdx b/src/markdown-pages/components/list.mdx index 2189df468..1bdc1c7d2 100644 --- a/src/markdown-pages/components/list.mdx +++ b/src/markdown-pages/components/list.mdx @@ -3,5 +3,5 @@ path: '/components/list' title: 'List' description: 'A List component!' component: 'List' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/metric-table-row-cell.mdx b/src/markdown-pages/components/metric-table-row-cell.mdx index 98004f9fd..68dfda43b 100644 --- a/src/markdown-pages/components/metric-table-row-cell.mdx +++ b/src/markdown-pages/components/metric-table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/metric-table-row-cell' title: 'MetricTableRowCell' description: 'A MetricTableRowCell component!' component: 'MetricTableRowCell' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/modal.mdx b/src/markdown-pages/components/modal.mdx index 3e09ef8b9..ce4bca859 100644 --- a/src/markdown-pages/components/modal.mdx +++ b/src/markdown-pages/components/modal.mdx @@ -3,5 +3,5 @@ path: '/components/modal' title: 'Modal' description: 'A Modal component!' component: 'Modal' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/nerd-graph-mutation.mdx b/src/markdown-pages/components/nerd-graph-mutation.mdx index 5960bf7c3..d24b29fa5 100644 --- a/src/markdown-pages/components/nerd-graph-mutation.mdx +++ b/src/markdown-pages/components/nerd-graph-mutation.mdx @@ -3,5 +3,5 @@ path: '/components/nerd-graph-mutation' title: 'NerdGraphMutation' description: 'An NerdGraphMutation component!' component: 'NerdGraphMutation' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/nerd-graph-query.mdx b/src/markdown-pages/components/nerd-graph-query.mdx index ba8a1f5c5..24896b91c 100644 --- a/src/markdown-pages/components/nerd-graph-query.mdx +++ b/src/markdown-pages/components/nerd-graph-query.mdx @@ -3,5 +3,5 @@ path: '/components/nerd-graph-query' title: 'NerdGraphQuery' description: 'A NerdGraphQuery component!' component: 'NerdGraphQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/nerdlet-state-context.mdx b/src/markdown-pages/components/nerdlet-state-context.mdx index 3234bebee..921c256e5 100644 --- a/src/markdown-pages/components/nerdlet-state-context.mdx +++ b/src/markdown-pages/components/nerdlet-state-context.mdx @@ -3,5 +3,5 @@ path: '/components/nerdlet-state-context' title: 'NerdletStateContext' description: 'A NerdletStateContext component!' component: 'NerdletStateContext' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/nrql-query.mdx b/src/markdown-pages/components/nrql-query.mdx index 81659bc54..8b35eed3b 100644 --- a/src/markdown-pages/components/nrql-query.mdx +++ b/src/markdown-pages/components/nrql-query.mdx @@ -3,5 +3,5 @@ path: '/components/nrql-query' title: 'NrqlQuery' description: 'A NrqlQuery component!' component: 'NrqlQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/pie-chart.mdx b/src/markdown-pages/components/pie-chart.mdx index 8621fcbdb..fcb5833c4 100644 --- a/src/markdown-pages/components/pie-chart.mdx +++ b/src/markdown-pages/components/pie-chart.mdx @@ -3,5 +3,5 @@ path: '/components/pie-chart' title: 'PieChart' description: 'A PieChart component!' component: 'PieChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/platform-state-context.mdx b/src/markdown-pages/components/platform-state-context.mdx index 056b722c2..2a7b842a1 100644 --- a/src/markdown-pages/components/platform-state-context.mdx +++ b/src/markdown-pages/components/platform-state-context.mdx @@ -3,5 +3,5 @@ path: '/components/platform-state-context' title: 'PlatformStateContext' description: 'A PlatformStateContext component!' component: 'PlatformStateContext' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/radio-group.mdx b/src/markdown-pages/components/radio-group.mdx index 796f37d8a..42031d34d 100644 --- a/src/markdown-pages/components/radio-group.mdx +++ b/src/markdown-pages/components/radio-group.mdx @@ -3,5 +3,5 @@ path: '/components/radio-group' title: 'RadioGroup' description: 'A RadioGroup component!' component: 'RadioGroup' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/radio.mdx b/src/markdown-pages/components/radio.mdx index d20148765..0db2d51fa 100644 --- a/src/markdown-pages/components/radio.mdx +++ b/src/markdown-pages/components/radio.mdx @@ -3,5 +3,5 @@ path: '/components/radio' title: 'Radio' description: 'A Radio component!' component: 'Radio' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/scatter-chart.mdx b/src/markdown-pages/components/scatter-chart.mdx index a8a350eec..7650fecc1 100644 --- a/src/markdown-pages/components/scatter-chart.mdx +++ b/src/markdown-pages/components/scatter-chart.mdx @@ -3,5 +3,5 @@ path: '/components/scatter-chart' title: 'ScatterChart' description: 'A ScatterChart component!' component: 'ScatterChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/select-item.mdx b/src/markdown-pages/components/select-item.mdx index e5c4e6601..6666be79e 100644 --- a/src/markdown-pages/components/select-item.mdx +++ b/src/markdown-pages/components/select-item.mdx @@ -3,5 +3,5 @@ path: '/components/select-item' title: 'SelectItem' description: 'A SelectItem component!' component: 'SelectItem' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/select.mdx b/src/markdown-pages/components/select.mdx index c4349bf79..78a040c45 100644 --- a/src/markdown-pages/components/select.mdx +++ b/src/markdown-pages/components/select.mdx @@ -3,5 +3,5 @@ path: '/components/select' title: 'Select' description: 'A Select component!' component: 'Select' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/spacing.mdx b/src/markdown-pages/components/spacing.mdx index 2de7b9183..8a6a94e6c 100644 --- a/src/markdown-pages/components/spacing.mdx +++ b/src/markdown-pages/components/spacing.mdx @@ -3,5 +3,5 @@ path: '/components/spacing' title: 'Spacing' description: 'A Spacing component!' component: 'Spacing' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/sparkline-chart.mdx b/src/markdown-pages/components/sparkline-chart.mdx index e8ddf425c..7ef325910 100644 --- a/src/markdown-pages/components/sparkline-chart.mdx +++ b/src/markdown-pages/components/sparkline-chart.mdx @@ -3,5 +3,5 @@ path: '/components/sparkline-chart' title: 'SparklineChart' description: 'A SparklineChart component!' component: 'SparklineChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/sparkline-table-row-cell.mdx b/src/markdown-pages/components/sparkline-table-row-cell.mdx index d054e97b8..0b60674ce 100644 --- a/src/markdown-pages/components/sparkline-table-row-cell.mdx +++ b/src/markdown-pages/components/sparkline-table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/sparkline-table-row-cell' title: 'SparklineTableRowCell' description: 'A SparklineTableRowCell component!' component: 'SparklineTableRowCell' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/spinner.mdx b/src/markdown-pages/components/spinner.mdx index 88c3877f0..2235eebd9 100644 --- a/src/markdown-pages/components/spinner.mdx +++ b/src/markdown-pages/components/spinner.mdx @@ -3,5 +3,5 @@ path: '/components/spinner' title: 'Spinner' description: 'A Spinner component!' component: 'Spinner' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/stack-item.mdx b/src/markdown-pages/components/stack-item.mdx index 3dfd6f885..f5e1358e4 100644 --- a/src/markdown-pages/components/stack-item.mdx +++ b/src/markdown-pages/components/stack-item.mdx @@ -3,5 +3,5 @@ path: '/components/stack-item' title: 'StackItem' description: 'A StackItem component!' component: 'StackItem' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/stack.mdx b/src/markdown-pages/components/stack.mdx index 436722ad5..792f85bbb 100644 --- a/src/markdown-pages/components/stack.mdx +++ b/src/markdown-pages/components/stack.mdx @@ -3,5 +3,5 @@ path: '/components/stack' title: 'Stack' description: 'A Stack component!' component: 'Stack' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/stacked-bar-chart.mdx b/src/markdown-pages/components/stacked-bar-chart.mdx index 199cd4a87..756778b41 100644 --- a/src/markdown-pages/components/stacked-bar-chart.mdx +++ b/src/markdown-pages/components/stacked-bar-chart.mdx @@ -3,5 +3,5 @@ path: '/components/stacked-bar-chart' title: 'StackedBarChart' description: 'A StackedBarChart component!' component: 'StackedBarChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/table-chart.mdx b/src/markdown-pages/components/table-chart.mdx index 35ba09b14..ebb88840e 100644 --- a/src/markdown-pages/components/table-chart.mdx +++ b/src/markdown-pages/components/table-chart.mdx @@ -3,5 +3,5 @@ path: '/components/table-chart' title: 'TableChart' description: 'A TableChart component!' component: 'TableChart' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/table-header-cell.mdx b/src/markdown-pages/components/table-header-cell.mdx index c34cfdad2..2ed6259cb 100644 --- a/src/markdown-pages/components/table-header-cell.mdx +++ b/src/markdown-pages/components/table-header-cell.mdx @@ -3,5 +3,5 @@ path: '/components/table-header-cell' title: 'TableHeaderCell' description: 'A TableHeaderCell component!' component: 'TableHeaderCell' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/table-header.mdx b/src/markdown-pages/components/table-header.mdx index c164a84d6..6e62f10bf 100644 --- a/src/markdown-pages/components/table-header.mdx +++ b/src/markdown-pages/components/table-header.mdx @@ -3,5 +3,5 @@ path: '/components/table-header' title: 'TableHeader' description: 'A TableHeader component!' component: 'TableHeader' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/table-row-cell.mdx b/src/markdown-pages/components/table-row-cell.mdx index afb7c4ef7..024b64aae 100644 --- a/src/markdown-pages/components/table-row-cell.mdx +++ b/src/markdown-pages/components/table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/table-row-cell' title: 'TableRowCell' description: 'A TableRowCell component!' component: 'TableRowCell' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/table-row.mdx b/src/markdown-pages/components/table-row.mdx index 4660d72fd..00680840a 100644 --- a/src/markdown-pages/components/table-row.mdx +++ b/src/markdown-pages/components/table-row.mdx @@ -3,5 +3,5 @@ path: '/components/table-row' title: 'TableRow' description: 'A TableRow component!' component: 'TableRow' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/table.mdx b/src/markdown-pages/components/table.mdx index 3a8f36c7e..aa8f35ed8 100644 --- a/src/markdown-pages/components/table.mdx +++ b/src/markdown-pages/components/table.mdx @@ -3,5 +3,5 @@ path: '/components/table' title: 'Table' description: 'A Table component!' component: 'Table' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/tabs-item.mdx b/src/markdown-pages/components/tabs-item.mdx index 81d3884d3..9a61ae2e1 100644 --- a/src/markdown-pages/components/tabs-item.mdx +++ b/src/markdown-pages/components/tabs-item.mdx @@ -3,5 +3,5 @@ path: '/components/tabs-item' title: 'TabsItem' description: 'A TabsItem component!' component: 'TabsItem' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/tabs.mdx b/src/markdown-pages/components/tabs.mdx index 617ff8c5f..1cac27567 100644 --- a/src/markdown-pages/components/tabs.mdx +++ b/src/markdown-pages/components/tabs.mdx @@ -3,5 +3,5 @@ path: '/components/tabs' title: 'Tabs' description: 'A Tabs component!' component: 'Tabs' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/text-field.mdx b/src/markdown-pages/components/text-field.mdx index c6810d1d8..d86bb6cbd 100644 --- a/src/markdown-pages/components/text-field.mdx +++ b/src/markdown-pages/components/text-field.mdx @@ -3,5 +3,5 @@ path: '/components/text-field' title: 'TextField' description: 'A TextField component!' component: 'TextField' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/toast.mdx b/src/markdown-pages/components/toast.mdx index 397f76384..2e7424bd8 100644 --- a/src/markdown-pages/components/toast.mdx +++ b/src/markdown-pages/components/toast.mdx @@ -3,5 +3,5 @@ path: '/components/toast' title: 'Toast' description: 'A Toast component!' component: 'Toast' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/tooltip.mdx b/src/markdown-pages/components/tooltip.mdx index e63d90d47..7315e9d45 100644 --- a/src/markdown-pages/components/tooltip.mdx +++ b/src/markdown-pages/components/tooltip.mdx @@ -3,5 +3,5 @@ path: '/components/tooltip' title: 'Tooltip' description: 'A Tooltip component!' component: 'Tooltip' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/user-query.mdx b/src/markdown-pages/components/user-query.mdx index 51ff58a2e..d585e08ed 100644 --- a/src/markdown-pages/components/user-query.mdx +++ b/src/markdown-pages/components/user-query.mdx @@ -3,5 +3,5 @@ path: '/components/user-query' title: 'UserQuery' description: 'An UserQuery component!' component: 'UserQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/user-storage-mutation.mdx b/src/markdown-pages/components/user-storage-mutation.mdx index 202146fcb..1259a5243 100644 --- a/src/markdown-pages/components/user-storage-mutation.mdx +++ b/src/markdown-pages/components/user-storage-mutation.mdx @@ -3,5 +3,5 @@ path: '/components/user-storage-mutation' title: 'UserStorageMutation' description: 'A UserStorageMutation component!' component: 'UserStorageMutation' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/user-storage-query.mdx b/src/markdown-pages/components/user-storage-query.mdx index 94a8cf16f..eb30a7dbc 100644 --- a/src/markdown-pages/components/user-storage-query.mdx +++ b/src/markdown-pages/components/user-storage-query.mdx @@ -3,5 +3,5 @@ path: '/components/user-storage-query' title: 'UserStorageQuery' description: 'A UserStorageQuery component!' component: 'UserStorageQuery' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/markdown-pages/components/user-table-row-cell.mdx b/src/markdown-pages/components/user-table-row-cell.mdx index 93b50b2e0..123dd20e8 100644 --- a/src/markdown-pages/components/user-table-row-cell.mdx +++ b/src/markdown-pages/components/user-table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/user-table-row-cell' title: 'UserTableRowCell' description: 'A UserTableRowCell component!' component: 'UserTableRowCell' -template: 'ReferenceTemplate' +template: 'ComponentDocTemplate' --- diff --git a/src/templates/ReferenceTemplate.js b/src/templates/ApiDocTemplate.js similarity index 95% rename from src/templates/ReferenceTemplate.js rename to src/templates/ApiDocTemplate.js index 081bb1503..233ac1046 100644 --- a/src/templates/ReferenceTemplate.js +++ b/src/templates/ApiDocTemplate.js @@ -12,7 +12,7 @@ import Sidebar from '../components/Sidebar'; import SEO from '../components/Seo'; import PropList from '../components/PropList'; import pages from '../data/sidenav.json'; -import styles from './ReferenceTemplate.module.scss'; +import styles from './ApiDocTemplate.module.scss'; import useComponentDoc from '../hooks/useComponentDoc'; const previewStyles = { @@ -21,7 +21,7 @@ const previewStyles = { }, }; -const ReferenceTemplate = ({ data }) => { +const ApiDocTemplate = ({ data }) => { const [isOpen, setIsOpen] = useState(false); const { mdx } = data; const { frontmatter } = mdx; @@ -111,7 +111,7 @@ const ReferenceTemplate = ({ data }) => { ); }; -ReferenceTemplate.propTypes = { +ApiDocTemplate.propTypes = { data: PropTypes.object, }; @@ -129,4 +129,4 @@ export const pageQuery = graphql` } `; -export default ReferenceTemplate; +export default ApiDocTemplate; diff --git a/src/templates/ReferenceTemplate.module.scss b/src/templates/ApiDocTemplate.module.scss similarity index 100% rename from src/templates/ReferenceTemplate.module.scss rename to src/templates/ApiDocTemplate.module.scss diff --git a/src/templates/ComponentDocTemplate.js b/src/templates/ComponentDocTemplate.js new file mode 100644 index 000000000..68390eba4 --- /dev/null +++ b/src/templates/ComponentDocTemplate.js @@ -0,0 +1,132 @@ +import React, { Fragment, useState } from 'react'; +import cx from 'classnames'; +import { graphql } from 'gatsby'; +import PropTypes from 'prop-types'; +import InlineCodeSnippet from '../components/InlineCodeSnippet'; +import ReactMarkdown from 'react-markdown'; +import Container from '../components/Container'; +import ComponentExample from '../components/ComponentExample'; +import FunctionDefinition from '../components/FunctionDefinition'; +import Layout from '../components/Layout'; +import Sidebar from '../components/Sidebar'; +import SEO from '../components/Seo'; +import PropList from '../components/PropList'; +import pages from '../data/sidenav.json'; +import styles from './ComponentDocTemplate.module.scss'; +import useComponentDoc from '../hooks/useComponentDoc'; + +const previewStyles = { + Spinner: { + height: '16px', + }, +}; + +const ComponentDocTemplate = ({ data }) => { + const [isOpen, setIsOpen] = useState(false); + const { mdx } = data; + const { frontmatter } = mdx; + const { title, description, component } = frontmatter; + const componentDoc = useComponentDoc(component); + + const { + examples = [], + description: componentDescription, + methods = [], + usage = '', + propTypes = [], + } = componentDoc ?? {}; + + return ( + + + + setIsOpen(!isOpen)} + /> +
+

{component}

+ +
+ +
+ +
+

Usage

+ {usage} +
+ + {examples.length > 0 && ( +
+

Examples

+
+ {examples.map((example, i) => ( + + ))} +
+
+ )} + +
+

Props

+ +
+ + {methods.length > 0 && ( +
+

Methods

+ {methods.map((method, i) => ( + +

{method.name}

+ + + {method.examples.map((example, i) => ( + + ))} +
+ ))} +
+ )} +
+
+
+ ); +}; + +ComponentDocTemplate.propTypes = { + data: PropTypes.object, +}; + +export const pageQuery = graphql` + query($path: String!) { + mdx(frontmatter: { path: { eq: $path } }) { + body + frontmatter { + path + title + description + component + } + } + } +`; + +export default ComponentDocTemplate; diff --git a/src/templates/ComponentDocTemplate.module.scss b/src/templates/ComponentDocTemplate.module.scss new file mode 100644 index 000000000..2279cec8d --- /dev/null +++ b/src/templates/ComponentDocTemplate.module.scss @@ -0,0 +1,67 @@ +.container { + display: grid; + grid-template-columns: auto 3fr; + grid-column-gap: 2rem; + grid-template-areas: 'sidebar main'; + + @media (max-width: 760px) { + grid-template-columns: none; + grid-template-areas: 'sidebar' 'main'; + } +} + +.content { + grid-area: main; +} + +.sidebar { + grid-area: sidebar; +} + +.componentExample:not(:last-child) { + margin-bottom: 2rem; +} + +.description { + border-top: 1px solid var(--color-neutrals-200); + margin-top: 0.5rem; + padding-top: 0.5rem; + + ul { + padding-top: 0.5rem; + } + + li { + margin: 0; + } +} + +.section:not(:last-child) { + margin-bottom: 2rem; +} + +.toastManager > div { + position: fixed; + top: 0; + right: 0; + bottom: 0; + display: flex; + flex-direction: column; + padding-top: 16px; + padding-right: 16px; + pointer-events: none; + z-index: 200; + min-height: 9999px; +} + +.methodDescription { + margin-top: 1rem; + margin-bottom: 1rem; +} + +.methodName { + padding: 0.125rem 0.25rem; + display: inline; + color: var(--color-teal-500); + background: var(--color-teal-050); +} From cca78bf1e5f47d79ca5c0fc58dba60a68c8b9b0d Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 17:17:35 -0700 Subject: [PATCH 06/14] chore: Remove props and examples sections from api doc --- src/templates/ApiDocTemplate.js | 33 +++------------------------------ 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/src/templates/ApiDocTemplate.js b/src/templates/ApiDocTemplate.js index 233ac1046..81e089e48 100644 --- a/src/templates/ApiDocTemplate.js +++ b/src/templates/ApiDocTemplate.js @@ -28,13 +28,8 @@ const ApiDocTemplate = ({ data }) => { const { title, description, component } = frontmatter; const componentDoc = useComponentDoc(component); - const { - examples = [], - description: componentDescription, - methods = [], - usage = '', - propTypes = [], - } = componentDoc ?? {}; + const { description: componentDescription, methods = [], usage = '' } = + componentDoc ?? {}; return ( @@ -58,31 +53,9 @@ const ApiDocTemplate = ({ data }) => { {usage} - {examples.length > 0 && ( -
-

Examples

-
- {examples.map((example, i) => ( - - ))} -
-
- )} - -
-

Props

- -
- {methods.length > 0 && (
-

Methods

+

API methods

{methods.map((method, i) => (

{method.name}

From 49e5f613eb2016726231bd32ad3be63d4e9c16ee Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 17:23:36 -0700 Subject: [PATCH 07/14] feat: Create useApiDoc hook. Update ApiDocTemplate to use api-specific language --- src/hooks/useApiDoc.js | 49 +++++++++++++++++++++++++++++ src/markdown-pages/apis/logger.mdx | 2 +- src/markdown-pages/apis/nerdlet.mdx | 2 +- src/templates/ApiDocTemplate.js | 23 +++++--------- 4 files changed, 58 insertions(+), 18 deletions(-) create mode 100644 src/hooks/useApiDoc.js diff --git a/src/hooks/useApiDoc.js b/src/hooks/useApiDoc.js new file mode 100644 index 000000000..5ffbb1be2 --- /dev/null +++ b/src/hooks/useApiDoc.js @@ -0,0 +1,49 @@ +import { useMemo } from 'react'; + +const IGNORED_METHODS = [ + 'prototype', + 'length', + 'name', + 'propTypes', + 'getDerivedStateFromProps', + 'defaultProps', +]; + +const useApiDoc = (name) => { + if (typeof window === 'undefined') global.window = {}; + + return useMemo(() => { + const sdk = window.__NR1_SDK__?.default ?? {}; + const api = sdk[name]; + + if (!api) { + return null; + } + + const apiDocs = api?.__docs__; + + return { + description: apiDocs?.text, + usage: `import { ${name} } from 'nr1'`, + methods: Object.getOwnPropertyNames(api) + .filter( + (member) => + !IGNORED_METHODS.includes(member) && + typeof api[member] === 'function' + ) + .map((member) => { + const methodDocs = api[member].__docs__; + + return { + name: `${name}.${member}`, + description: methodDocs?.text, + returnValue: methodDocs?.tags.return?.[0] ?? { type: 'undefined' }, + params: methodDocs?.tags.param ?? [], + examples: methodDocs?.tags.examples ?? [], + }; + }), + }; + }, [name, window?.__NR1_SDK__]); +}; + +export default useApiDoc; diff --git a/src/markdown-pages/apis/logger.mdx b/src/markdown-pages/apis/logger.mdx index def6b5c6e..025674ced 100644 --- a/src/markdown-pages/apis/logger.mdx +++ b/src/markdown-pages/apis/logger.mdx @@ -2,6 +2,6 @@ path: '/apis/logger' title: 'PlatformStateContext' description: 'A logger component!' -component: 'logger' +api: 'logger' template: 'ApiDocTemplate' --- diff --git a/src/markdown-pages/apis/nerdlet.mdx b/src/markdown-pages/apis/nerdlet.mdx index a87056f73..90ef02c86 100644 --- a/src/markdown-pages/apis/nerdlet.mdx +++ b/src/markdown-pages/apis/nerdlet.mdx @@ -2,6 +2,6 @@ path: '/apis/nerdlet' title: 'Nerdlet' description: 'The nerdlet API' -component: 'nerdlet' +api: 'nerdlet' template: 'ApiDocTemplate' --- diff --git a/src/templates/ApiDocTemplate.js b/src/templates/ApiDocTemplate.js index 81e089e48..4f5dbd812 100644 --- a/src/templates/ApiDocTemplate.js +++ b/src/templates/ApiDocTemplate.js @@ -10,26 +10,17 @@ import FunctionDefinition from '../components/FunctionDefinition'; import Layout from '../components/Layout'; import Sidebar from '../components/Sidebar'; import SEO from '../components/Seo'; -import PropList from '../components/PropList'; import pages from '../data/sidenav.json'; import styles from './ApiDocTemplate.module.scss'; -import useComponentDoc from '../hooks/useComponentDoc'; - -const previewStyles = { - Spinner: { - height: '16px', - }, -}; +import useApiDoc from '../hooks/useApiDoc'; const ApiDocTemplate = ({ data }) => { const [isOpen, setIsOpen] = useState(false); const { mdx } = data; const { frontmatter } = mdx; - const { title, description, component } = frontmatter; - const componentDoc = useComponentDoc(component); - - const { description: componentDescription, methods = [], usage = '' } = - componentDoc ?? {}; + const { title, description, api } = frontmatter; + const { description: apiDescription, methods = [], usage = '' } = + useApiDoc(api) ?? {}; return ( @@ -42,10 +33,10 @@ const ApiDocTemplate = ({ data }) => { toggle={() => setIsOpen(!isOpen)} />
-

{component}

+

{api}

- +
@@ -96,7 +87,7 @@ export const pageQuery = graphql` path title description - component + api } } } From d64e9dffcac40d4840c747d0c5a8b49da6749c46 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 17:50:26 -0700 Subject: [PATCH 08/14] feat: Extract a MethodReference component and add to the 2 reference templates --- src/components/MethodReference.js | 37 ++++++++++++++++++++++ src/components/MethodReference.module.scss | 11 +++++++ src/templates/ApiDocTemplate.js | 24 ++------------ src/templates/ComponentDocTemplate.js | 23 ++------------ 4 files changed, 54 insertions(+), 41 deletions(-) create mode 100644 src/components/MethodReference.js create mode 100644 src/components/MethodReference.module.scss diff --git a/src/components/MethodReference.js b/src/components/MethodReference.js new file mode 100644 index 000000000..76b3e552f --- /dev/null +++ b/src/components/MethodReference.js @@ -0,0 +1,37 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import ComponentExample from './ComponentExample'; +import FunctionDefinition from './FunctionDefinition'; +import Markdown from 'react-markdown'; +import styles from './MethodReference.module.scss'; + +const MethodReference = ({ className, method }) => ( +
+

{method.name}

+ + + {method.examples.map((example, i) => ( + + ))} +
+); + +MethodReference.propTypes = { + className: PropTypes.string, + method: PropTypes.shape({ + name: PropTypes.string.isRequired, + description: PropTypes.string, + params: FunctionDefinition.propTypes.params, + returnValue: FunctionDefinition.propTypes.returnValue, + examples: PropTypes.arrayOf(ComponentExample.propTypes.example), + }), +}; + +export default MethodReference; diff --git a/src/components/MethodReference.module.scss b/src/components/MethodReference.module.scss new file mode 100644 index 000000000..03d8e0ff1 --- /dev/null +++ b/src/components/MethodReference.module.scss @@ -0,0 +1,11 @@ +.name { + padding: 0.125rem 0.25rem; + display: inline; + color: var(--color-teal-500); + background: var(--color-teal-050); +} + +.description { + margin-top: 1rem; + margin-bottom: 1rem; +} diff --git a/src/templates/ApiDocTemplate.js b/src/templates/ApiDocTemplate.js index 4f5dbd812..7ddbb21af 100644 --- a/src/templates/ApiDocTemplate.js +++ b/src/templates/ApiDocTemplate.js @@ -1,13 +1,12 @@ -import React, { Fragment, useState } from 'react'; +import React, { useState } from 'react'; import cx from 'classnames'; import { graphql } from 'gatsby'; import PropTypes from 'prop-types'; import InlineCodeSnippet from '../components/InlineCodeSnippet'; import ReactMarkdown from 'react-markdown'; import Container from '../components/Container'; -import ComponentExample from '../components/ComponentExample'; -import FunctionDefinition from '../components/FunctionDefinition'; import Layout from '../components/Layout'; +import MethodReference from '../components/MethodReference'; import Sidebar from '../components/Sidebar'; import SEO from '../components/Seo'; import pages from '../data/sidenav.json'; @@ -48,24 +47,7 @@ const ApiDocTemplate = ({ data }) => {

API methods

{methods.map((method, i) => ( - -

{method.name}

- - - {method.examples.map((example, i) => ( - - ))} -
+ ))}
)} diff --git a/src/templates/ComponentDocTemplate.js b/src/templates/ComponentDocTemplate.js index 68390eba4..f591c9172 100644 --- a/src/templates/ComponentDocTemplate.js +++ b/src/templates/ComponentDocTemplate.js @@ -1,4 +1,4 @@ -import React, { Fragment, useState } from 'react'; +import React, { useState } from 'react'; import cx from 'classnames'; import { graphql } from 'gatsby'; import PropTypes from 'prop-types'; @@ -6,8 +6,8 @@ import InlineCodeSnippet from '../components/InlineCodeSnippet'; import ReactMarkdown from 'react-markdown'; import Container from '../components/Container'; import ComponentExample from '../components/ComponentExample'; -import FunctionDefinition from '../components/FunctionDefinition'; import Layout from '../components/Layout'; +import MethodReference from '../components/MethodReference'; import Sidebar from '../components/Sidebar'; import SEO from '../components/Seo'; import PropList from '../components/PropList'; @@ -84,24 +84,7 @@ const ComponentDocTemplate = ({ data }) => {

Methods

{methods.map((method, i) => ( - -

{method.name}

- - - {method.examples.map((example, i) => ( - - ))} -
+ ))}
)} From 80fdbff56518986bf386fb06e701cfa69e1799eb Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 17:53:38 -0700 Subject: [PATCH 09/14] feat: Clean up styles between the reference templates --- src/components/MethodReference.js | 6 +--- src/components/MethodReference.module.scss | 4 +++ src/templates/ApiDocTemplate.module.scss | 30 ------------------- .../ComponentDocTemplate.module.scss | 12 -------- 4 files changed, 5 insertions(+), 47 deletions(-) diff --git a/src/components/MethodReference.js b/src/components/MethodReference.js index 76b3e552f..42c1b420a 100644 --- a/src/components/MethodReference.js +++ b/src/components/MethodReference.js @@ -14,11 +14,7 @@ const MethodReference = ({ className, method }) => ( returnValue={method.returnValue} /> {method.examples.map((example, i) => ( - + ))}
); diff --git a/src/components/MethodReference.module.scss b/src/components/MethodReference.module.scss index 03d8e0ff1..ae4595557 100644 --- a/src/components/MethodReference.module.scss +++ b/src/components/MethodReference.module.scss @@ -9,3 +9,7 @@ margin-top: 1rem; margin-bottom: 1rem; } + +.example:not(:last-child) { + margin-bottom: 2rem; +} diff --git a/src/templates/ApiDocTemplate.module.scss b/src/templates/ApiDocTemplate.module.scss index 2279cec8d..e7488cc0a 100644 --- a/src/templates/ApiDocTemplate.module.scss +++ b/src/templates/ApiDocTemplate.module.scss @@ -18,10 +18,6 @@ grid-area: sidebar; } -.componentExample:not(:last-child) { - margin-bottom: 2rem; -} - .description { border-top: 1px solid var(--color-neutrals-200); margin-top: 0.5rem; @@ -39,29 +35,3 @@ .section:not(:last-child) { margin-bottom: 2rem; } - -.toastManager > div { - position: fixed; - top: 0; - right: 0; - bottom: 0; - display: flex; - flex-direction: column; - padding-top: 16px; - padding-right: 16px; - pointer-events: none; - z-index: 200; - min-height: 9999px; -} - -.methodDescription { - margin-top: 1rem; - margin-bottom: 1rem; -} - -.methodName { - padding: 0.125rem 0.25rem; - display: inline; - color: var(--color-teal-500); - background: var(--color-teal-050); -} diff --git a/src/templates/ComponentDocTemplate.module.scss b/src/templates/ComponentDocTemplate.module.scss index 2279cec8d..1e21bd266 100644 --- a/src/templates/ComponentDocTemplate.module.scss +++ b/src/templates/ComponentDocTemplate.module.scss @@ -53,15 +53,3 @@ z-index: 200; min-height: 9999px; } - -.methodDescription { - margin-top: 1rem; - margin-bottom: 1rem; -} - -.methodName { - padding: 0.125rem 0.25rem; - display: inline; - color: var(--color-teal-500); - background: var(--color-teal-050); -} From 8ea4062e047af809149f1403fcee6e0d130d6bf3 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 17:58:05 -0700 Subject: [PATCH 10/14] feat: Extract common styles to a ReferenceTemplate.module.scss --- src/templates/ApiDocTemplate.js | 16 ++++---- src/templates/ComponentDocTemplate.js | 19 ++++++---- .../ComponentDocTemplate.module.scss | 38 ------------------- ...ule.scss => ReferenceTemplate.module.scss} | 0 4 files changed, 20 insertions(+), 53 deletions(-) rename src/templates/{ApiDocTemplate.module.scss => ReferenceTemplate.module.scss} (100%) diff --git a/src/templates/ApiDocTemplate.js b/src/templates/ApiDocTemplate.js index 7ddbb21af..0f5840ab5 100644 --- a/src/templates/ApiDocTemplate.js +++ b/src/templates/ApiDocTemplate.js @@ -10,7 +10,7 @@ import MethodReference from '../components/MethodReference'; import Sidebar from '../components/Sidebar'; import SEO from '../components/Seo'; import pages from '../data/sidenav.json'; -import styles from './ApiDocTemplate.module.scss'; +import templateStyles from './ReferenceTemplate.module.scss'; import useApiDoc from '../hooks/useApiDoc'; const ApiDocTemplate = ({ data }) => { @@ -24,27 +24,29 @@ const ApiDocTemplate = ({ data }) => { return ( - + setIsOpen(!isOpen)} /> -
+

{api}

-
+
-
+

Usage

{usage}
{methods.length > 0 && ( -
+

API methods

{methods.map((method, i) => ( diff --git a/src/templates/ComponentDocTemplate.js b/src/templates/ComponentDocTemplate.js index f591c9172..a5f9d3f3e 100644 --- a/src/templates/ComponentDocTemplate.js +++ b/src/templates/ComponentDocTemplate.js @@ -13,6 +13,7 @@ import SEO from '../components/Seo'; import PropList from '../components/PropList'; import pages from '../data/sidenav.json'; import styles from './ComponentDocTemplate.module.scss'; +import templateStyles from './ReferenceTemplate.module.scss'; import useComponentDoc from '../hooks/useComponentDoc'; const previewStyles = { @@ -39,27 +40,29 @@ const ComponentDocTemplate = ({ data }) => { return ( - + setIsOpen(!isOpen)} /> -
+

{component}

-
+
-
+

Usage

{usage}
{examples.length > 0 && ( -
+

Examples

{examples.map((example, i) => ( @@ -75,13 +78,13 @@ const ComponentDocTemplate = ({ data }) => {
)} -
+

Props

{methods.length > 0 && ( -
+

Methods

{methods.map((method, i) => ( diff --git a/src/templates/ComponentDocTemplate.module.scss b/src/templates/ComponentDocTemplate.module.scss index 1e21bd266..887a5965d 100644 --- a/src/templates/ComponentDocTemplate.module.scss +++ b/src/templates/ComponentDocTemplate.module.scss @@ -1,45 +1,7 @@ -.container { - display: grid; - grid-template-columns: auto 3fr; - grid-column-gap: 2rem; - grid-template-areas: 'sidebar main'; - - @media (max-width: 760px) { - grid-template-columns: none; - grid-template-areas: 'sidebar' 'main'; - } -} - -.content { - grid-area: main; -} - -.sidebar { - grid-area: sidebar; -} - .componentExample:not(:last-child) { margin-bottom: 2rem; } -.description { - border-top: 1px solid var(--color-neutrals-200); - margin-top: 0.5rem; - padding-top: 0.5rem; - - ul { - padding-top: 0.5rem; - } - - li { - margin: 0; - } -} - -.section:not(:last-child) { - margin-bottom: 2rem; -} - .toastManager > div { position: fixed; top: 0; diff --git a/src/templates/ApiDocTemplate.module.scss b/src/templates/ReferenceTemplate.module.scss similarity index 100% rename from src/templates/ApiDocTemplate.module.scss rename to src/templates/ReferenceTemplate.module.scss From 831eb6093205c63d8733d0289abecabbab474e80 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 18:00:54 -0700 Subject: [PATCH 11/14] chore: Rename ComponentDocTemplate and ApiDocTemplate to use Reference instead of Doc --- src/markdown-pages/apis/logger.mdx | 2 +- src/markdown-pages/apis/nerdlet.mdx | 2 +- src/markdown-pages/components/account-picker.mdx | 2 +- .../components/account-storage-mutation.mdx | 2 +- src/markdown-pages/components/account-storage-query.mdx | 2 +- src/markdown-pages/components/accounts-query.mdx | 2 +- src/markdown-pages/components/area-chart.mdx | 2 +- src/markdown-pages/components/auto-sizer.mdx | 2 +- src/markdown-pages/components/bar-chart.mdx | 2 +- src/markdown-pages/components/billboard-chart.mdx | 2 +- src/markdown-pages/components/block-text.mdx | 2 +- src/markdown-pages/components/button.mdx | 2 +- src/markdown-pages/components/card-body.mdx | 2 +- src/markdown-pages/components/card-header.mdx | 2 +- src/markdown-pages/components/card.mdx | 2 +- src/markdown-pages/components/chart-group.mdx | 2 +- src/markdown-pages/components/checkbox.mdx | 2 +- src/markdown-pages/components/dropdown-item.mdx | 2 +- src/markdown-pages/components/dropdown.mdx | 2 +- .../components/entities-by-domain-type-query.mdx | 2 +- src/markdown-pages/components/entities-by-guids-query.mdx | 2 +- src/markdown-pages/components/entities-by-name-query.mdx | 2 +- src/markdown-pages/components/entity-by-guid-query.mdx | 2 +- src/markdown-pages/components/entity-count-query.mdx | 2 +- src/markdown-pages/components/entity-search-query.mdx | 2 +- src/markdown-pages/components/entity-storage-mutation.mdx | 2 +- src/markdown-pages/components/entity-storage-query.mdx | 2 +- .../components/entity-title-table-row-cell.mdx | 2 +- src/markdown-pages/components/funnel-chart.mdx | 2 +- src/markdown-pages/components/grid-item.mdx | 2 +- src/markdown-pages/components/grid.mdx | 2 +- src/markdown-pages/components/heading-text.mdx | 2 +- src/markdown-pages/components/heatmap-component.mdx | 2 +- src/markdown-pages/components/histogram-chart.mdx | 2 +- src/markdown-pages/components/icon.mdx | 2 +- src/markdown-pages/components/json-chart.mdx | 2 +- src/markdown-pages/components/line-chart.mdx | 2 +- src/markdown-pages/components/link.mdx | 2 +- src/markdown-pages/components/list-item.mdx | 2 +- src/markdown-pages/components/list.mdx | 2 +- src/markdown-pages/components/metric-table-row-cell.mdx | 2 +- src/markdown-pages/components/modal.mdx | 2 +- src/markdown-pages/components/nerd-graph-mutation.mdx | 2 +- src/markdown-pages/components/nerd-graph-query.mdx | 2 +- src/markdown-pages/components/nerdlet-state-context.mdx | 2 +- src/markdown-pages/components/nrql-query.mdx | 2 +- src/markdown-pages/components/pie-chart.mdx | 2 +- src/markdown-pages/components/platform-state-context.mdx | 2 +- src/markdown-pages/components/radio-group.mdx | 2 +- src/markdown-pages/components/radio.mdx | 2 +- src/markdown-pages/components/scatter-chart.mdx | 2 +- src/markdown-pages/components/select-item.mdx | 2 +- src/markdown-pages/components/select.mdx | 2 +- src/markdown-pages/components/spacing.mdx | 2 +- src/markdown-pages/components/sparkline-chart.mdx | 2 +- .../components/sparkline-table-row-cell.mdx | 2 +- src/markdown-pages/components/spinner.mdx | 2 +- src/markdown-pages/components/stack-item.mdx | 2 +- src/markdown-pages/components/stack.mdx | 2 +- src/markdown-pages/components/stacked-bar-chart.mdx | 2 +- src/markdown-pages/components/table-chart.mdx | 2 +- src/markdown-pages/components/table-header-cell.mdx | 2 +- src/markdown-pages/components/table-header.mdx | 2 +- src/markdown-pages/components/table-row-cell.mdx | 2 +- src/markdown-pages/components/table-row.mdx | 2 +- src/markdown-pages/components/table.mdx | 2 +- src/markdown-pages/components/tabs-item.mdx | 2 +- src/markdown-pages/components/tabs.mdx | 2 +- src/markdown-pages/components/text-field.mdx | 2 +- src/markdown-pages/components/toast.mdx | 2 +- src/markdown-pages/components/tooltip.mdx | 2 +- src/markdown-pages/components/user-query.mdx | 2 +- src/markdown-pages/components/user-storage-mutation.mdx | 2 +- src/markdown-pages/components/user-storage-query.mdx | 2 +- src/markdown-pages/components/user-table-row-cell.mdx | 2 +- .../{ApiDocTemplate.js => ApiReferenceTemplate.js} | 6 +++--- ...ponentDocTemplate.js => ComponentReferenceTemplate.js} | 8 ++++---- ...module.scss => ComponentReferenceTemplate.module.scss} | 0 78 files changed, 82 insertions(+), 82 deletions(-) rename src/templates/{ApiDocTemplate.js => ApiReferenceTemplate.js} (94%) rename src/templates/{ComponentDocTemplate.js => ComponentReferenceTemplate.js} (94%) rename src/templates/{ComponentDocTemplate.module.scss => ComponentReferenceTemplate.module.scss} (100%) diff --git a/src/markdown-pages/apis/logger.mdx b/src/markdown-pages/apis/logger.mdx index 025674ced..b4fbf973d 100644 --- a/src/markdown-pages/apis/logger.mdx +++ b/src/markdown-pages/apis/logger.mdx @@ -3,5 +3,5 @@ path: '/apis/logger' title: 'PlatformStateContext' description: 'A logger component!' api: 'logger' -template: 'ApiDocTemplate' +template: 'ApiReferenceTemplate' --- diff --git a/src/markdown-pages/apis/nerdlet.mdx b/src/markdown-pages/apis/nerdlet.mdx index 90ef02c86..3c70b7bee 100644 --- a/src/markdown-pages/apis/nerdlet.mdx +++ b/src/markdown-pages/apis/nerdlet.mdx @@ -3,5 +3,5 @@ path: '/apis/nerdlet' title: 'Nerdlet' description: 'The nerdlet API' api: 'nerdlet' -template: 'ApiDocTemplate' +template: 'ApiReferenceTemplate' --- diff --git a/src/markdown-pages/components/account-picker.mdx b/src/markdown-pages/components/account-picker.mdx index a14cd11e8..41aa15489 100644 --- a/src/markdown-pages/components/account-picker.mdx +++ b/src/markdown-pages/components/account-picker.mdx @@ -3,5 +3,5 @@ path: '/components/account-picker' title: 'AccountPicker' description: 'An AccountPicker component!' component: 'AccountPicker' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/account-storage-mutation.mdx b/src/markdown-pages/components/account-storage-mutation.mdx index 7e800646b..8c2d05603 100644 --- a/src/markdown-pages/components/account-storage-mutation.mdx +++ b/src/markdown-pages/components/account-storage-mutation.mdx @@ -3,5 +3,5 @@ path: '/components/account-storage-mutation' title: 'AccountStorageMutation' description: 'An AccountStorageMutation component!' component: 'AccountStorageMutation' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/account-storage-query.mdx b/src/markdown-pages/components/account-storage-query.mdx index a10482beb..b930d12da 100644 --- a/src/markdown-pages/components/account-storage-query.mdx +++ b/src/markdown-pages/components/account-storage-query.mdx @@ -3,5 +3,5 @@ path: '/components/account-storage-query' title: 'AccountStorageQuery' description: 'An AccountStorageQuery component!' component: 'AccountStorageQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/accounts-query.mdx b/src/markdown-pages/components/accounts-query.mdx index c5e7a7b80..0f47252da 100644 --- a/src/markdown-pages/components/accounts-query.mdx +++ b/src/markdown-pages/components/accounts-query.mdx @@ -3,5 +3,5 @@ path: '/components/accounts-query' title: 'AccountsQuery' description: 'A AccountsQuery component!' component: 'AccountsQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/area-chart.mdx b/src/markdown-pages/components/area-chart.mdx index 86bb65a6d..b24906bc4 100644 --- a/src/markdown-pages/components/area-chart.mdx +++ b/src/markdown-pages/components/area-chart.mdx @@ -3,5 +3,5 @@ path: '/components/area-chart' title: 'AreaChart' description: 'An AreaChart component!' component: 'AreaChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/auto-sizer.mdx b/src/markdown-pages/components/auto-sizer.mdx index 151fe4dde..5083c4f58 100644 --- a/src/markdown-pages/components/auto-sizer.mdx +++ b/src/markdown-pages/components/auto-sizer.mdx @@ -3,5 +3,5 @@ path: '/components/auto-sizer' title: 'AutoSizer' description: 'An AutoSizer component!' component: 'AutoSizer' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/bar-chart.mdx b/src/markdown-pages/components/bar-chart.mdx index 591d4559d..0617d999e 100644 --- a/src/markdown-pages/components/bar-chart.mdx +++ b/src/markdown-pages/components/bar-chart.mdx @@ -3,5 +3,5 @@ path: '/components/bar-chart' title: 'BarChart' description: 'A BarChart component!' component: 'BarChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/billboard-chart.mdx b/src/markdown-pages/components/billboard-chart.mdx index fc3b13d4a..3ef7a3a96 100644 --- a/src/markdown-pages/components/billboard-chart.mdx +++ b/src/markdown-pages/components/billboard-chart.mdx @@ -3,5 +3,5 @@ path: '/components/billboard-chart' title: 'BillboardChart' description: 'A BillboardChart component!' component: 'BillboardChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/block-text.mdx b/src/markdown-pages/components/block-text.mdx index 3edd3e7c9..becf5517a 100644 --- a/src/markdown-pages/components/block-text.mdx +++ b/src/markdown-pages/components/block-text.mdx @@ -3,5 +3,5 @@ path: '/components/block-text' title: 'BlockText' description: 'A BlockText component!' component: 'BlockText' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/button.mdx b/src/markdown-pages/components/button.mdx index 06d78d5c8..e9ac5dcc3 100644 --- a/src/markdown-pages/components/button.mdx +++ b/src/markdown-pages/components/button.mdx @@ -3,5 +3,5 @@ path: '/components/button' title: 'Button' description: 'A button component!' component: 'Button' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- \ No newline at end of file diff --git a/src/markdown-pages/components/card-body.mdx b/src/markdown-pages/components/card-body.mdx index f8bb7d985..e503103c8 100644 --- a/src/markdown-pages/components/card-body.mdx +++ b/src/markdown-pages/components/card-body.mdx @@ -3,5 +3,5 @@ path: '/components/card-body' title: 'CardBody' description: 'A CardBody component!' component: 'CardBody' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/card-header.mdx b/src/markdown-pages/components/card-header.mdx index b33c21b80..d4eaec951 100644 --- a/src/markdown-pages/components/card-header.mdx +++ b/src/markdown-pages/components/card-header.mdx @@ -3,5 +3,5 @@ path: '/components/card-header' title: 'CardHeader' description: 'A CardHeader component!' component: 'CardHeader' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/card.mdx b/src/markdown-pages/components/card.mdx index b50862f46..86c568b15 100644 --- a/src/markdown-pages/components/card.mdx +++ b/src/markdown-pages/components/card.mdx @@ -3,5 +3,5 @@ path: '/components/card' title: 'Card' description: 'A Card component!' component: 'Card' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/chart-group.mdx b/src/markdown-pages/components/chart-group.mdx index 0b85dd0d6..b5de47e35 100644 --- a/src/markdown-pages/components/chart-group.mdx +++ b/src/markdown-pages/components/chart-group.mdx @@ -3,5 +3,5 @@ path: '/components/chart-group' title: 'ChartGroup' description: 'A ChartGroup component!' component: 'ChartGroup' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/checkbox.mdx b/src/markdown-pages/components/checkbox.mdx index f2899f228..449b62623 100644 --- a/src/markdown-pages/components/checkbox.mdx +++ b/src/markdown-pages/components/checkbox.mdx @@ -3,5 +3,5 @@ path: '/components/checkbox' title: 'Checkbox' description: 'A Checkbox component!' component: 'Checkbox' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/dropdown-item.mdx b/src/markdown-pages/components/dropdown-item.mdx index 93d94d98b..e897b728b 100644 --- a/src/markdown-pages/components/dropdown-item.mdx +++ b/src/markdown-pages/components/dropdown-item.mdx @@ -3,5 +3,5 @@ path: '/components/dropdown-item' title: 'DropdownItem' description: 'A DropdownItem component!' component: 'DropdownItem' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/dropdown.mdx b/src/markdown-pages/components/dropdown.mdx index 6318fa6b1..ee082de33 100644 --- a/src/markdown-pages/components/dropdown.mdx +++ b/src/markdown-pages/components/dropdown.mdx @@ -3,5 +3,5 @@ path: '/components/dropdown' title: 'Dropdown' description: 'A Dropdown component!' component: 'Dropdown' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entities-by-domain-type-query.mdx b/src/markdown-pages/components/entities-by-domain-type-query.mdx index 1f9f3c7c2..1018ed1e0 100644 --- a/src/markdown-pages/components/entities-by-domain-type-query.mdx +++ b/src/markdown-pages/components/entities-by-domain-type-query.mdx @@ -3,5 +3,5 @@ path: '/components/entities-by-domain-type-query' title: 'EntitiesByDomainTypeQuery' description: 'An EntitiesByDomainTypeQuery component!' component: 'EntitiesByDomainTypeQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entities-by-guids-query.mdx b/src/markdown-pages/components/entities-by-guids-query.mdx index a906b7e36..2a9dd9e79 100644 --- a/src/markdown-pages/components/entities-by-guids-query.mdx +++ b/src/markdown-pages/components/entities-by-guids-query.mdx @@ -3,5 +3,5 @@ path: '/components/entities-by-guids-query' title: 'EntitiesByGuidsQuery' description: 'An EntitiesByGuidsQuery component!' component: 'EntitiesByGuidsQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entities-by-name-query.mdx b/src/markdown-pages/components/entities-by-name-query.mdx index 2293fd1d4..aa6727645 100644 --- a/src/markdown-pages/components/entities-by-name-query.mdx +++ b/src/markdown-pages/components/entities-by-name-query.mdx @@ -3,5 +3,5 @@ path: '/components/entities-by-name-query' title: 'EntitiesByNameQuery' description: 'An EntitiesByNameQuery component!' component: 'EntitiesByNameQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entity-by-guid-query.mdx b/src/markdown-pages/components/entity-by-guid-query.mdx index c49830693..2bdad4668 100644 --- a/src/markdown-pages/components/entity-by-guid-query.mdx +++ b/src/markdown-pages/components/entity-by-guid-query.mdx @@ -3,5 +3,5 @@ path: '/components/entity-by-guid-query' title: 'EntityByGuidQuery' description: 'An EntityByGuidQuery component!' component: 'EntityByGuidQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entity-count-query.mdx b/src/markdown-pages/components/entity-count-query.mdx index db6e01b2c..a454e4890 100644 --- a/src/markdown-pages/components/entity-count-query.mdx +++ b/src/markdown-pages/components/entity-count-query.mdx @@ -3,5 +3,5 @@ path: '/components/entity-count-query' title: 'EntityCountQuery' description: 'An EntityCountQuery component!' component: 'EntityCountQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entity-search-query.mdx b/src/markdown-pages/components/entity-search-query.mdx index 59d96a4c6..a28ecb77c 100644 --- a/src/markdown-pages/components/entity-search-query.mdx +++ b/src/markdown-pages/components/entity-search-query.mdx @@ -3,5 +3,5 @@ path: '/components/entity-search-query' title: 'EntitySearchQuery' description: 'An EntitySearchQuery component!' component: 'EntitySearchQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entity-storage-mutation.mdx b/src/markdown-pages/components/entity-storage-mutation.mdx index 15b240378..8fc18b01d 100644 --- a/src/markdown-pages/components/entity-storage-mutation.mdx +++ b/src/markdown-pages/components/entity-storage-mutation.mdx @@ -3,5 +3,5 @@ path: '/components/entity-storage-mutation' title: 'EntityStorageMutation' description: 'An EntityStorageMutation component!' component: 'EntityStorageMutation' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entity-storage-query.mdx b/src/markdown-pages/components/entity-storage-query.mdx index 36b93829a..b09ff61f2 100644 --- a/src/markdown-pages/components/entity-storage-query.mdx +++ b/src/markdown-pages/components/entity-storage-query.mdx @@ -3,5 +3,5 @@ path: '/components/entity-storage-query' title: 'EntityStorageQuery' description: 'An EntityStorageQuery component!' component: 'EntityStorageQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/entity-title-table-row-cell.mdx b/src/markdown-pages/components/entity-title-table-row-cell.mdx index bf573701b..e33af2590 100644 --- a/src/markdown-pages/components/entity-title-table-row-cell.mdx +++ b/src/markdown-pages/components/entity-title-table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/entity-title-table-row-cell' title: 'EntityTitleTableRowCell' description: 'An EntityTitleTableRowCell component!' component: 'EntityTitleTableRowCell' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/funnel-chart.mdx b/src/markdown-pages/components/funnel-chart.mdx index dbe80d75c..90b96c553 100644 --- a/src/markdown-pages/components/funnel-chart.mdx +++ b/src/markdown-pages/components/funnel-chart.mdx @@ -3,5 +3,5 @@ path: '/components/funnel-chart' title: 'FunnelChart' description: 'A FunnelChart component!' component: 'FunnelChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/grid-item.mdx b/src/markdown-pages/components/grid-item.mdx index 88641ca9f..5215355f1 100644 --- a/src/markdown-pages/components/grid-item.mdx +++ b/src/markdown-pages/components/grid-item.mdx @@ -3,5 +3,5 @@ path: '/components/grid-item' title: 'GridItem' description: 'A GridItem component!' component: 'GridItem' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/grid.mdx b/src/markdown-pages/components/grid.mdx index f19509e9a..022f72d59 100644 --- a/src/markdown-pages/components/grid.mdx +++ b/src/markdown-pages/components/grid.mdx @@ -3,5 +3,5 @@ path: '/components/grid' title: 'Grid' description: 'A Grid component!' component: 'Grid' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/heading-text.mdx b/src/markdown-pages/components/heading-text.mdx index 656958969..2f9679784 100644 --- a/src/markdown-pages/components/heading-text.mdx +++ b/src/markdown-pages/components/heading-text.mdx @@ -3,6 +3,6 @@ path: '/components/heading-text' title: 'BlockText' description: 'A HeadingText component!' component: 'HeadingText' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/heatmap-component.mdx b/src/markdown-pages/components/heatmap-component.mdx index 3d82da12c..a06e16444 100644 --- a/src/markdown-pages/components/heatmap-component.mdx +++ b/src/markdown-pages/components/heatmap-component.mdx @@ -3,5 +3,5 @@ path: '/components/heatmap-chart' title: 'HeatmapChart' description: 'A HeatmapChart component!' component: 'HeatmapChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/histogram-chart.mdx b/src/markdown-pages/components/histogram-chart.mdx index dcf08050e..fb4a37563 100644 --- a/src/markdown-pages/components/histogram-chart.mdx +++ b/src/markdown-pages/components/histogram-chart.mdx @@ -3,5 +3,5 @@ path: '/components/histogram-chart' title: 'HistogramChart' description: 'A HistogramChart component!' component: 'HistogramChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/icon.mdx b/src/markdown-pages/components/icon.mdx index f25451ac5..7d9be685d 100644 --- a/src/markdown-pages/components/icon.mdx +++ b/src/markdown-pages/components/icon.mdx @@ -3,5 +3,5 @@ path: '/components/icon' title: 'Icon' description: 'An Icon component!' component: 'Icon' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/json-chart.mdx b/src/markdown-pages/components/json-chart.mdx index 9186803fa..ca6e1034d 100644 --- a/src/markdown-pages/components/json-chart.mdx +++ b/src/markdown-pages/components/json-chart.mdx @@ -3,5 +3,5 @@ path: '/components/json-chart' title: 'JsonChart' description: 'A JsonChart component!' component: 'JsonChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/line-chart.mdx b/src/markdown-pages/components/line-chart.mdx index bbce3fecb..d0bfe7a40 100644 --- a/src/markdown-pages/components/line-chart.mdx +++ b/src/markdown-pages/components/line-chart.mdx @@ -3,5 +3,5 @@ path: '/components/line-chart' title: 'LineChart' description: 'A LineChart component!' component: 'LineChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/link.mdx b/src/markdown-pages/components/link.mdx index 7e16c254c..e59f24826 100644 --- a/src/markdown-pages/components/link.mdx +++ b/src/markdown-pages/components/link.mdx @@ -3,5 +3,5 @@ path: '/components/link' title: 'Link' description: 'A Link component!' component: 'Link' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/list-item.mdx b/src/markdown-pages/components/list-item.mdx index fbd6ec4ab..d2562729d 100644 --- a/src/markdown-pages/components/list-item.mdx +++ b/src/markdown-pages/components/list-item.mdx @@ -3,5 +3,5 @@ path: '/components/list-item' title: 'ListItem' description: 'A ListItem component!' component: 'ListItem' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/list.mdx b/src/markdown-pages/components/list.mdx index 1bdc1c7d2..7d7013fa0 100644 --- a/src/markdown-pages/components/list.mdx +++ b/src/markdown-pages/components/list.mdx @@ -3,5 +3,5 @@ path: '/components/list' title: 'List' description: 'A List component!' component: 'List' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/metric-table-row-cell.mdx b/src/markdown-pages/components/metric-table-row-cell.mdx index 68dfda43b..105dae644 100644 --- a/src/markdown-pages/components/metric-table-row-cell.mdx +++ b/src/markdown-pages/components/metric-table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/metric-table-row-cell' title: 'MetricTableRowCell' description: 'A MetricTableRowCell component!' component: 'MetricTableRowCell' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/modal.mdx b/src/markdown-pages/components/modal.mdx index ce4bca859..992bd4bab 100644 --- a/src/markdown-pages/components/modal.mdx +++ b/src/markdown-pages/components/modal.mdx @@ -3,5 +3,5 @@ path: '/components/modal' title: 'Modal' description: 'A Modal component!' component: 'Modal' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/nerd-graph-mutation.mdx b/src/markdown-pages/components/nerd-graph-mutation.mdx index d24b29fa5..51324834e 100644 --- a/src/markdown-pages/components/nerd-graph-mutation.mdx +++ b/src/markdown-pages/components/nerd-graph-mutation.mdx @@ -3,5 +3,5 @@ path: '/components/nerd-graph-mutation' title: 'NerdGraphMutation' description: 'An NerdGraphMutation component!' component: 'NerdGraphMutation' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/nerd-graph-query.mdx b/src/markdown-pages/components/nerd-graph-query.mdx index 24896b91c..06040741d 100644 --- a/src/markdown-pages/components/nerd-graph-query.mdx +++ b/src/markdown-pages/components/nerd-graph-query.mdx @@ -3,5 +3,5 @@ path: '/components/nerd-graph-query' title: 'NerdGraphQuery' description: 'A NerdGraphQuery component!' component: 'NerdGraphQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/nerdlet-state-context.mdx b/src/markdown-pages/components/nerdlet-state-context.mdx index 921c256e5..20a842348 100644 --- a/src/markdown-pages/components/nerdlet-state-context.mdx +++ b/src/markdown-pages/components/nerdlet-state-context.mdx @@ -3,5 +3,5 @@ path: '/components/nerdlet-state-context' title: 'NerdletStateContext' description: 'A NerdletStateContext component!' component: 'NerdletStateContext' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/nrql-query.mdx b/src/markdown-pages/components/nrql-query.mdx index 8b35eed3b..2d90501e1 100644 --- a/src/markdown-pages/components/nrql-query.mdx +++ b/src/markdown-pages/components/nrql-query.mdx @@ -3,5 +3,5 @@ path: '/components/nrql-query' title: 'NrqlQuery' description: 'A NrqlQuery component!' component: 'NrqlQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/pie-chart.mdx b/src/markdown-pages/components/pie-chart.mdx index fcb5833c4..a3883d545 100644 --- a/src/markdown-pages/components/pie-chart.mdx +++ b/src/markdown-pages/components/pie-chart.mdx @@ -3,5 +3,5 @@ path: '/components/pie-chart' title: 'PieChart' description: 'A PieChart component!' component: 'PieChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/platform-state-context.mdx b/src/markdown-pages/components/platform-state-context.mdx index 2a7b842a1..6e0a48570 100644 --- a/src/markdown-pages/components/platform-state-context.mdx +++ b/src/markdown-pages/components/platform-state-context.mdx @@ -3,5 +3,5 @@ path: '/components/platform-state-context' title: 'PlatformStateContext' description: 'A PlatformStateContext component!' component: 'PlatformStateContext' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/radio-group.mdx b/src/markdown-pages/components/radio-group.mdx index 42031d34d..57ed827a1 100644 --- a/src/markdown-pages/components/radio-group.mdx +++ b/src/markdown-pages/components/radio-group.mdx @@ -3,5 +3,5 @@ path: '/components/radio-group' title: 'RadioGroup' description: 'A RadioGroup component!' component: 'RadioGroup' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/radio.mdx b/src/markdown-pages/components/radio.mdx index 0db2d51fa..fa5c46040 100644 --- a/src/markdown-pages/components/radio.mdx +++ b/src/markdown-pages/components/radio.mdx @@ -3,5 +3,5 @@ path: '/components/radio' title: 'Radio' description: 'A Radio component!' component: 'Radio' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/scatter-chart.mdx b/src/markdown-pages/components/scatter-chart.mdx index 7650fecc1..6d89580f0 100644 --- a/src/markdown-pages/components/scatter-chart.mdx +++ b/src/markdown-pages/components/scatter-chart.mdx @@ -3,5 +3,5 @@ path: '/components/scatter-chart' title: 'ScatterChart' description: 'A ScatterChart component!' component: 'ScatterChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/select-item.mdx b/src/markdown-pages/components/select-item.mdx index 6666be79e..39607c7b2 100644 --- a/src/markdown-pages/components/select-item.mdx +++ b/src/markdown-pages/components/select-item.mdx @@ -3,5 +3,5 @@ path: '/components/select-item' title: 'SelectItem' description: 'A SelectItem component!' component: 'SelectItem' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/select.mdx b/src/markdown-pages/components/select.mdx index 78a040c45..58b7b22eb 100644 --- a/src/markdown-pages/components/select.mdx +++ b/src/markdown-pages/components/select.mdx @@ -3,5 +3,5 @@ path: '/components/select' title: 'Select' description: 'A Select component!' component: 'Select' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/spacing.mdx b/src/markdown-pages/components/spacing.mdx index 8a6a94e6c..1a8cd9f4e 100644 --- a/src/markdown-pages/components/spacing.mdx +++ b/src/markdown-pages/components/spacing.mdx @@ -3,5 +3,5 @@ path: '/components/spacing' title: 'Spacing' description: 'A Spacing component!' component: 'Spacing' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/sparkline-chart.mdx b/src/markdown-pages/components/sparkline-chart.mdx index 7ef325910..5f3666610 100644 --- a/src/markdown-pages/components/sparkline-chart.mdx +++ b/src/markdown-pages/components/sparkline-chart.mdx @@ -3,5 +3,5 @@ path: '/components/sparkline-chart' title: 'SparklineChart' description: 'A SparklineChart component!' component: 'SparklineChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/sparkline-table-row-cell.mdx b/src/markdown-pages/components/sparkline-table-row-cell.mdx index 0b60674ce..4083f564a 100644 --- a/src/markdown-pages/components/sparkline-table-row-cell.mdx +++ b/src/markdown-pages/components/sparkline-table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/sparkline-table-row-cell' title: 'SparklineTableRowCell' description: 'A SparklineTableRowCell component!' component: 'SparklineTableRowCell' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/spinner.mdx b/src/markdown-pages/components/spinner.mdx index 2235eebd9..95119c473 100644 --- a/src/markdown-pages/components/spinner.mdx +++ b/src/markdown-pages/components/spinner.mdx @@ -3,5 +3,5 @@ path: '/components/spinner' title: 'Spinner' description: 'A Spinner component!' component: 'Spinner' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/stack-item.mdx b/src/markdown-pages/components/stack-item.mdx index f5e1358e4..febc160a4 100644 --- a/src/markdown-pages/components/stack-item.mdx +++ b/src/markdown-pages/components/stack-item.mdx @@ -3,5 +3,5 @@ path: '/components/stack-item' title: 'StackItem' description: 'A StackItem component!' component: 'StackItem' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/stack.mdx b/src/markdown-pages/components/stack.mdx index 792f85bbb..75dafeeb9 100644 --- a/src/markdown-pages/components/stack.mdx +++ b/src/markdown-pages/components/stack.mdx @@ -3,5 +3,5 @@ path: '/components/stack' title: 'Stack' description: 'A Stack component!' component: 'Stack' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/stacked-bar-chart.mdx b/src/markdown-pages/components/stacked-bar-chart.mdx index 756778b41..46699747f 100644 --- a/src/markdown-pages/components/stacked-bar-chart.mdx +++ b/src/markdown-pages/components/stacked-bar-chart.mdx @@ -3,5 +3,5 @@ path: '/components/stacked-bar-chart' title: 'StackedBarChart' description: 'A StackedBarChart component!' component: 'StackedBarChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/table-chart.mdx b/src/markdown-pages/components/table-chart.mdx index ebb88840e..c969704e7 100644 --- a/src/markdown-pages/components/table-chart.mdx +++ b/src/markdown-pages/components/table-chart.mdx @@ -3,5 +3,5 @@ path: '/components/table-chart' title: 'TableChart' description: 'A TableChart component!' component: 'TableChart' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/table-header-cell.mdx b/src/markdown-pages/components/table-header-cell.mdx index 2ed6259cb..10e1c37f9 100644 --- a/src/markdown-pages/components/table-header-cell.mdx +++ b/src/markdown-pages/components/table-header-cell.mdx @@ -3,5 +3,5 @@ path: '/components/table-header-cell' title: 'TableHeaderCell' description: 'A TableHeaderCell component!' component: 'TableHeaderCell' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/table-header.mdx b/src/markdown-pages/components/table-header.mdx index 6e62f10bf..c957ad91c 100644 --- a/src/markdown-pages/components/table-header.mdx +++ b/src/markdown-pages/components/table-header.mdx @@ -3,5 +3,5 @@ path: '/components/table-header' title: 'TableHeader' description: 'A TableHeader component!' component: 'TableHeader' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/table-row-cell.mdx b/src/markdown-pages/components/table-row-cell.mdx index 024b64aae..e03a0e85e 100644 --- a/src/markdown-pages/components/table-row-cell.mdx +++ b/src/markdown-pages/components/table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/table-row-cell' title: 'TableRowCell' description: 'A TableRowCell component!' component: 'TableRowCell' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/table-row.mdx b/src/markdown-pages/components/table-row.mdx index 00680840a..65a59d016 100644 --- a/src/markdown-pages/components/table-row.mdx +++ b/src/markdown-pages/components/table-row.mdx @@ -3,5 +3,5 @@ path: '/components/table-row' title: 'TableRow' description: 'A TableRow component!' component: 'TableRow' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/table.mdx b/src/markdown-pages/components/table.mdx index aa8f35ed8..5ea515e23 100644 --- a/src/markdown-pages/components/table.mdx +++ b/src/markdown-pages/components/table.mdx @@ -3,5 +3,5 @@ path: '/components/table' title: 'Table' description: 'A Table component!' component: 'Table' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/tabs-item.mdx b/src/markdown-pages/components/tabs-item.mdx index 9a61ae2e1..64ecb489b 100644 --- a/src/markdown-pages/components/tabs-item.mdx +++ b/src/markdown-pages/components/tabs-item.mdx @@ -3,5 +3,5 @@ path: '/components/tabs-item' title: 'TabsItem' description: 'A TabsItem component!' component: 'TabsItem' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/tabs.mdx b/src/markdown-pages/components/tabs.mdx index 1cac27567..8901e0891 100644 --- a/src/markdown-pages/components/tabs.mdx +++ b/src/markdown-pages/components/tabs.mdx @@ -3,5 +3,5 @@ path: '/components/tabs' title: 'Tabs' description: 'A Tabs component!' component: 'Tabs' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/text-field.mdx b/src/markdown-pages/components/text-field.mdx index d86bb6cbd..fd3731437 100644 --- a/src/markdown-pages/components/text-field.mdx +++ b/src/markdown-pages/components/text-field.mdx @@ -3,5 +3,5 @@ path: '/components/text-field' title: 'TextField' description: 'A TextField component!' component: 'TextField' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/toast.mdx b/src/markdown-pages/components/toast.mdx index 2e7424bd8..fab4b9eee 100644 --- a/src/markdown-pages/components/toast.mdx +++ b/src/markdown-pages/components/toast.mdx @@ -3,5 +3,5 @@ path: '/components/toast' title: 'Toast' description: 'A Toast component!' component: 'Toast' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/tooltip.mdx b/src/markdown-pages/components/tooltip.mdx index 7315e9d45..7bea1e2d8 100644 --- a/src/markdown-pages/components/tooltip.mdx +++ b/src/markdown-pages/components/tooltip.mdx @@ -3,5 +3,5 @@ path: '/components/tooltip' title: 'Tooltip' description: 'A Tooltip component!' component: 'Tooltip' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/user-query.mdx b/src/markdown-pages/components/user-query.mdx index d585e08ed..a61162496 100644 --- a/src/markdown-pages/components/user-query.mdx +++ b/src/markdown-pages/components/user-query.mdx @@ -3,5 +3,5 @@ path: '/components/user-query' title: 'UserQuery' description: 'An UserQuery component!' component: 'UserQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/user-storage-mutation.mdx b/src/markdown-pages/components/user-storage-mutation.mdx index 1259a5243..5fa1c7fba 100644 --- a/src/markdown-pages/components/user-storage-mutation.mdx +++ b/src/markdown-pages/components/user-storage-mutation.mdx @@ -3,5 +3,5 @@ path: '/components/user-storage-mutation' title: 'UserStorageMutation' description: 'A UserStorageMutation component!' component: 'UserStorageMutation' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/user-storage-query.mdx b/src/markdown-pages/components/user-storage-query.mdx index eb30a7dbc..c77d7fbff 100644 --- a/src/markdown-pages/components/user-storage-query.mdx +++ b/src/markdown-pages/components/user-storage-query.mdx @@ -3,5 +3,5 @@ path: '/components/user-storage-query' title: 'UserStorageQuery' description: 'A UserStorageQuery component!' component: 'UserStorageQuery' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/markdown-pages/components/user-table-row-cell.mdx b/src/markdown-pages/components/user-table-row-cell.mdx index 123dd20e8..ab6642f60 100644 --- a/src/markdown-pages/components/user-table-row-cell.mdx +++ b/src/markdown-pages/components/user-table-row-cell.mdx @@ -3,5 +3,5 @@ path: '/components/user-table-row-cell' title: 'UserTableRowCell' description: 'A UserTableRowCell component!' component: 'UserTableRowCell' -template: 'ComponentDocTemplate' +template: 'ComponentReferenceTemplate' --- diff --git a/src/templates/ApiDocTemplate.js b/src/templates/ApiReferenceTemplate.js similarity index 94% rename from src/templates/ApiDocTemplate.js rename to src/templates/ApiReferenceTemplate.js index 0f5840ab5..cdb0d9306 100644 --- a/src/templates/ApiDocTemplate.js +++ b/src/templates/ApiReferenceTemplate.js @@ -13,7 +13,7 @@ import pages from '../data/sidenav.json'; import templateStyles from './ReferenceTemplate.module.scss'; import useApiDoc from '../hooks/useApiDoc'; -const ApiDocTemplate = ({ data }) => { +const ApiReferenceTemplate = ({ data }) => { const [isOpen, setIsOpen] = useState(false); const { mdx } = data; const { frontmatter } = mdx; @@ -59,7 +59,7 @@ const ApiDocTemplate = ({ data }) => { ); }; -ApiDocTemplate.propTypes = { +ApiReferenceTemplate.propTypes = { data: PropTypes.object, }; @@ -77,4 +77,4 @@ export const pageQuery = graphql` } `; -export default ApiDocTemplate; +export default ApiReferenceTemplate; diff --git a/src/templates/ComponentDocTemplate.js b/src/templates/ComponentReferenceTemplate.js similarity index 94% rename from src/templates/ComponentDocTemplate.js rename to src/templates/ComponentReferenceTemplate.js index a5f9d3f3e..5ba7a76b2 100644 --- a/src/templates/ComponentDocTemplate.js +++ b/src/templates/ComponentReferenceTemplate.js @@ -12,7 +12,7 @@ import Sidebar from '../components/Sidebar'; import SEO from '../components/Seo'; import PropList from '../components/PropList'; import pages from '../data/sidenav.json'; -import styles from './ComponentDocTemplate.module.scss'; +import styles from './ComponentReferenceTemplate.module.scss'; import templateStyles from './ReferenceTemplate.module.scss'; import useComponentDoc from '../hooks/useComponentDoc'; @@ -22,7 +22,7 @@ const previewStyles = { }, }; -const ComponentDocTemplate = ({ data }) => { +const ComponentReferenceTemplate = ({ data }) => { const [isOpen, setIsOpen] = useState(false); const { mdx } = data; const { frontmatter } = mdx; @@ -97,7 +97,7 @@ const ComponentDocTemplate = ({ data }) => { ); }; -ComponentDocTemplate.propTypes = { +ComponentReferenceTemplate.propTypes = { data: PropTypes.object, }; @@ -115,4 +115,4 @@ export const pageQuery = graphql` } `; -export default ComponentDocTemplate; +export default ComponentReferenceTemplate; diff --git a/src/templates/ComponentDocTemplate.module.scss b/src/templates/ComponentReferenceTemplate.module.scss similarity index 100% rename from src/templates/ComponentDocTemplate.module.scss rename to src/templates/ComponentReferenceTemplate.module.scss From 6458b2fe0743231843a551c057301eac11bc3d19 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 18:02:28 -0700 Subject: [PATCH 12/14] refactor: Move destructure inline --- src/templates/ComponentReferenceTemplate.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/templates/ComponentReferenceTemplate.js b/src/templates/ComponentReferenceTemplate.js index 5ba7a76b2..3ea53835f 100644 --- a/src/templates/ComponentReferenceTemplate.js +++ b/src/templates/ComponentReferenceTemplate.js @@ -27,15 +27,13 @@ const ComponentReferenceTemplate = ({ data }) => { const { mdx } = data; const { frontmatter } = mdx; const { title, description, component } = frontmatter; - const componentDoc = useComponentDoc(component); - const { examples = [], description: componentDescription, methods = [], usage = '', propTypes = [], - } = componentDoc ?? {}; + } = useComponentDoc(component) ?? {}; return ( From 2aaaf3e72f57fed1f10caa0d9d21615588555bc9 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 5 Jun 2020 18:11:46 -0700 Subject: [PATCH 13/14] refactor: Rename ComponentExample -> ReferenceExample --- src/components/ComponentPreview.js | 8 ++++---- src/components/MethodReference.js | 6 +++--- .../{ComponentExample.js => ReferenceExample.js} | 8 ++++---- ...ntExample.module.scss => ReferenceExample.module.scss} | 0 src/templates/ComponentReferenceTemplate.js | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) rename src/components/{ComponentExample.js => ReferenceExample.js} (93%) rename src/components/{ComponentExample.module.scss => ReferenceExample.module.scss} (100%) diff --git a/src/components/ComponentPreview.js b/src/components/ComponentPreview.js index ee2896050..e10041d87 100644 --- a/src/components/ComponentPreview.js +++ b/src/components/ComponentPreview.js @@ -5,7 +5,7 @@ import { LivePreview } from 'react-live'; import { CSS_BUNDLE } from '../utils/sdk'; const EXAMPLE_CSS = ` -.nr1-ComponentExample { +.nr1-ReferenceExample { line-height: 1.36; font-weight: 400; background-color: #fff; @@ -14,7 +14,7 @@ const EXAMPLE_CSS = ` font-family: Open Sans,Segoe UI,Tahoma,sans-serif; } -.nr1-ComponentExample-ToastManager > div { +.nr1-ReferenceExample-ToastManager > div { position: fixed; top: 0; right: 0; @@ -99,12 +99,12 @@ const ComponentPreview = ({ className, style, useToastManager }) => { /> {useToastManager && ( -
+
)} {stylesLoaded ? ( - + ) : ( 'Loading...' )} diff --git a/src/components/MethodReference.js b/src/components/MethodReference.js index 42c1b420a..534a319e4 100644 --- a/src/components/MethodReference.js +++ b/src/components/MethodReference.js @@ -1,6 +1,6 @@ import React from 'react'; import PropTypes from 'prop-types'; -import ComponentExample from './ComponentExample'; +import ReferenceExample from './ReferenceExample'; import FunctionDefinition from './FunctionDefinition'; import Markdown from 'react-markdown'; import styles from './MethodReference.module.scss'; @@ -14,7 +14,7 @@ const MethodReference = ({ className, method }) => ( returnValue={method.returnValue} /> {method.examples.map((example, i) => ( - + ))}
); @@ -26,7 +26,7 @@ MethodReference.propTypes = { description: PropTypes.string, params: FunctionDefinition.propTypes.params, returnValue: FunctionDefinition.propTypes.returnValue, - examples: PropTypes.arrayOf(ComponentExample.propTypes.example), + examples: PropTypes.arrayOf(ReferenceExample.propTypes.example), }), }; diff --git a/src/components/ComponentExample.js b/src/components/ReferenceExample.js similarity index 93% rename from src/components/ComponentExample.js rename to src/components/ReferenceExample.js index 0d2c96f34..97433f71f 100644 --- a/src/components/ComponentExample.js +++ b/src/components/ReferenceExample.js @@ -3,7 +3,7 @@ import PropTypes from 'prop-types'; import formatCode from '../utils/formatCode'; import github from 'prism-react-renderer/themes/github'; import { LiveEditor, LiveError, LiveProvider } from 'react-live'; -import styles from './ComponentExample.module.scss'; +import styles from './ReferenceExample.module.scss'; import ComponentPreview from './ComponentPreview'; const platformStateContextMock = { @@ -20,7 +20,7 @@ const nerdletStateContextMock = { const TRAILING_SEMI = /;\s*$/; -const ComponentExample = ({ +const ReferenceExample = ({ className, example, useToastManager, @@ -72,7 +72,7 @@ const ComponentExample = ({ ); }; -ComponentExample.propTypes = { +ReferenceExample.propTypes = { className: PropTypes.string, example: PropTypes.shape({ label: PropTypes.string.isRequired, @@ -83,4 +83,4 @@ ComponentExample.propTypes = { previewStyle: PropTypes.object, }; -export default ComponentExample; +export default ReferenceExample; diff --git a/src/components/ComponentExample.module.scss b/src/components/ReferenceExample.module.scss similarity index 100% rename from src/components/ComponentExample.module.scss rename to src/components/ReferenceExample.module.scss diff --git a/src/templates/ComponentReferenceTemplate.js b/src/templates/ComponentReferenceTemplate.js index 3ea53835f..1c88795ee 100644 --- a/src/templates/ComponentReferenceTemplate.js +++ b/src/templates/ComponentReferenceTemplate.js @@ -5,7 +5,7 @@ import PropTypes from 'prop-types'; import InlineCodeSnippet from '../components/InlineCodeSnippet'; import ReactMarkdown from 'react-markdown'; import Container from '../components/Container'; -import ComponentExample from '../components/ComponentExample'; +import ReferenceExample from '../components/ReferenceExample'; import Layout from '../components/Layout'; import MethodReference from '../components/MethodReference'; import Sidebar from '../components/Sidebar'; @@ -64,7 +64,7 @@ const ComponentReferenceTemplate = ({ data }) => {

Examples

{examples.map((example, i) => ( - Date: Fri, 5 Jun 2020 18:16:42 -0700 Subject: [PATCH 14/14] refactor: Rename ComponentPreview -> ReferencePreview --- src/components/ReferenceExample.js | 4 ++-- src/components/{ComponentPreview.js => ReferencePreview.js} | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) rename src/components/{ComponentPreview.js => ReferencePreview.js} (94%) diff --git a/src/components/ReferenceExample.js b/src/components/ReferenceExample.js index 97433f71f..02b79e5f9 100644 --- a/src/components/ReferenceExample.js +++ b/src/components/ReferenceExample.js @@ -4,7 +4,7 @@ import formatCode from '../utils/formatCode'; import github from 'prism-react-renderer/themes/github'; import { LiveEditor, LiveError, LiveProvider } from 'react-live'; import styles from './ReferenceExample.module.scss'; -import ComponentPreview from './ComponentPreview'; +import ReferencePreview from './ReferencePreview'; const platformStateContextMock = { timeRange: { @@ -57,7 +57,7 @@ const ReferenceExample = ({ disabled={!live} > {live && ( - { +const ReferencePreview = ({ className, style, useToastManager }) => { const [stylesLoaded, setStylesLoaded] = useState(false); const { ToastManager } = window.__NR1_SDK__; @@ -112,10 +112,10 @@ const ComponentPreview = ({ className, style, useToastManager }) => { ); }; -ComponentPreview.propTypes = { +ReferencePreview.propTypes = { className: PropTypes.string, style: PropTypes.object, useToastManager: PropTypes.bool, }; -export default ComponentPreview; +export default ReferencePreview;