Minimal footer

Use the minimal footer component to provide a global footer featuring legal links, GitHub logomarks and footnotes.
  • Experimental
  • Not reviewed for accessibility
import {MinimalFooter} from '@primer/react-brand'

Examples

Default

Footnotes

MinimalFooter will render all supported social links by default. Social links can be removed however, by passing socialLinks={false}. Alteratively, pass an array of valid social links to filter the default list.

Component props

MinimalFooter

NameTypeDefaultDescription
classNamestringSets a custom class on the root element
children'MinimalFooter.Link'
'MinimalFooter.Footnotes'
undefinedValid child components
copyrightStatementstring | ReactElementThe copyright statement to be displayed in the footer.
logoHrefstring'https://github.com'The href for the GitHub logo.
socialLinks['x', 'github', 'linkedin', 'youtube', 'facebook', 'twitch', 'tiktok', 'instagram'] | false['x', 'github', 'linkedin', 'youtube', 'facebook', 'twitch', 'tiktok', 'instagram']Array of valid strings or false to hide all links
NameTypeDefaultDescription
as'a', 'button''a'Applies the underlying HTML element
childrenstringundefinedLink label text

MinimalFooter.Footnotes

NameTypeDefaultDescription
childrenReactElementundefinedUse Primer Brand Text components to benefit from inherited styling.