/

<GlossaryPage> Component

This is a specialized view built on top of DocsPage to render a glossary page on our docs sites.

Share
Code Editor
<GlossaryPage product={{ name: 'Consul', slug: 'consul' }} staticProps={staticPropsResult} />

Where it's used

Latest:2.5.9
Search with

Releases

Latest:2.5.9
registry.npmjs.org
[object Object]
0.x.x
Loading 0.x.x releases...
1.x.x
Loading 1.x.x releases...
2.x.x
Loading 2.x.x releases...

Props

NameDescription
product
object
Name and slug of the product this page is being rendered for
Object contains nested props, see below:
product.name
string
Human-readable proper case product name
product.slug
string
HashiCorp product slug
Options: "hashicorp", "boundary", "consul", "nomad", "packer", "terraform", "vault", "vagrant", "waypoint"
additionalComponents
object
Object containing additional components to be made available within mdx pages. Uses the format { [key]: Component }, for example, { TestComponent: () => <p>hello world</p> }
showEditPage
boolean
if true, an "edit this page" link will appear on the bottom right
staticProps
object
Directly pass the return value of server/generateStaticProps in here.
Object contains nested props, see below:
staticProps.terms
array
A list of glossary terms, passed to <GlossaryTableOfContents />
Array members must be of the type below:
staticProps.terms[x]
object
A glossary term item
Object contains nested props, see below:
staticProps.terms[x].slug
string
The term's slug, used to construct an anchor link
staticProps.terms[x].title
string
The term's title, used to label an anchor link to the term
staticProps.githubFileUrl
string
A link to the page's associated .mdx file on GitHub. Used for the Edit this page link.
staticProps.mdxSource*
object
Data returned from running next-mdx-remote/serialize on the page's .mdx file contents.
staticProps.navData*
object
Tree of navigation data to render. See docs-sidenav/types.js for details.