Add anchor targets to our headings. (#1571)
Add anchor target for our headings. Makes it much easier to share a link to a specific part of the page. ### Change Type - [x] `documentation` — Changes to the documentation only ### Test Plan 1. Open the docs page. 2. The headings should now be anchors to this part of the page. ### Release Notes - Improve documentation to include anchor targets.
This commit is contained in:
parent
7b03ef9d0c
commit
edd393353e
1 changed files with 23 additions and 6 deletions
|
@ -1,5 +1,7 @@
|
|||
/* ---------------------- Lists --------------------- */
|
||||
|
||||
import React from 'react'
|
||||
|
||||
export const UnorderedList = (props: any) => {
|
||||
return <ul {...props} />
|
||||
}
|
||||
|
@ -14,28 +16,43 @@ export const ListItem = (props: any) => {
|
|||
|
||||
/* ------------------- Typography ------------------- */
|
||||
|
||||
type Heading = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'
|
||||
|
||||
function heading(heading: Heading, props: any) {
|
||||
const Element = ({ ...props }) => React.createElement(heading, props)
|
||||
if (props.id) {
|
||||
return (
|
||||
<Element {...props}>
|
||||
<a href={`#${props.id}`}>{props.children}</a>
|
||||
</Element>
|
||||
)
|
||||
}
|
||||
|
||||
return <Element {...props} />
|
||||
}
|
||||
|
||||
export const Heading1 = (props: any) => {
|
||||
return <h1 {...props} />
|
||||
return heading('h1', props)
|
||||
}
|
||||
|
||||
export const Heading2 = (props: any) => {
|
||||
return <h2 {...props} />
|
||||
return heading('h2', props)
|
||||
}
|
||||
|
||||
export const Heading3 = (props: any) => {
|
||||
return <h3 {...props} />
|
||||
return heading('h3', props)
|
||||
}
|
||||
|
||||
export const Heading4 = (props: any) => {
|
||||
return <h4 {...props} />
|
||||
return heading('h4', props)
|
||||
}
|
||||
|
||||
export const Heading5 = (props: any) => {
|
||||
return <h5 {...props} />
|
||||
return heading('h5', props)
|
||||
}
|
||||
|
||||
export const Heading6 = (props: any) => {
|
||||
return <h6 {...props} />
|
||||
return heading('h6', props)
|
||||
}
|
||||
|
||||
export const Paragraph = (props: any) => {
|
||||
|
|
Loading…
Reference in a new issue