BranchName

Alpha

On this page

import {BranchName} from '@primer/react'

BranchName is a label-type component rendered as an <a> tag by default with monospace font.

Examples

<BranchName href="#">a_new_feature_branch</BranchName>

<BranchName href="#">a_new_feature_branch</BranchName>

Name	Type	Default	Description
sx	SystemStyleObject		Style overrides to apply to the component. See also overriding styles.
as	React.ElementType	"a"	The underlying element to render — either a HTML element name or a React component.
ref	React.RefObject<HTMLAnchorElement>		A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the `as` prop.
Additional props are passed to the `<a>` element. See MDN for a list of props accepted by the `<a>` element. If an `as` prop is specified, the accepted props will change accordingly.

Component is used in a production application.
Common usage examples are documented on primer.style/react.
Common usage examples are documented in storybook stories.
Component has been reviewed by a systems designer and any resulting issues have been addressed.
Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Component API has been stable with no breaking changes for at least one month.
Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
Component has corresponding design guidelines documented in the interface guidelines.
Component has corresponding Figma component in the Primer Web library.