Open
Conversation
95e3fca to
a67d036
Compare
|
🐥 |
a67d036 to
516267a
Compare
Dependency Compatibility Matrix
|
c7df984 to
69cbd96
Compare
|
🐥 |
Merged
ab3d5fb to
910521c
Compare
Contributor
Author
|
Attempting to kick off Chromatic... |
910521c to
083ba80
Compare
083ba80 to
600df96
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this change?
Adds the Top Bar Navigation component
Figma
TopBarNavigation
The Top Bar Navigation component is a link to another part of a tool, and also shows the currently navigated page or section.
When to use
Peer dependencies
@emotion/reactreactreact-domtypescriptSee the
peerDependenciessection ofpackage.jsonfor compatible versions.See custom component build for usage without React/Emotion.
Example usage
Props
textstringsize'md'|'sm''md'isSelectedbooleanfalseiconIconProps['symbol']|Exclude<IconProps['children'], string>MaterialSymbolname or a non-stringReactNode(e.g. an SVG element). Size is default.menuChildrenReactNodefalsehrefandonPresswill be ignored if this prop is supplied.hrefstringonPress(e: PressEvent) => voidthemeTopBarNavigationThemecssOverridesSerializedStylesclassNamestringCustomisation
We recommend using the TopBarNavigation component as provided, but it can be customised using the
themeorcssOverridesprops as required.Custom theme
The
themeprop allows you to override specific design tokens for the TopBarNavigation component:CSS overrides
The
cssOverridesprop allows you to pass custom CSS to the TopBarNavigation component:Custom Component Build
If you're not using React/Emotion, you can create a custom TopBarNavigation component using the styles defined in the
TopBarNavigationThemetype.TypeScript/JavaScript
Use the
componentTopBarNavigationvariable and theComponentTopBarNavigationtype:How has this change been tested?
Storybook and Sandbox
Images
Accessibility