Skip to content

Commit

Permalink
Merge pull request #1070 from newrelic/tglaser/update-component-docs-…
Browse files Browse the repository at this point in the history
…version

Update component docs version
  • Loading branch information
jerelmiller authored Jan 27, 2021
2 parents 040bca9 + eeff6e7 commit d9f5036
Show file tree
Hide file tree
Showing 20 changed files with 174 additions and 6 deletions.
2 changes: 1 addition & 1 deletion gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ module.exports = {
{
resolve: 'gatsby-source-newrelic-sdk',
options: {
release: 'release-1339',
release: 'release-2046',
},
},
'gatsby-plugin-meta-redirect',
Expand Down
14 changes: 13 additions & 1 deletion plugins/gatsby-source-newrelic-sdk/src/constants.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module.exports.BASE_URL =
'//hypertext-sandbox.nr-assets.net/wanda--wanda-ec-ui--nr1-docs';
'https://d1zobbh8kytrtv.cloudfront.net/platform/wanda--wanda-ec-ui--nr1-docs';

module.exports.DOCUMENTED_APIS = ['logger', 'navigation', 'nerdlet'];
module.exports.DOCUMENTED_COMPONENTS = [
Expand All @@ -9,6 +9,7 @@ module.exports.DOCUMENTED_COMPONENTS = [
'AccountStorageQuery',
'AreaChart',
'AutoSizer',
'Badge',
'BarChart',
'BillboardChart',
'BlockText',
Expand All @@ -20,6 +21,7 @@ module.exports.DOCUMENTED_COMPONENTS = [
'Checkbox',
'Dropdown',
'DropdownItem',
'DropdownSection',
'EntitiesByDomainTypeQuery',
'EntitiesByGuidsQuery',
'EntitiesByNameQuery',
Expand All @@ -29,6 +31,7 @@ module.exports.DOCUMENTED_COMPONENTS = [
'EntityStorageMutation',
'EntityStorageQuery',
'EntityTitleTableRowCell',
'FavoriteTableRowCell',
'FunnelChart',
'Grid',
'GridItem',
Expand All @@ -37,21 +40,29 @@ module.exports.DOCUMENTED_COMPONENTS = [
'HistogramChart',
'Icon',
'JsonChart',
'Layout',
'LayoutItem',
'LineChart',
'Link',
'List',
'ListItem',
'MetricTableRowCell',
'Modal',
'MultilineTextField',
'NerdGraphMutation',
'NerdGraphQuery',
'NerdletStateContext',
'NrqlQuery',
'PieChart',
'PlatformStateContext',
'Popover',
'PopoverBody',
'PopoverTrigger',
'Radio',
'RadioGroup',
'ScatterChart',
'SegmentedControl',
'SegmentedControlItem',
'Select',
'SelectItem',
'Spacing',
Expand All @@ -61,6 +72,7 @@ module.exports.DOCUMENTED_COMPONENTS = [
'Stack',
'StackedBarChart',
'StackItem',
'Switch',
'Table',
'TableChart',
'TableHeader',
Expand Down
9 changes: 8 additions & 1 deletion plugins/gatsby-source-newrelic-sdk/src/getExamples.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
const IGNORED_PREVIEWS = ['Dropdown', 'Modal', 'Tooltip'];
const IGNORED_PREVIEWS = [
'Dropdown',
'Modal',
'Popover',
'Toast',
'Tooltip',
'Select',
];

module.exports = (name, obj) => {
const docs = obj[name].__docs__ || {};
Expand Down
2 changes: 1 addition & 1 deletion plugins/gatsby-source-newrelic-sdk/src/loadSdk.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const vm = require('vm');
const fetch = require('node-fetch');

const BASE_URL =
'https://hypertext-sandbox.nr-assets.net/wanda--wanda-ec-ui--nr1-docs';
'https://d1zobbh8kytrtv.cloudfront.net/platform/wanda--wanda-ec-ui--nr1-docs';

const getBundle = (cache) => async (src) => {
const script = await cache.get(src);
Expand Down
5 changes: 5 additions & 0 deletions plugins/gatsby-source-newrelic-sdk/src/mockGlobals.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,16 @@ global.CSSStyleDeclaration = {
};
global.navigator = {
userAgent: '',
platform: '',
};
global.removeEventListener = noop;
global.addEventListener = noop;
global.requestAnimationFrame = noop;
global.cancelAnimationFrame = noop;
global.XMLHttpRequest = {};
global.crypto = {
getRandomValues: () => [],
};
global.document = {
cookie: '',
getElementsByTagName() {
Expand Down
2 changes: 1 addition & 1 deletion src/components/ReferencePreview.js
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ const EXAMPLE_CSS = `

const ReferencePreview = ({ className, style, useToastManager }) => {
const [stylesLoaded, setStylesLoaded] = useState(false);
const { ToastManager } = window.__NR1_SDK__;
const { ToastManager } = window.__NR1_SDK__.default;
const { newRelicSdk } = useStaticQuery(graphql`
query {
newRelicSdk {
Expand Down
53 changes: 53 additions & 0 deletions src/data/sidenav.json
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,14 @@
"displayName": "DropdownItem",
"url": "/components/dropdown-item"
},
{
"displayName": "DropdownSection",
"url": "/components/dropdown-section"
},
{
"displayName": "MultilineTextField",
"url": "/components/multiline-text-field"
},
{
"displayName": "Radio",
"url": "/components/radio"
Expand All @@ -251,6 +259,14 @@
"displayName": "RadioGroup",
"url": "/components/radio-group"
},
{
"displayName": "SegmentedControl",
"url": "/components/segmented-control"
},
{
"displayName": "SegmentedControlItem",
"url": "/components/segmented-control-item"
},
{
"displayName": "Select",
"url": "/components/select"
Expand All @@ -259,6 +275,10 @@
"displayName": "SelectItem",
"url": "/components/select-item"
},
{
"displayName": "Switch",
"url": "/components/switch"
},
{
"displayName": "TextField",
"url": "/components/text-field"
Expand Down Expand Up @@ -292,6 +312,10 @@
"displayName": "EntityTitleTableRowCell",
"url": "/components/entity-title-table-row-cell"
},
{
"displayName": "FavoriteTableRowCell",
"url": "/components/favorite-table-row-cell"
},
{
"displayName": "MetricTableRowCell",
"url": "/components/metric-table-row-cell"
Expand Down Expand Up @@ -323,13 +347,34 @@
}
]
},
{
"displayName": "Indicators",
"children": [
{
"displayName": "Badge",
"url": "/components/badge"
}
]
},
{
"displayName": "Overlays",
"children": [
{
"displayName": "Modal",
"url": "/components/modal"
},
{
"displayName": "Popover",
"url": "/components/popover"
},
{
"displayName": "PopoverBody",
"url": "/components/popover-body"
},
{
"displayName": "PopoverTrigger",
"url": "/components/popover-trigger"
},
{
"displayName": "Tooltip",
"url": "/components/tooltip"
Expand Down Expand Up @@ -363,6 +408,14 @@
"displayName": "GridItem",
"url": "/components/grid-item"
},
{
"displayName": "Layout",
"url": "/components/layout"
},
{
"displayName": "LayoutItem",
"url": "/components/layout-item"
},
{
"displayName": "List",
"url": "/components/list"
Expand Down
9 changes: 8 additions & 1 deletion src/hooks/useComponentDoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@ import { useMemo } from 'react';
import { getPropTypeDefinition } from '../utils/propTypeInfo';
import { getTypeDefs } from '../utils/typeDefs';

const IGNORED_LIVE_EXAMPLES = ['Dropdown', 'Modal', 'Tooltip', 'Select'];
const IGNORED_LIVE_EXAMPLES = [
'Dropdown',
'Modal',
'Popover',
'Toast',
'Tooltip',
'Select',
];

const IGNORED_METHODS = [
'prototype',
Expand Down
7 changes: 7 additions & 0 deletions src/markdown-pages/components/badge.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/badge'
title: 'Badge'
description: 'A Badge component!'
component: 'Badge'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/dropdown-section.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/dropdown-section'
title: 'DropdownSection'
description: 'A DropdownSection component!'
component: 'DropdownSection'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/favorite-table-row-cell.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/favorite-table-row-cell'
title: 'FavoriteTableRowCell'
description: 'An FavoriteTableRowCell component!'
component: 'FavoriteTableRowCell'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/layout-item.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/layout-item'
title: 'LayoutItem'
description: 'A LayoutItem component!'
component: 'LayoutItem'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/layout.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/layout'
title: 'Layout'
description: 'A Layout component!'
component: 'Layout'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/multiline-text-field.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/multiline-text-field'
title: 'MultilineTextField'
description: 'A MultilineTextField component!'
component: 'MultilineTextField'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/popover-body.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/popover-body'
title: 'PopoverBody'
description: 'A PopoverBody component!'
component: 'PopoverBody'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/popover-trigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/popover-trigger'
title: 'PopoverTrigger'
description: 'A PopoverTrigger component!'
component: 'PopoverTrigger'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/popover.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/popover'
title: 'Popover'
description: 'A Popover component!'
component: 'Popover'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/segmented-control-item.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/segmented-control-item'
title: 'SegmentedControlItem'
description: 'A SegmentedControlItem component!'
component: 'SegmentedControlItem'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/segmented-control.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/segmented-control'
title: 'SegmentedControl'
description: 'A SegmentedControl component!'
component: 'SegmentedControl'
template: 'ComponentReferenceTemplate'
---
7 changes: 7 additions & 0 deletions src/markdown-pages/components/switch.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
path: '/components/switch'
title: 'Switch'
description: 'A Switch component!'
component: 'Switch'
template: 'ComponentReferenceTemplate'
---

0 comments on commit d9f5036

Please sign in to comment.