This theme contains contains common configuration and shared components used across New Relic Gatsby sites. It is primarily used on the developer and open source websites.
-
gatsby-theme-newrelic
- Installation
- Configuration
-
Components
Banner
Button
Callout
CodeBlock
Collapser
CollapserGroup
ContributingGuidelines
CreateIssueButton
DarkModeToggle
-
Dropdown
ExternalLink
EditPageButton
FeatherSVG
-
GitHubIssueButton
GlobalFooter
GlobalHeader
HamburgerMenu
-
Icon
-
Layout
Link
MarkdownContainer
-
MDX
MDXCodeBlock
Navigation
-
NavItem
NewRelicLogo
- Overlay
-
PageTools
- Portal
RelatedResources
SearchInput
SkewedContainer
SEO
Side
SideBySide
SimpleFeedback
Spinner
Skeleton
SplitColorButton
Steps
Step
Surface
Table
TableOfContents
Tag
TagList
Terminal
TextHighlight
Video
- MDX Component variants
- Hooks
- I18n
- Announcements
- Utils
- Testing
gatsby-theme-newrelic
uses Emotion for styling and
depends on its packages. To install this package, add the
@newrelic/gatsby-theme-newrelic
package and required Emotion packages.
npm:
npm install @newrelic/gatsby-theme-newrelic @emotion/core @emotion/styled @mdx-js/mdx @mdx-js/react @splitsoftware/splitio-react gatsby-plugin-mdx
yarn:
yarn add @newrelic/gatsby-theme-newrelic @emotion/core @emotion/styled @mdx-js/mdx @mdx-js/react @splitsoftware/splitio-react gatsby-plugin-mdx
You can configure gatsby-theme-newrelic
using the following configuration
options:
// gatsby-config.js
module.exports = {
siteMetadata: {
siteUrl: 'https://developer.newrelic.com',
repository: 'https://github.com/newrelic/gatsby-theme-newrelic',
branch: 'main',
utmSource: 'developer-site',
},
plugins: [
{
resolve: '@newrelic/gatsby-theme-newrelic',
options: {
sitemap: true,
layout: {
contentPadding: '2rem',
maxWidth: '1600px',
},
newrelic: {
configs: {
staging: {
instrumentationType: 'proAndSPA',
accountId: '1234',
trustKey: '1',
agentID: '1234',
licenseKey: 'your-license-key',
applicationID: '1234',
},
production: {
instrumentationType: 'proAndSPA',
accountId: '1234',
trustKey: '1',
agentID: '1234',
licenseKey: 'your-license-key',
applicationID: '12345',
},
},
},
i18n: {
translationsPath: `${__dirname}/src/i18n/translations`,
additionalLocales: ['jp'],
}
robots: {
policy: [{ userAgent: '*', allow: '/' }],
},
splitio: {
core: {
authorizationKey: 'my-auth-key',
},
},
relatedResources: {
labels: {
'https://my.website': 'my-website'
},
}
},
},
],
};
gatsby-theme-newrelic
makes use of several siteMetadata
options. While these
are optional, they are highly recommended.
-
siteUrl
: Production URL for the site (e.g.https://developer.newrelic.com
) -
repository
: The URL for the public GitHub repository hosting the source code for the site. -
branch
: The mainline branch for use when constructing "Edit this page" links (defaults tomain
). to various mediums within New Relic. -
contributingUrl
: The URL where a user can find contributing guidelines for the site. If this is not specified, it defaults to theCONTRIBUTING.md
file in the repo and branch specified in thesiteMetadata
. If therepository
is not specified, this will returnnull
. Set this value tonull
to disable the default behavior.
Toggles the automatic creation of a sitemap. Set this value to
false
to disable sitemaps.
Default: true
Configuration for
gatsby-plugin-newrelic
.
For more details on the available configuration options, visit the
documentation.
Default: null
Configuration for
gatsby-plugin-robots-txt
.
These options will be shallow merged with the default value. For more details on
the available configuration options, visit the
documentation.
Default: { policy: [{ userAgent: '*', allow: '/' }] }
Optional configuration for related resources used in the right rail. Currently
only Mdx
nodes are supported.
The related resources component is controlled by specific front matter slugs
that are defined on a page by setting the front matter for resources
. If no
resources are available in the page front matter, the component will backfill
use the related resource items using Swiftype. See the swiftype
options below
for more information on customizing the search behavior.
In short, the order of priority for populating content is driven by:
- Resources defined via the
resources
front matter item. - Resources defined from executing a Swiftype search for the page.
Options:
-
labels
(object): Map of URLs to their label. This is used to match results displayed in the right rail with the label in the tag displayed underneath the link. Use this to add additional labels not covered by the default set of labels. -
swiftype
(object | false): Configuration used for fetching results from Swiftype for anMdx
node. Set this tofalse
(the default) to disable fetching related resources through Swiftype. If this is disabled, related resources can only be sourced via front matter. If enabled, this takes the following configuration:-
resultsPath
(string) required: Path to the file where Swiftype results will be stored. If therefetch
option is set tofalse
(the default), this file will be used to read related resource values for eachMdx
node. This file is only written to whenrefetch
is set totrue
. -
refetch
(boolean): Determines whether to refetch results from Swiftype for everyMdx
node during a build. It's a good idea to only set this on a special build (e.g. a build that happens on a cron job) so that Swiftype is not searched on development or every build on the site.-
Default:
false
-
Default:
-
engineKey
(string) required: Swiftype's engine key used to fetch results from a Swiftype search engine. -
getSlug
(function): Function to get the slug for anMdx
node. Useful if the slug is set from something other than the filesystem. By default, this will use thecreateFilePath
helper to generate the slug for theMdx
node. This function should accept an object as its only argument with a key ofnode
(i.e.getSlug: ({ node }) => { /* do something */ }
) -
filter
(function): Function to determine whether Swfitype should be queried for theMdx
node. Useful if you only need to get related resources for a subset of nodes on the site. By default, allMdx
nodes are fetched. This function should accept an object as its only argument with a key ofnode
and a key ofslug
(i.e.filter: ({ node, slug }) => { /* do something */ }
). -
getParams
(function): Function that allows you to specify additional params passed to Swiftype when running a search query. Useful if you want to provide additional filters or field boosts. This function should accept an object as its only argument with a key ofnode
and a key ofslug
. -
limit
(integer): The limit of related resources that should be fetched from Swiftype.-
Default:
5
-
Default:
-
Optional function to determine the environment. Useful to provide a fine-tuned environment name for environment-specific configuration.
Default:
const defaultResolveEnv = () =>
process.env.GATSBY_NEWRELIC_ENV ||
process.env.GATSBY_ACTIVE_ENV ||
process.env.NODE_ENV ||
'development';
Optional configuration for internationalization (i18n).
-
additionalLocales
: Additional supported for languages other than English (the default language). Currently supportsjp
. -
translationsPath
: The directory path where the translations will be stored. -
i18nextOptions
: Additional options to pass intoi18next
that will override the defaults.
These values are used to generate locale-specific pages and to populate a dropdown in the <GlobalHeader />
component.
Example
{
i18n: {
additionalLocales: ['jp'];
}
}
Configuration for the layout.
Options:
-
maxWidth
(string): Sets the max width of the layout. Accepts any CSS sizing value (e.g.1280px
). -
contentPadding
(string): Sets the padding value for the content. Accepts any CSS sizing value (e.g.2rem
)
Default: { maxWidth: null, contentPadding: null }
Layout configuration is available in the GraphQL schema which can be queried
within the Site
type. This is useful when you have other layout elements that
need to use the layout configuration.
query {
site {
layout {
maxWidth
contentPadding
}
}
}
These values are also available as global CSS variables. You can access them as:
-
maxWidth
:var(--site-max-width)
-
contentPadding
:var(--site-content-padding)
Configuration for the prismjs library. This library
powers the syntax highlighting used in the CodeBlock
component.
Options:
-
languages
([string]): Configure additional languages used for syntax highlighting. These languages will be appended to the list of default supported languages in the theme. For a full list of supported languages, visit the prism documentation.
Default supported languages:
css
graphql
hcl
javascript
json
jsx
ruby
shell
sql
sass
scss
Example: Add swift
as a supported language
module.exports = {
plugins: [
{
resolve: '@newrelic/gatsby-theme-newrelic',
options: {
prism: {
languages: ['swift'],
},
},
},
],
};
Configuration for using split.io with the Gatsby site. For more information on all the available configuration options, visit the split.io SDK docs.
Default:
const DEFAULT_CONFIG = {
core: {
trafficType: 'user',
},
};
NOTE: The core.key
configuration option is generated by the theme and
Required configuration for using the <SignUpModal />
in the <GlobalHeader />
component. If the GlobalHeader
is not being used, this configuration is not required.
module.exports = {
plugins: [
{
resolve: '@newrelic/gatsby-theme-newrelic',
options: {
signup: {
environment: process.env.ENVIRONMENT || 'staging',
signupUrl: '<signup receiver url>',
reCaptchaToken: '<token value>',
},
},
},
],
};
Use the env
option to define environment-specific configuration. The
environment configuration will be merged with the top-level configuration.
module.exports = {
plugins: [
{
resolve: '@newrelic/gatsby-theme-newrelic',
options: {
splitio: {
core: {
trafficType: 'user',
},
env: {
development: {
core: {
authorizationKey: 'my-development-key',
},
},
production: {
core: {
authorizationKey: 'my-prod-key',
},
},
},
},
},
},
],
};
The env
key will be taken from process.env.GATSBY_ACTIVE_ENV
first (see
Gatsby environment
variables for more
information on this variable), falling back to process.env.NODE_ENV
. When this
is not available, then it defaults to development
.
You can resolve the env
by using the resolveEnv
function:
module.exports = {
plugins: [
{
resolve: '@newrelic/gatsby-theme-newrelic',
options: {
splitio: {
// ...
resolveEnv: () => process.env.BUILD_ENV,
},
},
},
],
};
Configure the name reported to NerdGraph in the NewRelic-Requesting-Services
header.
The value should be formatted like a slug, dash-separated and all lowercase, like 'io-website'
.
This header is only used in the call to check the current user's logged in status.
Currently, the useLoggedIn
hook is the only place this is used.
If this isn't configured, nrBrowserAgent won't include the loggedIn
field on any events, and useLoggedIn().loggedIn
will always be null
.
This theme supports Layout components in a similar way to Gatsby V1
through the gatsby-plugin-layout
. This plugin allows you to persist the layout between page changes, as well as state.
To start using this layout functionality create a component at src/layouts/index.jsx
, then the plugin will automatically inject the component into your pages.
Used to add a marketing banner to a page.
import { Banner } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | yes | Content to be displayed in the banner. | |
onClose |
function | yes | Handler called when the user clicks on the "close" button. | |
visible |
boolean | yes | Determines if the banner is visible to the user or not |
Example
<Banner visible={visible} onClose={() => setVisible(false)}>
<h1>Hello, World!</h1>
</Banner>
Styled buttons used to draw emphasis on clickable actions.
import { Button } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
variant | enum | yes | Configures the variant of the button. Must be one of Button.VARIANT.LINK , Button.VARIANT.PRIMARY , Button.OUTLINE , or Button.VARIANT.NORMAL
|
|
size | enum | no | Configures the size of the button. Can be configured to Button.SIZE.SMALL
|
|
as | React element | no | button |
Render the button as a different base element. Useful when you want to style links as buttons. |
Additional props are forwarded to the underlying element specified by the as
prop.
Examples
<Button variant={Button.VARIANT.PRIMARY} onClick={() => console.log('Hello')}>
Say hello
</Button>
Render a link as a button
import { Link } from '@newrelic/gatsby-theme-newrelic';
// ...
<Button as={Link} to="/page-2" variant={Button.VARIANT.PRIMARY}>
Page 2
</Button>;
Callouts direct your attention to information of special importance or to information that doesn't fit smoothly into the main text.
- Caution: Screams at you that this could cause a crash or cost you data loss beyond the task at hand.
- Important: Urges awareness that this could impair the task at hand or cost you time if you ignore the text.
- Tip: Whispers to you that this is nice to know, like a shortcut, best practice, or reminder.
import { Callout } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Adds a className to the callout. Useful if you need to position the callout within its parent element. |
|
variant |
enum | yes | Configures the variant of the callout. Must be one of Callout.VARIANT.CAUTION , Callout.VARIANT.IMPORTANT , Callout.VARIANT.TIP , Callout.VARIANT.COURSE
|
|
title |
enum | no | Set the title text. Defaults to variant name. You may hide the title by passing null as the value. |
Examples
<Callout variant={Callout.VARIANT.CAUTION}>Be careful!</Callout>
Hide the title
<Callout variant={Callout.VARIANT.CAUTION} title={null}>
Be careful!
</Callout>
Used when rendering code blocks on a page.
import { CodeBlock } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
autoFormat |
boolean | no |
true * |
Determines whether to auto format the code using prettier. true will force code formatting to occur. false will force disable code formatting. If left empty, code formatting will only run on a subset of supported languages (see below) |
children |
string | yes | The code to be rendered in the code block | |
className |
string | no | Adds a className to the outer container of the code block. Useful if you need to position the code block within its parent element. |
|
components |
object | no | Swap out the elements used when rendering various elements of the code block. See the "Configurable components" guide below to learn more about this prop. | |
copyable |
boolean | no | true |
Determines whether to render a copy button for the content inside the code block. |
fileName |
string | no | The file name associated with the code rendered by the code block. Useful if the code block is used as part of tutorial. | |
formatOptions |
object | no | Configuration options given to the formatCode utility function to auto-format the code block. |
|
highlightedLines |
string | no | Specifies which lines in the code block should be highlighted. See the examples below on for information on how to format this string. | |
language |
string | no | Configures the language used for syntax highlighting. Must match one of the languages or its aliases from prismjs . To learn more about configuring supported languages, visit the prism configuration section. |
|
lineNumbers |
boolean | no | false |
Determines whether to show line numbers inside the code block. |
live |
boolean | no | false |
Determines whether the code block is live-editable or not. Useful when used in conjunction with the preview option, though not required. |
preview |
boolean | no | false |
Determines whether a live preview is displayed using the value in the code block. Useful in conjunction with the live option to allow the user to edit the code snippet. |
scope |
object | no | Configures the variables available as globals for the live preview. By default, only React is injected. To find out more about how the scope prop works, visit the react-live documentation. |
Auto code formatting
Out of the box, the CodeBlock
component will use prettier to format code for a
subset of languages. These include:
-
jsx
/javascript
html
graphql
json
-
css
/sass
/scss
To force formatting for another language, set the autoFormat
prop value to
true
. To force disable code formatting, set the autoFormat
prop value to
false
.
NOTE: If you choose to force enable code formatting for a language not
listed above, you may need to use the formatOptions
prop to set the proper
plugins
.
Configurable components
The CodeBlock
is a component made up of several underlying components.
There are cases where the default components may not be suitable for the needs
of the site. The components
prop allows you to specify your own custom
components in place of the defaults to tailor component rendering for that
component.
Each custom component is given all the props that would otherwise be passed to the default component. It is highly recommended to use the props given to the custom component.
The following components can be customized:
Preview
By default, the built-in Preview
component uses the LivePreview
component
from react-live
. Overriding
this component may be useful if you need to, for example, render the preview
inside of a shadow DOM root element which allows style isolation without
polluting the global CSS namespace.
It is highly recommended that you render the LivePreview
component within
your custom component. It will be very difficult to see the live preview
otherwise.
Prop | Type | Description |
---|---|---|
className |
string |
Includes the default styles for the preview pane. Forward this prop to the root of your custom component to maintain a consistent style. |
Examples
const codeExample = `
import React from 'react'
const Button = (props) => (
<button className='button' {...props} />
)
`;
const Documentation = () => (
<CodeBlock language="jsx" fileName="src/components/Button.js">
{codeExample}
</CodeBlock>
);
Line highlighting
const codeExample = `
import React from 'react'
import PropTypes from 'prop-types'
const Button = (props) => (
<button className='button' {...props}>
{props.children}
</button>
)
Button.propTypes = {
children: PropTypes.element
}
export default Button
`;
const Documentation = () => (
/*
* Highlight multiple lines by comma-separating the line numbers.
* Include a range of lines by using a `-` between the line numbers.
*/
<CodeBlock language="jsx" highlightedLines="1,6,10-12">
{codeExample}
</CodeBlock>
);
Custom Preview component
import { LivePreview } from 'react-live';
import root from 'react-shadow';
const styles = `
.button {
display: inline-flex;
align-items: center;
justify-content: center;
padding: 0.5rem 1rem;
font-size: 0.875rem;
background: none;
cursor: pointer;
}
`;
// This component will be used in place of the default `Preview` component in
// the `CodeBlock`. Here we are using the shadow DOM to provide style isolation
// for the `button` class defined by the CSS in the `styles` variable above.
const CustomPreview = ({ className }) => (
<root.div>
<style type="text/css">{styles}</style>
<LivePreview className={className} />
</root.div>
);
// The button implementation we will be using when rendering the live preview,
// provided via the `scope` prop.
const Button = ({ children, ...props }) => (
<button className="button">{children}</button>
);
const codeSample = `
<Button>Click me</Button>
`;
const Documentation = () => (
<CodeBlock
preview={true}
components={{ Preview: CustomPreview }}
scope={{ Button }}
>
{codeSample}
</CodeBlock>
);
This element is used to reveal or hide content associated with it. Use in
conjunction with a CollapserGroup
when using multiple
Collapser
s in tandom.
import { Collapser } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | yes | The content that will be hidden or revealed when the user interacts with the Collapser . |
|
defaultOpen |
boolean | yes | false | Determines if the Collapser should default to its open state. |
id |
string | no | An HTML id attribute that will be attached to the Collapser title . Useful if you want to deep link to the Collapser . |
|
title |
string | React element | yes | The text that will be rendered on the interactive button used to toggle the open state on the Collapser . |
Examples
import { Collapser } from '@newrelic/gatsby-theme-newrelic';
<Collapser title="The Ruby Agent API">
This is some information about the Ruby Agent. You'll have to interact with
the Collapser to see me.
</Collapser>;
Multiple collapsers
import { Collapser, CollapserGroup } from '@newrelic/gatsby-theme-newrelic';
<CollapserGroup>
<Collapser title="Collapser 1">
The first collapser! I will be hidden by default.
</Collapser>
<Collapser title="Collapser 2" defaultOpen>
The second collapser! The user will see this content by default.
</Collapser>
</CollapserGroup>;
Used in conjunction with multiple Collapser
s to group them together.
import { Collapser, CollapserGroup } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Adds a className to the collapser group. Useful if you need to position the collapser group within its parent element. |
|
children |
React element | yes | The set of Collapser elements that will be rendered as part of the CollapserGroup . |
Examples
import { Collapser, CollapserGroup } from '@newrelic/gatsby-theme-newrelic';
<CollapserGroup>
<Collapser title="Collapser 1">
The first collapser! I will be hidden by default.
</Collapser>
<Collapser title="Collapser 2" defaultOpen>
The second collapser! The user will see this content by default.
</Collapser>
</CollapserGroup>;
Used to display contributing information for the current page. This is meant to
be used as a section inside of the PageTools
component.
To ensure this component leverages its full potential, please ensure the
following siteMetadata
fields are configured:
branch
contributingUrl
repository
NOTE: If the contributingUrl
is not configured, it will use the default
value as specified in the siteMetadata
section.
import { ContributingGuidelines } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
fileRelativePath |
string | no | The relative file path of the current page. This will be used by the "Edit this page" link. | |
pageTitle |
string | no | The title of the current page for use in a new GitHub issue. |
Examples
<PageTools>
<ContributingGuidelines fileRelativePath="src/pages/index.js" />
</PageTools>
Pre-defined GitHubIssueButton
used specifically for the
"Create issue" button in the ContributingGuidelines
and GlobalFooter
components.
import { CreateIssueButton } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
pageTitle |
string | no | Title of the page where the user clicked the "Create issue" button. Used to pre-populate the issue. |
All other props are forwarded to Button
component.
Example
import { Button, CreateIssueButton } from '@newrelic/gatsby-theme-newrelic';
<CreateIssueButton
pageTitle="Demo"
size={Button.SIZE.SMALL}
variant={Button.VARIANT.OUTLINE}
/>;
Used in combination with use-dark-mode
, is an icon
which sets a users' webpage to display either the light or dark theme
import { DarkModeToggle } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Optional className that can be added to the component | |
onClick |
function | no | Addional functionality that can be added to the toggle if desired | |
size |
string | no | Size of the icon, must denote unit (e.g., px , rem , etc ) |
Example
// Fake tracking function just for an example
const trackUsage = (event) => {
track(event);
};
<DarkModeToggle
className="dark-mode-toggle"
onClick={trackUsage}
size="0.875rem"
/>;
Used in combination with Dropdown.Toggle
, Dropdown.Menu
, and Dropdown.MenuItem
to create a dropdown.
import { Dropdown } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
align |
enum | no | "left" | The position of the menu arrow. Must be either left , right , or center . |
children |
node | yes | Components used for the dropdown. |
import { DropDown, Button } from '@newrelic/gatsby-theme-newrelic';
const Example = (
<Dropdown align="right">
<Dropdown.Toggle variant={Button.VARIANT.NORMAL}>Menu</Dropdown.Toggle>
<Dropdown.Menu>
<Dropdown.MenuItem>Item 1</Dropdown.MenuItem>
<Dropdown.MenuItem>Item 2</Dropdown.MenuItem>
<Dropdown.MenuItem>Item 3</Dropdown.MenuItem>
</Dropdown.Menu>
</Dropdown>
);
Used within a Dropdown
component to render a button that can toggle whether or not the dropdown menu is visible.
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
size |
enum | no | The size prop for the underlying Button component. |
|
variant |
enum | yes | The variant prop for the underlying Button component. |
|
children |
node | no | Content used to render the toggle |
Used within a Dropdown
component to render the menu that is shown when the dropdown is open.
Props
Props | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | yes | Content rendered inside the dropdown menu. Should consist of Dropdown.MenuItem components. |
Used within a Dropdown.Menu
component (within a Dropdown
component) to render an individual dropdown menu item.
Props
Props | Type | Required | Default | Description |
---|---|---|---|---|
href |
string | no | A path that, if supplied, will be used as a Link . |
|
onClick |
function | no | An optional click event handler that is triggerd when the component is clicked. | |
children |
node | yes | Content for the MenuItem . |
Used to render links that navigate outside of the website. This component is a
shortcut on top of the target="_blank"
and rel="noopener noreferrer"
attributes and provides no out-of-the-box styling.
import { ExternalLink } from '@newrelic/gatsby-theme-newrelic';
Props
All props are forwarded to the underlying a
tag with the exception of the
target
and rel
props.
Example
<ExternalLink href="https://newrelic.com">Link to New Relic</ExternalLink>
Button used to link to the current page in GitHub. Used for the "Edit page"
button in the ContributingGuidelines
and
GlobalFooter
components.
import { EditPageButton } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
fileRelativePath |
string | yes | Relative filepath of the current page. | |
instrumentation |
Instrumentation | yes | Config for the component instrumentation when the button is clicked. See the values below for a desciption on what is allowed. |
All other props are forwarded to Button
component.
type Instrumentation = {
component: string;
};
Instrumentation
The following fields are available for instrumentation:
-
component
(string) required - The name of the component where this button is used. Helps to understand where in the site the button is clicked.
Example
import { Button, EditPageButton } from '@newrelic/gatsby-theme-newrelic';
<EditPageButton
fileRelativePath="src/content/docs/apm.mdx"
size={Button.SIZE.SMALL}
variant={Button.VARIANT.OUTLINE}
instrumentation={{ component: 'ContributingGuidelines' }}
/>;
SVG wrapper for feather icons. This is useful when shadowing feather icons to ensure all feather icons have consistent props/styles applied to them.
NOTE: When using this component, you should to spread all props to it.
import { FeatherSVG } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | yes | The "guts" of the feather svg definition |
Additional props are forwarded to the svg
tag.
Example
const ChevronDownIcon = (props) => (
<FeatherSVG {...props}>
<polyline points="6 9 12 15 18 9" />
</FeatherSVG>
);
Button used to create issues on GitHub. This component depends on the
repository
and siteUrl
fields configured in site metadata.
import { GitHubIssueButton } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
labels |
string[] | no | Labels that should be prepopulated for the issue. NOTE: This labels must be created in the repository where this button links to. | |
issueTitle |
string | no | The value that will pre-populate the issue title. | |
issueBody |
string | no | The value that will pre-populate the issue body. |
All other props are forwarded to Button
As a convenience, this component attaches environment information to the issue body to allow for easier debugging. This eliminates the need for a section in the issue body asking for environment information from the user filing the issue.
The information gathered is:
- Page URL
- Browser name and version
- Operating system name and version
- Device type (mobile, tablet, etc.), vendor and model
If the browser environment is unable to be determined, these values are simply set to "Unknown".
Example
import { Button, GitHubIssueButton } from '@newrelic/gatsby-theme-newrelic';
const ISSUE_BODY = `
## Description
[NOTE]: # (Tell us some information!)
`
<GitHubIssueButton
labels={['bug']}
issueTitle="Bug found"
issueBody={ISSUE_BODY}
size={Button.SIZE.SMALL}
variant={Button.VARIANT.OUTLINE}
>
Found a bug!
</GitHubIssueButton>
Renders the global footer used on all New Relic Gatsby sites. This component utilizes the layout
configuration from the theme to size itself and the siteMetadata
for the repository URL.
NOTE: The logo displayed in the footer is a generic to New Relic logo, but can be changed with shadowing.
import { GlobalFooter } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
fileRelativePath |
string | no | The relative path to the markdown file for the current page. If not supplied, the edit link will not be shown | |
pageTitle |
string | no | The title of the current page for use in a new GitHub issue. |
Example
<GlobalFooter fileRelativePath={'/src/content/foobar.md'} />
Renders the global header used on all New Relic Gatsby sites. This component
utilizes the layout
configuration from the theme to size itself.
Note: The signup
configuration options are needed for this component to function correctly.
import { GlobalHeader } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
activeSite |
enum | no | The New Relic site that we should present as "active". This should come from NR_SITES , which is exported. |
Examples
import { GlobalHeader } from '@newrelic/gatsby-theme-newrelic';
// Normal use
return <GlobalHeader />;
// With a custom-set active page
return <GlobalHeader activeSite={GlobalHeader.NR_SITES.IO} />;
Used as the toggle for mobile views to show and hide the mobile navigation.
import { HamburgerMenu } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
isOpen |
boolean | yes | false |
Determines whether the HamburgerMenu is considered open or closed. |
onToggle |
function | yes | Handler called when the user interacts with the hamburger menu. This handler should be responsible for toggling the isOpen state of the hamburger menu. |
Examples
import React, { useState } from 'react';
const MobileMenu = () => {
const [isOpen, setIsOpen] = useState(false);
return (
<HamburgerMenu
isOpen={isOpen}
onToggle={() => setIsOpen((isOpen) => !isOpen)}
/>
);
};
Used to render icons on the website. This component utilizes a subset of the Feather icon set. To add additional icons for use in your website, use component shadowing. See the "Shadowing" section below for an explanation on how to use this feature.
import { Icon } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
name |
enum | yes | The name of the icon that will be rendered. See the full list of available icons in the "Available icons" section below. | |
size |
string | no | 1em |
The size of the icon. The value can be any CSS sizing value. |
Additional props are forwarded to the underlying svg
element.
Feather
fe-chevron-down
fe-cloud
fe-copy
fe-edit
fe-external-link
fe-filter
fe-github
fe-loader
fe-moon
fe-pen
fe-search
fe-sun
fe-thumbsdown
fe-thumbsup
fe-x
New Relic
nr-tdp
nr-fso
nr-ai
Logos
logo-apple
logo-android
Because this theme only provides a subset of the feather icon set, you may need to add additional icons for use in your website. You can use component shadowing to do so. When shadowing the icon set, YOU MUST include the default set of icons in order for the built-in components to work properly.
When shadowing an icon set, defined the icons using the unprefixed name. The
gatsby theme will automatically prefix the icons for you depending on the icon
set. For example, to add the
chevron-right
icon, define
its name as chevron-right
, not fe-chevron-right
. This icon will be available
to the Icon
component as fe-chevron-right
.
The following icons sets can be shadowed:
- Feather
- File path:
src/@newrelic/gatsby-theme-newrelic/icons/feather.js
- Prefix:
fe
- File path:
- New Relic
- File path:
src/@newrelic/gatsby-theme-newrelic/icons/newrelic.js
- Prefix:
nr
- File path:
// src/@newrelic/gatsby-theme-newrelic/icons/feather.js
import React from 'react';
import defaultIcons from '@newrelic/gatsby-theme-newrelic/src/icons/feather';
import { FeatherSVG } from '@newrelic/gatsby-theme-newrelic';
export default {
...defaultIcons,
'chevron-right': (props) => (
<FeatherSVG {...props}>
<polyline points="9 18 15 12 9 6" />
</FeatherSVG>
),
};
// To use this icon, use the prefixed name:
<Icon name="fe-chevron-right" />;
Example
<Icon name="fe-copy" size="1rem" />
Layout components used to wrap the page content. Used as a container for the layout subcomponents.
For more information on the layout subcomponents, see the following for more details:
import { Layout } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
children |
node | no | Content used for the layout. These should be layout subcomponents. |
Examples
<Layout>
<Layout.Sidebar>
<Logo />
<MyNavigation />
</Layout.Sidebar>
<Layout.Main
css={css`
display: grid;
grid-template-columns: minmax(0, 1fr) 320px;
grid-template-areas: 'content page-tools';
grid-gap: ${contentPadding};
`}
>
<Layout.Content>
<h1>Hello, world</h1>
</Layout.Content>
<Layout.PageTools>
<ContributingGuidelines fileRelativePath={fileRelativePath} />
</Layout.PageTools>
</Layout.Main>
<Layout.Footer fileRelativePath={fileRelativePath} />
</Layout>
Used for displaying the body of the page. It has a grid-area
set to content
to allow for grid customization.
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
children |
node | no | Content used for the layout. These should be layout subcomponents. |
Examples
<Layout.Content>
<h1>Hello, world</h1>
</Layout.Content>
Wraps the GlobalFooter
component for use inside the layout.
Props
All props are forwarded to the GlobalFooter
component.
Examples
<Layout.Footer fileRelativePath={fileRelativePath} />
Wraps the main content area in the layout.
NOTE: For single-column pages, the Layout.Content
component should be used as the single child of this component to ensure the
props Swifttype attributes are added for the body of the content. For layouts
that use Layout.PageTools
, you will need to specify the
grid used for the layout.
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
children |
node | no | Content displayed inside the main content area. For single-colum layouts, the Layout.Content should be the only child. |
Examples
<Layout.Main>
<Layout.Content>
<h1>Hello, world</h1>
<p>Here is where the main content of the page goes!</p>
</Layout.Content>
</Layout.Main>
Layout with page tools
<Layout.Main
css={css`
display: grid;
grid-template-columns: minmax(0, 1fr);
grid-template-areas: 'content page-tools';
`}
>
<Layout.Content>
<h1>Hello, world</h1>
<p>Here is where the main content of the page goes!</p>
</Layout.Content>
<Layout.PageTools>
<ContributingGuidelines fileRelativePath={fileRelativePath} />
</Layout.PageTools>
</Layout.Main>
Wraps the PageTools
component for use inside the layout.
Props
All props are forwarded to the PageTools
component.
Examples
<Layout.PageTools>
<ContributingGuidelines fileRelativePath={fileRelativePath} />
</Layout.PageTools>
Sidebar displayed inside the layout. This should contain the primary navigation used for the site.
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
children |
node | no | Content displayed inside the main content area. For single-colum layouts, the Layout.Content should be the only child. |
Examples
<Layout.Sidebar>
<Logo />
<MyNavigation />
</Layout.Sidebar>
Provides a "smart" link to link to other URLs. This provides a unified component
between a Gatsby Link
and an
external link. This component will pick between a regular anchor tag and a
Gatsby link depending on whether the URL is a relative or external url.
This component also makes use of the SignUpLink
component when users are being directed
to sign up for New Relic. The SignUpLink
is rendered when the to
prop passed to
the Link
components starts with https://newrelic.com/signup
(this can be updated in the
Link
component). SignUpLink
will then determine the users locale and format a corresponding
href for that user. This, along with additional instrumentation, comprises the SignUpLink
use case.
This component will automatically convert absolute URLs that link to pages within the same site to relative links. This ensures a smooth user experience for all linked pages on the site.
This component can be used as a replacement for the built-in Link
component in
Gatsby since it wraps it.
import { Link } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
to |
string | yes | The URL to link to. If this is a relative path, it will use the Gatsby Link component. If it is an external URL, it will use a regular anchor tag. |
|
displayExternalIcon |
bool | no | false | If the to is external to the current site, and you want the element to include an icon showing this leads to an external site, set this to true
|
shouldAutoLocalize |
bool | no | true |
Optionally specify if an internal link's URL path should be auto localized when on a translated version of the site. |
All additional props are forwarded to either the
Link
component or the anchor tag
depending on whether it is a relative or absolute URL.
Examples
// Can be used as a relative link to other pages in the site
<Link to="/page-2">Page 2</Link>
// Link to other pages in the site without auto localizing the URL
<Link to="/page-2" shouldAutoLocalize={false}>Page 2 (not localized)</Link>
// Can also be used to link to external URLs
<Link to="https://gatsbyjs.com">GatsbyJS</Link>
// If the link is absolute, but the origin matches the `siteMetadata.siteUrl`,
// it will smartly convert this to a relative path.
<Link to="https://developer.newrelic.com/page-2">developer page 2</Link>
Container used to wrap markdown content. Provides spacing and additional styles necessary for documents rendered via markdown or MDX.
import { MarkdownContainer } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | yes | Content that will be rendered inside the markdown container. This is usually an MDX component. |
|
className |
string | no | Additional className for the MarkdownContainer
|
|
dangerouslySetInnerHTML |
string | no | Same as React's dangerouslySetInnerHTML . Useful when rendering a compiled markdown string inside this container. |
Example
MDX
<MarkdownContainer>
<MDX body={body} />
</MarkdownContainer>
Markdown
<MarkdownContainer dangerouslySetInnerHTML={markdown} />
Utility to render MDX content on a page. Provides out-of-the-box shortcodes for commonly used components.
import { MDX } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
body |
string | yes | The compiled MDX string to be rendered for the page. This is usually the body property on an MDX node in Gatsby. |
|
components |
object | no | Provides shortcodes for MDX documents. Use this to add additional components or override the default components. |
When using MDX
, it is HIGHLY RECOMMENDED to wrap the content with the
MarkdownContainer
component to provide the additional
styles and proper spacing. If you would like to render additional components
within the MarkdownContainer
and want to match spacing, use the following CSS
variables:
-
--block-element-spacing
: Provides proper spacing for block elements (callouts, code blocks, etc.) -
--text-spacing
: Spacing used between paragraphs of text. Use this for textual elements in the document (i.e. unordered/ordered lists)
The MDX
component ships with a set of default mapped components. Where
possible, this component uses the MDX component variants for
block level components to provide proper spacing.
For more information on the
set of available shortcodes mapped to built-in elements (such as a
), see the
MDX documentation
The following shortcodes are available by default:
a
code
pre
table
Button
ButtonLink
Callout
Collapser
CollapserGroup
Icon
InlineCode
Link
Video
Example
<MarkdownContainer>
<MDX body={body} />
</MarkdownContainer>
Overriding components
const components = {
h1: (props) => <h1 style={{ color: 'purple' }} {...props} />,
};
<MarkdownContainer>
<MDX body={body} components={components} />;
</MarkdownContainer>;
Providing your own components
Used to render a fenced code block using the CodeBlock
component
or a Terminal
component inside of an MDX document. This component
works best in conjunction with the MDXProvider
component exported from the
@mdx-js/react
package.
import { MDXCodeBlock } from '@newrelic/gatsby-theme-newrelic';
Props
All props are forwarded to the either the CodeBlock
component, or the
Terminal
component (whichever is rendered based on the language. See below for
more information). This component also maintains the same defaults. See the
"Using with fenced code blocks" section below to learn how options in fenced
code blocks are forwarded to the CodeBlock
or Terminal
component.
Terminals
This component will automatically render a Terminal
component
whenver the language is specified as a shell language (sh
, shell
, or
bash
.) This is to provide a richer experience when rendering shell commands.
Usage with MDXProvider
import { MDXRenderer } from 'gatsby-plugin-mdx';
import { MDXProvider } from '@mdx-js/react';
import { MDXCodeBlock } from '@newrelic/gatsby-theme-newrelic';
const components = {
// ...
code: MDXCodeBlock,
// This is also recommended to avoid nesting a `pre` inside of a `pre` when
// rendering fenced code blocks
pre: (props) => props.children,
};
const Markdown = ({ children }) => (
<MDXProvider components={components}>
<MDXRenderer>{children}</MDXRenderer>
</MDXProvider>
);
export default Markdown;
Using with fenced code blocks
The MDXCodeBlock
maps options from a fenced code block to the CodeBlock
component. The following options are available for fenced code blocks when using
this component.
-
language
: Use a language identifier to enable syntax highlighting for the fenced code block. If this is a shell language (sh
,shell
, orbash
), aTerminal
component is rendered instead.
```js
```
-
animate
(Terminal
only): Determines whether to animate the shell command and terminal output to make it appear as if the command is being typed. NOTE: This is ignored if thelanguage
is not set to a shell language.
```sh animate
```
-
copyable
:true
orfalse
. Determines whether to show a copy button for the content inside of the fenced code block.
```js copyable=false
```
-
lineHighlight
: Highlight lines of code in the code block using the same format as described in theCodeBlock
documentation
```js lineHighlight=1,5,7-9
```
-
lineNumbers
:true
orfalse
. Determines whether to render line numbers in the code block.
```js lineNumbers=true
```
-
live
:true
orfalse
. Determines whether the code block will be live-editable.
```js live=true
```
-
preview
:true
orfalse
. Determines whether to show a live preview using the code inside of the fenced code block.
```js preview=true
```
Used to wrap NavItem
components.
import { Navigation } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | yes | Nav items to be rendered in the navigation | |
className |
string | no | Additional className for the component |
|
searchTerm |
string | no | Search term used to filter nav items |
Examples
import { Navigation } from '@newrelic/gatsby-theme-newrelic';
<Navigation searchTerm="New Relic">
<NavItem page={page1} />
<NavItem page={page2} />
</Navigation>;
A component used for displaying nav items in the sidebar.
import { NavItem } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
page |
page |
yes | The page data used to for the nav link. See the page type documentation for more info. |
The NavItem
expects a page type that represents a hierarchy of nav links.
The following properties can be used:
-
title
(string) Required: The title that will show up for the nav item. -
url
(string): Can be either a relative path or an external URL. If theurl
is omitted, the nav item will act as a toggle for its children. -
icon
(string): Name of the icon to be displayed for the nav item. This must match a name from the available icons list. If the icons are shadowed, this may be the name of a shadowed icon as well. -
pages
([page]): A list of child pages that will be rendered as children of the current page.
Examples
const nav = [
{
url: '/docs/intro-to-tdp',
title: 'Introduction to Telemetry Data Platform',
icon: 'nr-tdp',
pages: [
{ url: '/docs/tdp/collect-data', title: 'Collect data in TDP' },
{ url: '/docs/tdp/understand-data', title: 'Understand data' },
],
},
];
const Navigation = () => {
return nav.map((page) => <NavItem key={page.url} page={page} />);
};
Used to render the New Relic logo.
import { NewRelicLogo } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component |
|
omitText |
boolean | no | true |
Determines whether to only render the logo without the text. Useful for responsible layouts where the logo may only be displayed. |
size |
string | no | Size of the logo. Accepts any CSS sizing value (e.g. 100px ). Defaults to 18px when omitText is true and 79px when omitText is false
|
Examples
<NewRelicLogo />
Used as a container to display a any component passed as children on top of a page while stopping scrolling on the page itself.
import { Overlay } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | yes | Additional className for the component. |
|
children |
node | yes | Content to be displayed in the Overlay component |
|
onCloseOverlay |
function | yes | Additional function that can be run as an onClick when closing the Overlay
|
|
isOpen |
boolean | no | false | Boolean to determine if the Overlay is displayed |
Example
[isOpen, setIsOpen] = useState(false);
<Overlay className={'main-overlay'} isOpen={isOpen}>
<p>This is an Overlay!</p>
</Overlay>;
Used as a "right rail" container to display content related to the current page.
To build modules contained inside this component, see the
PageTools.Section
and PageTools.Title
documentation.
import { PageTools } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
children |
node | no | Content to be displayed in the PageTools component |
Example
<PageTools>
<PageTools.Section>
<PageTools.Title>How to use</PageTools.Title>
<p>
Use the `PageTools` component to render content related to the current
page.
</p>
</PageTools.Section>
</PageTools>
A component used as a building block for creating content displayed inside of
the PageTools
component. This is a container for the content
inside a section of the PageTools
.
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
children |
node | no | Content to be displayed in the PageTools.Section component |
Example
<PageTools>
<PageTools.Section>
Use the `PageTools.Section` component as a container around content to be
displayed in a section of the `PageTools`.
</PageTools.Section>
<PageTools.Section>
This will be displayed as its own section inside `PageTools`
</PageTools.Section>
</PageTools>
A component used as a building block for creating content displayed inside of
the PageTools
component. This is used to display a title for the
section of content inside of PageTools
. Render this inside of a
PageTools.Section
component.
<PageTools.Section>
<PageTools.Title>Related resources</PageTools.Title>
</PageTools.Section>
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
children |
node | no | Title to be displayed in the PageTools.Title component |
Paired with createPortal
from react-dom
, this component can be used to append a set of children elements to the body
element in the DOM.
import { Portal } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | no | Content to be displayed in the Portal
|
Examples
[showPortal, setShowPortal] = useState(false);
showPortal &&
<Portal>
<p>
Warning: Please select at least one option.
<p>
</Portal>
Used to display related resources for the current page. This is meant to be used
as a section inside of the PageTools
component.
import { RelatedResources } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component |
|
resources |
Resource[] | yes | Array of resources to be displayed in the component. | |
title |
string | no | 'Related resources' | Title to be displayed as the title for this section |
type Resource = {
url: string;
title: string;
};
Examples
<PageTools>
<RelatedResources resources={relatedResources} />
</PageTools>
An input element used for searching content.
import { SearchInput } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
onClear |
function | yes | Handler called when the user interacts with the clear button. This handler should be responsible for resetting the value of the input. |
|
size |
enum | no | Size of the input. Must be one of SearchInput.SIZE.MEDIUM or SearchInput.SIZE.LARGE
|
|
value |
string | no | Value of the search input. | |
width |
string | no | Width of the input. Accepts any CSS sizing value (e.g. 100px ) |
|
iconName |
enum | no | Specify icon to use. Must be one of SearchInput.ICONS.SEARCH or SearchInput.ICONS.FILTER Defaults to search magnifying glass. |
|
focusWithHotKey |
string | no | Adds a listener to focus the input with a hotkey. For example, to focus the search input using the / key, specify focusWithHotKey="/"
|
Additional props are forwarded to the underlying input
element.
Example
const Search = () => (
const [value, setValue] = useState('')
return (
<SearchInput
value={value}
onClear={() => setValue('')}
onChange={(e) => setValue(e.target.value)}
focusWithHotKey="/"
/>
);
);
Used to display a set of components at a slight skew (~ 2 degrees) relative to the page.
import { SkewedContainer } from '@newrelic/gatsby-theme-newrelic';
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | no | Content to be displayed in the container | |
className |
string | no | Additional classname to be added to the component |
Examples
<SkewedContainer>
<p>404 - this page does not exist</p>
</SkewedContainer>
A component that injects meta-tags, links, and other relevant tags for search engine optimization.
import { SEO } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
location |
string | yes | The location object of the page where this is rendered. This object must have properties of pathname and origin . |
|
title |
string | no | title to be displayed in head. | |
children |
node | no | any additional tags to be added to the <head> of the page |
Example
const MainLayout = () => (
return (
<>
<SEO location={location} />
<GlobalHeader/>
<Layout/>
</>
)
);
This component is used to have content displayed in several columns. You have to use it in
conjunction with a SideBySide
component.
You can have several components inside a Side
component.
import { Side, SideBySide } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | no | The content that's displayed in one side of the columns. |
Example
<SideBySide>
<Side>
<p>Lorem ipsum Lorem ipsum Lorem ipsum</p>
<CodeBlock language="json">{myCodeBlock}</CodeBlock>
</Side>
<Side>
<img alt="example" src={exampleImg} />
</Side>
</SideBySide>
This component is used to have content displayed in several columns. You have to use it in
conjunction with a Side
component.
Ideally, there'll never be more than two columns of content in a doc.
import { Side, SideBySide } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | no | The content that's displayed in one side of the columns. | |
className |
string | no | Additional className for the component. |
Example
<SideBySide>
<Side>
<p>Lorem ipsum Lorem ipsum Lorem ipsum</p>
<CodeBlock language="json">{myCodeBlock}</CodeBlock>
</Side>
<Side>
<img alt="example" src={exampleImg} />
</Side>
</SideBySide>
A simplified version of the Feedback
component.
import { SimpleFeedback } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
pageTitle |
string | no | The current page title, which will be added to the issue title, if supplied. | |
labels |
array | no | ['feedback'] |
An array of label string to be applied to the new issue, in addition to eitherfeedback-positive orfeedback-negative . |
Example
<SimpleFeedback title="My Cool Page" slug="/my-cool-page" />
A spinner that can be used to indicate a loading state.
import { Spinner } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
inline |
boolean | no | false |
Determines whether the spinner should be rendered inline. By default this will center the spinner inside its container. |
Example
const View = () => (
return <Spinner />;
);
A placeholder element that the user sees before the actual content is loaded. It's designed as a square with the background color of the docs site.
It works for light and dark mode.
import { Skeleton } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
width |
pixels | Yes | None | The width of the element. |
height |
pixels | Yes | None | The height of the element. |
Example
<Skeleton
css={css`
width: 100px;
height: 100px;
`}
/>
A wrapper around the Button
for A/B testing. It takes in the name of a Split.io split and changes color based on the config.
To connect this component to a split and track metrics, pass the name of the split in as the value of the treatmentName
prop and the click event name as the eventName
prop. The name of the treatment does not matter, as the component only checks to see if it is off
. The config value for each treatment, excluding off
, must be JSON in the following form:
{
"color": "<color>"
}
Example treatment config:
{
"color": "#000000"
}
import { SplitColorButton } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | no | The content to display within the button. Usually a <span> with text content. |
|
treatmentName |
string | yes | The name of the treatment in Split.io. | |
eventName |
string | yes | The name of the event in Split.io. |
Example
<SplitColorButton
treatmentName="TestFeature"
size={Button.SIZE.SMALL}
variant={Button.VARIANT.PRIMARY}
>
<span>Click me!</span>
</SplitColorButton>
A container for Step components
Example
<Steps>
<Step>This is step 1</Step>
</Steps>
The child of a Steps component, will render individual steps and automatically number them
** note: If using a header within a step component you'll need to use html tags rather than markdown
Example
<Steps>
<Step>This is step 1</Step>
<Step>This is step 2 ```js const itHasACodeBlock = true ```</Step>
</Steps>
Used as the foundation for elements in 3D space that sit above other elements, for example a card.
import { Surface } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
base |
enum | yes | Tells the Surface what kind of base element the surface is rendered on. For example, a primary base means the surface is rendered on an element with a primary background. Must be one of Surface.BASE.PRIMARY or Surface.BASE.SECONDARY
|
|
interactive |
boolean | no | false |
Determines whether the surface is interactive (e.g. if the entire surface is a link). |
Example
<Surface base={Surface.BASE.PRIMARY}>The content inside the surface</Surface>
Used to render a table with predefined styles.
import { Table } from '@newrelic/gatsby-theme-newrelic';
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | no | Children should be a combination of tbody , td , th , tr tags with appropriate content nested beneath. |
Examples
<Table>
<tbody>
<tr>
<td>String</td>
</tr>
<tr>
<th>Default</th>
<td>`""`</td>
</tr>
</tbody>
</Table>
Component used to create a table of contents for the page. This is meant to be
used as a section inside of the PageTools
component.
import { TableOfContents } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
headings |
Heading[] | yes | List of headings that should be rendered in the table of contents. |
NOTE: The heading id
attribute MUST be defined on the DOM node that
will be linked to. If not, the table of contents link will not work. Consider
using a plugin such as
gatsby-remark-autolink-headers
to handle this for you.
type Heading = {
id: string;
text: string;
};
Example
import { TableOfContents } from '@newrelic/gatsby-theme-newrelic';
const headings = [
{ id: 'code-monkey', text: 'Code monkey' },
{ id: 'code-ninja', text: 'Code ninja' },
]
<TableOfContents
headings={headings}
/>;
Used to render a keyword or tag.
import { Tag } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
interactive |
boolean | no | false |
Determines whether the tag is interactive (e.g. if the tag is also a link) |
Examples
<Tag>React</Tag>
Interactive tag
<Tag interactive onClick={() => console.log('You clicked the tag!')}>
React
</Tag>
Wraps a list of tags to space them out.
import { TagList } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
children |
node | no | Children should all be Tag components |
Example
<TagList>
<Tag>React</Tag>
<Tag>JavaScript</Tag>
<Tag>Gatsby</Tag>
</TagList>
A nice alternative to the CodeBlock
when rendering shell commands and terminal
output.
import { Terminal } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
animate |
boolean | no | false |
Determines whether to animate the shell command to make it appear as if it is being typed. This will also animate any terminal output specified. Triggers when the user has scrolled 50% of the way down the page. |
children |
string | yes | The code to be rendered in the code block. See below for examples on how to render terminal output. | |
copyable |
boolean | no | true |
Determines whether to render a copy button for the content inside the code block. NOTE: only shell commands will be copied. Terminal output will not be copied to the clipboard. |
Terminal output
To render terminal output, prefix the line of code with the [output]
marker
(include a space after the closing bracket). This tells the Terminal
to 1)
avoid displaying the prompt for the current line and 2) avoid animating it with
the typing animation. When animation is enabled, the terminal output will be
rendered at various intervals of time to make it appear as if the command is
doing some work.
Terminal output can also be colored. By default it will render as plain text
unless otherwise specified. To color a section of text, prefix the area of text
with a color using curly brackets. For example, if you wanted to render some
text as blue
, prefix it with {blue}
. The color of the text will extend unil
the next color marker. You can "reset" the color back to plain text using the
{plain}
marker.
For example, lets say you have this bit of terminal output that you'd like to display as colored:
✔ Component created successfully!
For this example, lets say only the checkmark should be green, while the rest of
the text remain plain. To accomplish this, first specify this line as output
([output]
), and add the color markers:
[output] {green}✔ {plain}Component created successfully!
Here is a more complex example:
[output] {purple}nerdpack {blue}pageviews-app {plain}is available at {green}"./pageviews-app"
Here the output will render the text "nerdpack" as purple
, then the app
identifier as blue
("pageviews-app"), reset the text back to plain, and
finally the string as green
. Also notice how the text is indented after the
[output]
marker. This will render in the terminal as indented text.
Here is a full list of the colors available:
plain
green
red
muted
purple
blue
yellow
For your convenience, color aliases have been provided to give you some more semantically meaningful names, and provide better color consistency between meaningful blocks of text. The following color aliases are available:
-
error
(red
) -
identifier
(blue
) -
string
(green
) -
success
(green
) -
timestamp
(muted
) -
variable
(variable
) -
warning
(yellow
)
[output] {timestamp}2020-01-01 12:00:00 {success}✔ {purple}nerdpack {identifier}pageviews-app {plain} is available at {string}"./pageviews-app"
Example
const shellCommand = `
cd my-nerdlet
nr1 nerdpack:serve
`;
const Example = () => <Terminal animate>{shellCommand}</Terminal>;
With terminal output
const shellCommand = `
nr1 create --type nerdpack --name pageviews-app
[output] {success}✔ {plain}Component created successfully!
[output] {purple}nerdpack {blue}pageviews-app {plain}is available at {green}"./pageviews-app"
`;
const Example = () => <Terminal>{shellCommand}</Terminal>;
Component used to highlight text matches in a string. Useful if filtering text and want to show a matched search term.
import { TextHighlight } from '@newrelic/gatsby-theme-newrelic'`
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
text |
string | yes | The text that should be highlighted with the matching term. | |
match |
string | yes | String used as the matching term. | |
caseSensitive |
boolean | no | false |
Determines if the match should be case sensitive or not. |
Examples
import { TextHighlight } from '@newrelic/gatsby-theme-newrelic';
<TextHighlight text="New Relic" match="New" />;
Used to render a video from either YouTube or Wistia.
import { Video } from '@newrelic/gatsby-theme-newrelic';
Props
Prop | Type | Required | Default | Description |
---|---|---|---|---|
className |
string | no | Additional className for the component. |
|
vertical |
boolean | no | false | When true will change the aspect ratio to 9:16 which is good for most mobile videos |
id |
string | yes | The ID of the video from either Wistia or YouTube | |
title |
string | no |
title attribute placed on the containing iframe
|
|
type |
enum | yes | Determines the source of content. Must be one of Video.TYPE.YOUTUBE or Video.TYPE.WISTIA
|
|
width |
string | no | The width of the video. Note the player will always render in a 16:9 aspect ratio. Accepts any CSS string value (e.g. 500px ) |
Examples
YouTube
<Video id="abcdefg" type={Video.TYPE.YOUTUBE} width="500px" />
Wistia
<Video id="abcdefg" type={Video.TYPE.WISTIA} width="500px" />
Vertical orientation
<Video id="abcdefg" type={Video.TYPE.WISTIA} width="500px" vertical />
When working in an MDX document, adding additional styling, such as spacing for
layout, become more difficult. The MDX
component provides shortcodes
for the commonly used components from the theme, however, these components
provide no external spacing.
To ease the burden on adding spacing for these components while working in MDX,
many of them have been wrapped by an MDX component variant. These components are
prefixed with MDX
and mapped as shortcodes instead. For example, the Callout
shortcode is mapped to an MDXCallout
component, which wraps the real Callout
component.
These MDX component variants forward all props to its wrapped component. The
following MDX variants are available and mapped inside the MDX
component:
-
a
-->MDXLink
-
code
-->MDXCodeBlock
-
table
-->MDXTable
-
Callout
-->MDXCallout
-
CollapserGroup
-->MDXCollapserGroup
-
Video
-->MDXVideo
NOTE: While all of these components are exported and available for use, its highly recommended to use these components solely for use in MDX documents. When working in regular React components, used the regular component instead.
A hook that determines the active hash ID given the scroll position on the page.
import { useActiveHash } from '@newrelic/gatsby-theme-newrelic';
Arguments
-
ids
(string[]): List of DOMid
s that should be monitored. Theid
corresponding to the nearest element based on scroll position will be returned.
Returns
string
- The id
of the active hash.
Examples
const MyComponent = () => {
const activeHash = useActiveHash(['code-monkey', 'code-ninja']);
return (
<div>
<h2
id="code-monkey"
style={{ color: activeHash === 'code-monkey' ? 'red' : 'currentColor' }}
>
Code monkey
</h2>
<h2
id="code-ninja"
style={{ color: activeHash === 'code-ninja' ? 'red' : 'currentColor' }}
>
> Code ninja
</h2>
</div>
);
};
Provides a utility for copying text to the user's clipboard.
import { useClipboard } from '@newrelic/gatsby-theme-newrelic';
Arguments
Object containing:
-
duration
(number): Sets the duration in milliseconds of the stateful value. Default:1000
Returns
A 2-element tuple.
-
[0]
(boolean): A stateful value indicating whether the value was copied. Reset afterduration
seconds. -
[1]
: (function): A function that receives the text to copy as input. Invoking the function will copy the specified text to the user's clipboard.
Examples
const CopyableText = () => {
const [copied, copy] = useClipboard();
return (
<button onClick={() => copy('Hello there!')}>
{copied ? 'Copied' : 'Copy a fun message'}
</button>
);
};
Configurable duration
const [copied, copy] = useClipboard({ duration: 500 });
A hook that runs code formatting on a string using the
formatCode
utility function.
import { useFormattedCode } from '@newrelic/gatsby-theme-newrelic';
Arguments
-
code
(string): The string of code that will be formatted. -
options
(object) - optional: Formatting options forwarded to theformatCode
utilty function. See theformatCode
documentation for specific configuration options.
Returns
String
- The new formatted code string
Examples
const CodeSnippet = ({ code }) => {
const formattedCode = useFormattedCode(code);
return <span>formattedCode<span>;
};
With formatting options:
const formattedCode = useFormattedCode(code, { printWidth: 100 });
A hook that determines if a particular component has been loaded in the DOM.
import { useHasMounted } from '@newrelic/gatsby-theme-newrelic';
Arguments
none
Returns
boolean
depending on whether the component has been loading in the DOM
Examples
const hasMounted = useHasMounted();
if (!hasMounted) {
return null;
};
return <Component>
A hook that wraps a function handler with nrBrowserAgent instrumentation.
import { useInstrumentedHandler } from '@newrelic/gatsby-theme-newrelic';
Arguments
-
handler
(function): The function hander that should be augmented with nrBrowserAgent instrumentation. This can benull
orundefined
. -
attributes
(object | function): Data passed to thenrBrowserAgent
API when called. The attributes MUST contain...-
eventName
- Needs to be in Camel Case -
category
- Needs to be in Title Case -
name
...otherwise the handler will not be instrumented. All other attributes will be attached to theattributes
property of the page action. You can pass a function to instrument dynamic data. If this is a function, the function will be called with the same arguments passed to the handler.
-
Returns
function
- The wrapped function handler to be instrumented with addPageAction
.
Examples
const MyComponent = () => {
const handleClick = useInstrumentedHandler(() => console.log('clicked'), {
eventName: 'buttonClick',
category: 'ClickMeButton',
name: 'click',
});
return (
<Button onClick={handleClick} variant="normal">
Click me
</Button>
);
};
Dynamic data
const MyComponent = () => {
const handler = useInstrumentedHandler(
(a, b) => add(a, b),
(a, b) => ({
eventName: 'counterClick',
category: 'CounterButton',
name: 'click',
sum: a + b,
})
);
return <Counter adder={handler} />;
};
A hook that runs a handler function when a keydown event matches a specified key.
import { useKeyPress } from '@newrelic/gatsby-theme-newrelic';
Arguments
-
key
(string | Array): The key or keys being listened for (i.e. theevent.key
value). This hook also recognizes modifier keys. To add a listener for a modifier key, use the format<modifier key>+<key>
(i.e.CMD+S
). The key is case insensitive and ignores whitespace (i.e.cmd + s
also works.) Pass an array of keys to listen for multiple key combinatations in a single listener. The following modifier keys are supported:-
CMD
- The OS meta key;Command ⌘
on macOS and the Windows key on Windows. Also maps toControl
for easier Windows support. -
CTRL
- TheControl
key. NOTE: This does not map to theCommand
key on macOS. Use this modifier if you explictly want theControl
key on macOS. Shift
Alt
-
-
callback
(function) : Callback function called when the keydown event matches the key. Takes theevent
as the argument. -
options
(object): Options for the hook-
ignoreTextInput
(boolean): Determines whether the handler should trigger when the key matches while typing in aninput
ortextarea
. By default, the handler will not be triggered when the user is typing in a text input (true
). Set tofalse
to trigger the handler in text inputs.
-
Returns
Void
Examples
const Modal = ({ code }) => {
const [isOpen, setIsOpen] = useState(false);
useKeyPress('Escape', (e) => {
setIsOpen(false);
});
return (
<>
<button onClick={() => setIsOpen(true)}>Open modal</button>
{isOpen ? <div className="modal">Modal content</div> : null}
</>
);
};
Modifier keys
useKeyPress('CMD+S', () => {
console.log('Save it!');
});
Listen for multiple keys
useKeyPress(['s', 'h'], (e) => {
console.log(e.key); // 's' or 'h'
});
A hook that gets information about the layout. Pulls data from the layout
gatsby config. Useful to provide consistency for layout styles (such
as maxWidth
and contentPadding
.)
import { useLayout } from '@newrelic/gatsby-theme-newrelic';
Arguments
none
Returns
Object
Contains the values defined in the Gatsby layout
config.
Examples
const MyComponent = () => {
const { contentPadding } = useLayout();
return (
<Sidebar
css={css`
padding: ${contentPadding};
`}
>
<Logo />
</Sidebar>
);
};
A hook that will get an object of information regarding the local language used within a component.
import { useLocale } from '@newrelic/gatsby-theme-newrelic';
Arguments
none
Returns
Object
example:
{
name: 'English',
localName: 'English',
locale: 'en',
hrefLang: 'en',
isDefault: true,
}
Examples
const locale = useLocale();
const currentLanguage = locale.locale === 'en' ? 'English' : 'Japanese';
A hook that returns an object containing the searchTerm in the left Navigation panel.
import { useNavigation } from '@newrelic/gatsby-theme-newrelic';
Arguments
none
Returns
Object with the left Nav search term
Examples
const { searchTerm } = useNavigation();
const showLink = link === searchterm;
return showLink && <Link>;
A hook that gets the URL's query params and allows you to set them.
import { useQueryParams } from '@newrelic/gatsby-theme-newrelic';
Arguments
There are no arguments for this hook.
Returns
Object
-
queryParams
- an instance ofURLSearchParams
-
setQueryParam
- a function to update a query parameter in the URL. Anologous toqueryParams.set(...)
but this will also navigate for you.
Examples
const SearchInput = () => {
const { queryParams, setQueryParam } = useQueryParams();
return (
<input
type="text"
value={queryParams.get('q')}
onChange={(e) => {
setQueryParam('q', e.target.value);
}}
/>
);
};
A hook that sets document.body.styles.overflow
to hidden
so that no page scrolling is possible while true
has been passed to this hook.
import { useScrollFreeze } from '@newrelic/gatsby-theme-newrelic';
Arguments
-
isFrozen
(boolean): denotes whether the scroll lock feature has been toggled
Returns
none
Examples
// Mobile Navigation
const [isOpen, setIsOpen] = useState(false);
useScrollFreeze(isOpen);
A hook, paired with React's forwardRef
, used to keep a parent and child elements' ref in sync with one another.
import { useSyncedRef } from '@newrelic/gatsby-theme-newrelic';
Arguments
- A
ref
(object | callback)
Returns
- An object
ref
Examples
const Button = forwardRef((props, ref) => {
// keep ref in sync with buttonRef
const buttonRef = useSyncedRef(ref);
useEffect(() => {
buttonRef.current.focus();
}, []);
return <button ref={buttonRef} {...props} />;
});
A hook that returns a translation function or i18n
instance based on the newrelic-gatsby-theme
namespace.
import { useThemeTranslation } from '@newrelic/gatsby-theme-newrelic';
Arguments
none
Returns
-
t
(function): can be used to translate strings based on this repo's theme's namespace -
i18n
(object): set of resources used to help with translations
Examples
const { t } = useThemeTranslation();
console.log(t('this is a translation'));
A hook that runs a function after a specified timeout (i.e. setTimeout
)
import { useTimeout } from '@newrelic/gatsby-theme-newrelic';
Arguments
-
callback
(function): Function to be run afterduration
milliseconds. -
duration
(number): Number of milliseconds to wait before thecallback
is invoked. Setting this value tonull
will reset the timeout to allow it to be used again.
Returns
Void
Examples
const MyComponent = () => {
useTimeout(() => {
console.log('1 second has passed');
}, 1000);
return null;
};
Resetting the timeout
const SpecialButton = () => {
const [active, setActive] = useState(false);
useTimeout(
() => {
setActive(false);
},
active ? 1000 : null
);
return (
<button disabled={active} onClick={() => setActive(true)}>
{active ? 'Activated' : 'Activate'}
</button>
);
};
A hook that gets a generated user ID for the user browsing the site. Useful to provide a stable ID for integration with Google Analytics or split.io.
import { useUserId } from '@newrelic/gatsby-theme-newrelic';
Arguments
none
Returns
String
- The id
of the user browsing the site.
Examples
const MyComponent = () => {
const userId = useUserId();
useEffect(() => {
const trackingId = 'UA-1284...';
ReactGA.initialize(trackingId, {
gaOptions: {
userId,
},
});
}, []);
return null;
};
A hook that gets the previous state of a stateful value. Useful to compare if the state has changed between render cycles.
import { usePrevious } from '@newrelic/gatsby-theme-newrelic';
Arguments
-
value
(any): Value to track its previous state.
Returns
any
- The previous value.
Examples
const MyComponent = () => {
const [count, setCount] = useState(0);
const prevCount = usePrevious(count);
return (
<div>
<span>{`current count is ${count}, previous count is ${prevCount}`}
<button onClick ={()=>setCount(count + 1)}>
</div>
)
}
A hook that will take a test parameter that, if false, will trigger a warning in the console.
import { useWarning } from '@newrelic/gatsby-theme-newrelic';
Arguments
-
test
(any) : Determines if the message is shown in the console -
message
(string): Text to be displayed in the console -
once
(boolean): not required, defaults to true, determines if the warning is shown each timetest
is false, or just once
Returns
none
Examples
const { mobileBreakpoint } = layout;
useWarning(
mobileBreakpoint,
'MobileHeader: The mobile breakpoint is missing. Please set the `layout.mobileBreakpoint` option in `gatsby-config.js`',
{once = false}
);
This theme uses react-i18next
to handle
translations. All modules are re-exported from this theme so that you can use
them in your site.
Example:
import { useTranslation, Trans } from '@newrelic/gatsby-theme-newrelic';
Sites that utilize this theme can specify accouncements that appear at the top
of the site (using the Banner component under the hood).
Announcements can be added by creating .mdx
files in the src/announcements
directory. The first announcement that matches the current date will be shown.
Because announcements use mdx
under the hood, you must ensure that
gatsby-plugin-mdx
is installed and configured.
NOTE: If the src/announcements
directory does not exist, the theme will
create it automatically.
Front matter
key | Required | Format | Description |
---|---|---|---|
startDate |
Yes | YYYY-MM-DD |
The date that the announcement banner should start showing. |
endDate |
Yes | YYYY-MM-DD |
The date the announcement banner should stop showing (end of day). |
Example
---
startDate: 2020-09-01
endDate: 2020-10-20
---
# Example header!
This is some _example_ text.
Utility function that formats a string of code using prettier.
Arguments
-
code
(string): The string of code to be formatted -
options
(object) - optional: Formatting options forwarded toprettier
when formatting the string of code. For a list of all available options, visit the prettier documentation.-
options.language
(string): Tells the function the language of the code that will be formatted through prettier. This is used to detect a suitableparser
for the code. This is recommended if you are not setting theparser
option yourself. If no suitable parser is found for the current language, or if thelanguage
option is not specified, this will fall back to thebabel
parser. For more info on available plugins and parsers, see the Prettier documentation.
Default:
import parserBabel from 'prettier/parser-babel'; const defaultOptions = { trailingComma: 'es5', printWidth: 80, tabWidth: 2, semi: true, singleQuote: true, plugins: [parserBabel], parser: 'babel', };
-
Utility to send data to New Relic as page action events. Will automatically send the anonymous user ID as part of the event tracking via the Local Storage variable ajs_anonymous_id
. Will send the customer ID if the user is denoted as logged in via the Local Storage variable ajs_user_id
Arguments:
- eventName: Camel cased event name to be sent to New Relic.
- category: Title cased category to be sent to New Relic.
- options: Can send any desired key/value pair to New Relic.
Example:
import { addPageAction } from '../utils/nrBrowserAgent.js';
addPageAction({
eventName: 'feedbackRating',
category: `${titleCaseify(feedbackType)}FeedbackClick`,
path: location.pathname,
});
If you are using Jest to write tests for your Gatsby site, you may consider adding some additional configuration to ensure your tests run successfully.
If you are testing your components using snapshot
tests
while using
react-test-renderer
, you may
encounter the following error while trying to render components that use a
portal (such as the Overlay
component):
Warning: An invalid container has been provided. This may indicate that another renderer is being used in addition to the test renderer. (For example, ReactDOM.createPortal inside of a ReactTestRenderer tree.) This is not supported.
As of this writing, there is an outstanding
issue that has not been
addressed in react-test-renderer
. To fix this, you will need to create
a mock for react-dom
to mock the createPortal
API. Add the following to your
project:
// __mocks__/react-dom.js
module.exports = {
...jest.requireActual('react-dom'),
createPortal: (element) => element,
};