HeaderComponent
import Example from ‘../../src/@primer/gatsby-theme-doctocat/components/example’
Represents the top navigation bar on every page.
Arguments
Name | Type | Default | Description |
---|---|---|---|
classes |
String |
"" |
Classes and attributes |
attributes |
Hash |
{} |
Classes and attributes |
Slots
Logo
Leading visuals at the far left of the header. You can pass either
src
or as_text
but not both.
Name | Type | Default | Description |
---|---|---|---|
href |
String |
N/A | Where the logo should link to. |
src |
String |
N/A | The URL of the image logo. |
alt |
String |
N/A | Alt text for accessibility. |
text |
Boolean |
N/A | The text to display |
classes |
String |
N/A | Classes and attributes |
attributes |
Hash |
N/A | Classes and attributes |
Navigation_links
Action_links
Text within the header, representing actions.
Name | Type | Default | Description |
---|---|---|---|
tag |
String, Symbol |
N/A | The tag to use for the link. |
href |
String |
N/A | The link destination. |
classes |
String |
N/A | Classes and attributes |
attributes |
Hash |
N/A | Classes and attributes |
Signup_link
Profile_link
Examples
Basic example
Have questions?
Still have questions? Talk to support.