PathBar
PathBar(
__namedParameters):ReactElement
Defined in: src/components/navigation/PathBar/PathBar.tsx:44
File-path breadcrumbs, like the VS Code editor breadcrumb bar.
PathBar specializes Breadcrumbs: give it a path — a delimited string
or a structured segment array — and it renders each segment as a crumb.
Folder crumbs navigate on click (onNavigate); the final segment is the
current location. Provide getSiblings to add a VS-Code-style dropdown that
swaps a segment for one of its siblings. Long paths reuse the Breadcrumbs
collapse / ellipsis machinery via maxItems.
The current path is controllable: pass value to drive it, or defaultValue
to let PathBar track it (clicking an ancestor truncates the trail).
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”about?
Section titled “about?”string
accessKey?
Section titled “accessKey?”string
aria-activedescendant?
Section titled “aria-activedescendant?”string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomic?
Section titled “aria-atomic?”Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete?
Section titled “aria-autocomplete?”"none" | "inline" | "both" | "list"
Indicates whether inputting text could trigger display of one or more predictions of the user’s intended value for an input and specifies how predictions would be presented if they are made.
aria-braillelabel?
Section titled “aria-braillelabel?”string
Defines a string value that labels the current element, which is intended to be converted into Braille.
See
aria-label.
aria-brailleroledescription?
Section titled “aria-brailleroledescription?”string
Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
See
aria-roledescription.
aria-busy?
Section titled “aria-busy?”Booleanish
aria-checked?
Section titled “aria-checked?”boolean | "mixed" | "false" | "true"
Indicates the current “checked” state of checkboxes, radio buttons, and other widgets.
See
- aria-pressed
- aria-selected.
aria-colcount?
Section titled “aria-colcount?”number
Defines the total number of columns in a table, grid, or treegrid.
See
aria-colindex.
aria-colindex?
Section titled “aria-colindex?”number
Defines an element’s column index or position with respect to the total number of columns within a table, grid, or treegrid.
See
- aria-colcount
- aria-colspan.
aria-colindextext?
Section titled “aria-colindextext?”string
Defines a human readable text alternative of aria-colindex.
See
aria-rowindextext.
aria-colspan?
Section titled “aria-colspan?”number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
See
- aria-colindex
- aria-rowspan.
aria-controls?
Section titled “aria-controls?”string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
See
aria-owns.
aria-current?
Section titled “aria-current?”boolean | "location" | "page" | "false" | "true" | "step" | "date" | "time"
Indicates the element that represents the current item within a container or set of related elements.
aria-describedby?
Section titled “aria-describedby?”string
Identifies the element (or elements) that describes the object.
See
aria-labelledby
aria-description?
Section titled “aria-description?”string
Defines a string value that describes or annotates the current element.
See
related aria-describedby.
aria-details?
Section titled “aria-details?”string
Identifies the element that provides a detailed, extended description for the object.
See
aria-describedby.
aria-disabled?
Section titled “aria-disabled?”Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
See
- aria-hidden
- aria-readonly.
aria-dropeffect?
Section titled “aria-dropeffect?”"none" | "link" | "copy" | "move" | "execute" | "popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessage?
Section titled “aria-errormessage?”string
Identifies the element that provides an error message for the object.
See
- aria-invalid
- aria-describedby.
aria-expanded?
Section titled “aria-expanded?”Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowto?
Section titled “aria-flowto?”string
Identifies the next element (or elements) in an alternate reading order of content which, at the user’s discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbed?
Section titled “aria-grabbed?”Booleanish
Indicates an element’s “grabbed” state in a drag-and-drop operation.
aria-haspopup?
Section titled “aria-haspopup?”boolean | "grid" | "listbox" | "menu" | "false" | "true" | "dialog" | "tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hidden?
Section titled “aria-hidden?”Booleanish
Indicates whether the element is exposed to an accessibility API.
See
aria-disabled.
aria-invalid?
Section titled “aria-invalid?”boolean | "false" | "true" | "grammar" | "spelling"
Indicates the entered value does not conform to the format expected by the application.
See
aria-errormessage.
aria-keyshortcuts?
Section titled “aria-keyshortcuts?”string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-label?
Section titled “aria-label?”string
Defines a string value that labels the current element.
See
aria-labelledby.
aria-labelledby?
Section titled “aria-labelledby?”string
Identifies the element (or elements) that labels the current element.
See
aria-describedby.
aria-level?
Section titled “aria-level?”number
Defines the hierarchical level of an element within a structure.
aria-live?
Section titled “aria-live?”"off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modal?
Section titled “aria-modal?”Booleanish
Indicates whether an element is modal when displayed.
aria-multiline?
Section titled “aria-multiline?”Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectable?
Section titled “aria-multiselectable?”Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation?
Section titled “aria-orientation?”"horizontal" | "vertical"
Indicates whether the element’s orientation is horizontal, vertical, or unknown/ambiguous.
aria-owns?
Section titled “aria-owns?”string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
See
aria-controls.
aria-placeholder?
Section titled “aria-placeholder?”string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinset?
Section titled “aria-posinset?”number
Defines an element’s number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
See
aria-setsize.
aria-pressed?
Section titled “aria-pressed?”boolean | "mixed" | "false" | "true"
Indicates the current “pressed” state of toggle buttons.
See
- aria-checked
- aria-selected.
aria-readonly?
Section titled “aria-readonly?”Booleanish
Indicates that the element is not editable, but is otherwise operable.
See
aria-disabled.
aria-relevant?
Section titled “aria-relevant?”"text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
See
aria-atomic.
aria-required?
Section titled “aria-required?”Booleanish
Indicates that user input is required on the element before a form may be submitted.
aria-roledescription?
Section titled “aria-roledescription?”string
Defines a human-readable, author-localized description for the role of an element.
aria-rowcount?
Section titled “aria-rowcount?”number
Defines the total number of rows in a table, grid, or treegrid.
See
aria-rowindex.
aria-rowindex?
Section titled “aria-rowindex?”number
Defines an element’s row index or position with respect to the total number of rows within a table, grid, or treegrid.
See
- aria-rowcount
- aria-rowspan.
aria-rowindextext?
Section titled “aria-rowindextext?”string
Defines a human readable text alternative of aria-rowindex.
See
aria-colindextext.
aria-rowspan?
Section titled “aria-rowspan?”number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
See
- aria-rowindex
- aria-colspan.
aria-selected?
Section titled “aria-selected?”Booleanish
Indicates the current “selected” state of various widgets.
See
- aria-checked
- aria-pressed.
aria-setsize?
Section titled “aria-setsize?”number
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
See
aria-posinset.
aria-sort?
Section titled “aria-sort?”"none" | "ascending" | "descending" | "other"
Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemax?
Section titled “aria-valuemax?”number
Defines the maximum allowed value for a range widget.
aria-valuemin?
Section titled “aria-valuemin?”number
Defines the minimum allowed value for a range widget.
aria-valuenow?
Section titled “aria-valuenow?”number
Defines the current value for a range widget.
See
aria-valuetext.
aria-valuetext?
Section titled “aria-valuetext?”string
Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize?
Section titled “autoCapitalize?”"none" | string & object | "off" | "on" | "sentences" | "words" | "characters"
autoCorrect?
Section titled “autoCorrect?”string
autoFocus?
Section titled “autoFocus?”boolean
autoSave?
Section titled “autoSave?”string
children?
Section titled “children?”ReactNode
className?
Section titled “className?”string
Additional CSS class names
color?
Section titled “color?”string
content?
Section titled “content?”string
contentEditable?
Section titled “contentEditable?”"inherit" | Booleanish | "plaintext-only"
contextMenu?
Section titled “contextMenu?”string
dangerouslySetInnerHTML?
Section titled “dangerouslySetInnerHTML?”{ __html: string | TrustedHTML; }
dangerouslySetInnerHTML.__html
Section titled “dangerouslySetInnerHTML.__html”string | TrustedHTML
datatype?
Section titled “datatype?”string
defaultChecked?
Section titled “defaultChecked?”boolean
defaultValue?
Section titled “defaultValue?”Uncontrolled initial path. PathBar then tracks the current path itself: navigating to an ancestor truncates the trail; picking a sibling swaps the segment.
delimiter?
Section titled “delimiter?”string = '/'
Delimiter used to split string paths and to join cumulative navigation values.
Default
"/"string
draggable?
Section titled “draggable?”Booleanish
enterKeyHint?
Section titled “enterKeyHint?”"search" | "next" | "enter" | "done" | "go" | "previous" | "send"
expandable?
Section titled “expandable?”boolean
Render the ellipsis as a clickable button that expands to show all items.
Default
trueexportparts?
Section titled “exportparts?”string
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts
getSiblings?
Section titled “getSiblings?”(segment, index) => readonly (string | PathSegment)[]
Return the sibling entries for a segment to enable a dropdown picker on
that crumb. Return an empty array (or omit the prop) to leave a segment
without a dropdown. Choosing a sibling fires onNavigate with that
sibling’s value.
hidden?
Section titled “hidden?”boolean
string
Unique identifier for the component
inert?
Section titled “inert?”boolean
See
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
inlist?
Section titled “inlist?”any
inputMode?
Section titled “inputMode?”"text" | "none" | "search" | "tel" | "url" | "email" | "numeric" | "decimal"
Hints at the type of data that might be entered by the user while editing the element or its contents
See
https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
string
Specify that a standard HTML element should behave like a defined custom built-in element
See
https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is
itemID?
Section titled “itemID?”string
itemProp?
Section titled “itemProp?”string
itemRef?
Section titled “itemRef?”string
itemsAfterCollapse?
Section titled “itemsAfterCollapse?”number
Number of items to keep visible at the end when collapsing.
Default
2itemsBeforeCollapse?
Section titled “itemsBeforeCollapse?”number
Number of items to keep visible at the start when collapsing.
Default
1itemScope?
Section titled “itemScope?”boolean
itemType?
Section titled “itemType?”string
string
maxItems?
Section titled “maxItems?”number
Maximum number of items to show before collapsing the middle into an ellipsis.
0 or undefined never collapses.
Default
0nonce?
Section titled “nonce?”string
onAbort?
Section titled “onAbort?”ReactEventHandler<HTMLElement>
onAbortCapture?
Section titled “onAbortCapture?”ReactEventHandler<HTMLElement>
onAnimationEnd?
Section titled “onAnimationEnd?”AnimationEventHandler<HTMLElement>
onAnimationEndCapture?
Section titled “onAnimationEndCapture?”AnimationEventHandler<HTMLElement>
onAnimationIteration?
Section titled “onAnimationIteration?”AnimationEventHandler<HTMLElement>
onAnimationIterationCapture?
Section titled “onAnimationIterationCapture?”AnimationEventHandler<HTMLElement>
onAnimationStart?
Section titled “onAnimationStart?”AnimationEventHandler<HTMLElement>
onAnimationStartCapture?
Section titled “onAnimationStartCapture?”AnimationEventHandler<HTMLElement>
onAuxClick?
Section titled “onAuxClick?”MouseEventHandler<HTMLElement>
onAuxClickCapture?
Section titled “onAuxClickCapture?”MouseEventHandler<HTMLElement>
onBeforeInput?
Section titled “onBeforeInput?”InputEventHandler<HTMLElement>
onBeforeInputCapture?
Section titled “onBeforeInputCapture?”InputEventHandler<HTMLElement>
onBeforeToggle?
Section titled “onBeforeToggle?”ToggleEventHandler<HTMLElement>
onBlur?
Section titled “onBlur?”FocusEventHandler<HTMLElement>
onBlurCapture?
Section titled “onBlurCapture?”FocusEventHandler<HTMLElement>
onCanPlay?
Section titled “onCanPlay?”ReactEventHandler<HTMLElement>
onCanPlayCapture?
Section titled “onCanPlayCapture?”ReactEventHandler<HTMLElement>
onCanPlayThrough?
Section titled “onCanPlayThrough?”ReactEventHandler<HTMLElement>
onCanPlayThroughCapture?
Section titled “onCanPlayThroughCapture?”ReactEventHandler<HTMLElement>
onChangeCapture?
Section titled “onChangeCapture?”ChangeEventHandler<HTMLElement, Element>
onClick?
Section titled “onClick?”MouseEventHandler<HTMLElement>
onClickCapture?
Section titled “onClickCapture?”MouseEventHandler<HTMLElement>
onCompositionEnd?
Section titled “onCompositionEnd?”CompositionEventHandler<HTMLElement>
onCompositionEndCapture?
Section titled “onCompositionEndCapture?”CompositionEventHandler<HTMLElement>
onCompositionStart?
Section titled “onCompositionStart?”CompositionEventHandler<HTMLElement>
onCompositionStartCapture?
Section titled “onCompositionStartCapture?”CompositionEventHandler<HTMLElement>
onCompositionUpdate?
Section titled “onCompositionUpdate?”CompositionEventHandler<HTMLElement>
onCompositionUpdateCapture?
Section titled “onCompositionUpdateCapture?”CompositionEventHandler<HTMLElement>
onContextMenu?
Section titled “onContextMenu?”MouseEventHandler<HTMLElement>
onContextMenuCapture?
Section titled “onContextMenuCapture?”MouseEventHandler<HTMLElement>
onCopy?
Section titled “onCopy?”ClipboardEventHandler<HTMLElement>
onCopyCapture?
Section titled “onCopyCapture?”ClipboardEventHandler<HTMLElement>
onCut?
Section titled “onCut?”ClipboardEventHandler<HTMLElement>
onCutCapture?
Section titled “onCutCapture?”ClipboardEventHandler<HTMLElement>
onDoubleClick?
Section titled “onDoubleClick?”MouseEventHandler<HTMLElement>
onDoubleClickCapture?
Section titled “onDoubleClickCapture?”MouseEventHandler<HTMLElement>
onDrag?
Section titled “onDrag?”DragEventHandler<HTMLElement>
onDragCapture?
Section titled “onDragCapture?”DragEventHandler<HTMLElement>
onDragEnd?
Section titled “onDragEnd?”DragEventHandler<HTMLElement>
onDragEndCapture?
Section titled “onDragEndCapture?”DragEventHandler<HTMLElement>
onDragEnter?
Section titled “onDragEnter?”DragEventHandler<HTMLElement>
onDragEnterCapture?
Section titled “onDragEnterCapture?”DragEventHandler<HTMLElement>
onDragExit?
Section titled “onDragExit?”DragEventHandler<HTMLElement>
onDragExitCapture?
Section titled “onDragExitCapture?”DragEventHandler<HTMLElement>
onDragLeave?
Section titled “onDragLeave?”DragEventHandler<HTMLElement>
onDragLeaveCapture?
Section titled “onDragLeaveCapture?”DragEventHandler<HTMLElement>
onDragOver?
Section titled “onDragOver?”DragEventHandler<HTMLElement>
onDragOverCapture?
Section titled “onDragOverCapture?”DragEventHandler<HTMLElement>
onDragStart?
Section titled “onDragStart?”DragEventHandler<HTMLElement>
onDragStartCapture?
Section titled “onDragStartCapture?”DragEventHandler<HTMLElement>
onDrop?
Section titled “onDrop?”DragEventHandler<HTMLElement>
onDropCapture?
Section titled “onDropCapture?”DragEventHandler<HTMLElement>
onDurationChange?
Section titled “onDurationChange?”ReactEventHandler<HTMLElement>
onDurationChangeCapture?
Section titled “onDurationChangeCapture?”ReactEventHandler<HTMLElement>
onEmptied?
Section titled “onEmptied?”ReactEventHandler<HTMLElement>
onEmptiedCapture?
Section titled “onEmptiedCapture?”ReactEventHandler<HTMLElement>
onEncrypted?
Section titled “onEncrypted?”ReactEventHandler<HTMLElement>
onEncryptedCapture?
Section titled “onEncryptedCapture?”ReactEventHandler<HTMLElement>
onEnded?
Section titled “onEnded?”ReactEventHandler<HTMLElement>
onEndedCapture?
Section titled “onEndedCapture?”ReactEventHandler<HTMLElement>
onError?
Section titled “onError?”ReactEventHandler<HTMLElement>
onErrorCapture?
Section titled “onErrorCapture?”ReactEventHandler<HTMLElement>
onFocus?
Section titled “onFocus?”FocusEventHandler<HTMLElement>
onFocusCapture?
Section titled “onFocusCapture?”FocusEventHandler<HTMLElement>
onGotPointerCapture?
Section titled “onGotPointerCapture?”PointerEventHandler<HTMLElement>
onGotPointerCaptureCapture?
Section titled “onGotPointerCaptureCapture?”PointerEventHandler<HTMLElement>
onInput?
Section titled “onInput?”InputEventHandler<HTMLElement>
onInputCapture?
Section titled “onInputCapture?”InputEventHandler<HTMLElement>
onInvalid?
Section titled “onInvalid?”ReactEventHandler<HTMLElement>
onInvalidCapture?
Section titled “onInvalidCapture?”ReactEventHandler<HTMLElement>
onKeyDown?
Section titled “onKeyDown?”KeyboardEventHandler<HTMLElement>
onKeyDownCapture?
Section titled “onKeyDownCapture?”KeyboardEventHandler<HTMLElement>
onKeyPress?
Section titled “onKeyPress?”KeyboardEventHandler<HTMLElement>
onKeyPressCapture?
Section titled “onKeyPressCapture?”KeyboardEventHandler<HTMLElement>
onKeyUp?
Section titled “onKeyUp?”KeyboardEventHandler<HTMLElement>
onKeyUpCapture?
Section titled “onKeyUpCapture?”KeyboardEventHandler<HTMLElement>
onLoad?
Section titled “onLoad?”ReactEventHandler<HTMLElement>
onLoadCapture?
Section titled “onLoadCapture?”ReactEventHandler<HTMLElement>
onLoadedData?
Section titled “onLoadedData?”ReactEventHandler<HTMLElement>
onLoadedDataCapture?
Section titled “onLoadedDataCapture?”ReactEventHandler<HTMLElement>
onLoadedMetadata?
Section titled “onLoadedMetadata?”ReactEventHandler<HTMLElement>
onLoadedMetadataCapture?
Section titled “onLoadedMetadataCapture?”ReactEventHandler<HTMLElement>
onLoadStart?
Section titled “onLoadStart?”ReactEventHandler<HTMLElement>
onLoadStartCapture?
Section titled “onLoadStartCapture?”ReactEventHandler<HTMLElement>
onLostPointerCapture?
Section titled “onLostPointerCapture?”PointerEventHandler<HTMLElement>
onLostPointerCaptureCapture?
Section titled “onLostPointerCaptureCapture?”PointerEventHandler<HTMLElement>
onMouseDown?
Section titled “onMouseDown?”MouseEventHandler<HTMLElement>
onMouseDownCapture?
Section titled “onMouseDownCapture?”MouseEventHandler<HTMLElement>
onMouseEnter?
Section titled “onMouseEnter?”MouseEventHandler<HTMLElement>
onMouseLeave?
Section titled “onMouseLeave?”MouseEventHandler<HTMLElement>
onMouseMove?
Section titled “onMouseMove?”MouseEventHandler<HTMLElement>
onMouseMoveCapture?
Section titled “onMouseMoveCapture?”MouseEventHandler<HTMLElement>
onMouseOut?
Section titled “onMouseOut?”MouseEventHandler<HTMLElement>
onMouseOutCapture?
Section titled “onMouseOutCapture?”MouseEventHandler<HTMLElement>
onMouseOver?
Section titled “onMouseOver?”MouseEventHandler<HTMLElement>
onMouseOverCapture?
Section titled “onMouseOverCapture?”MouseEventHandler<HTMLElement>
onMouseUp?
Section titled “onMouseUp?”MouseEventHandler<HTMLElement>
onMouseUpCapture?
Section titled “onMouseUpCapture?”MouseEventHandler<HTMLElement>
onNavigate?
Section titled “onNavigate?”(path, segment, index) => void
Called when a segment is activated — by clicking a folder crumb or by
choosing an entry from a segment’s sibling dropdown. path is the
activated segment’s navigation value.
onPaste?
Section titled “onPaste?”ClipboardEventHandler<HTMLElement>
onPasteCapture?
Section titled “onPasteCapture?”ClipboardEventHandler<HTMLElement>
onPause?
Section titled “onPause?”ReactEventHandler<HTMLElement>
onPauseCapture?
Section titled “onPauseCapture?”ReactEventHandler<HTMLElement>
onPlay?
Section titled “onPlay?”ReactEventHandler<HTMLElement>
onPlayCapture?
Section titled “onPlayCapture?”ReactEventHandler<HTMLElement>
onPlaying?
Section titled “onPlaying?”ReactEventHandler<HTMLElement>
onPlayingCapture?
Section titled “onPlayingCapture?”ReactEventHandler<HTMLElement>
onPointerCancel?
Section titled “onPointerCancel?”PointerEventHandler<HTMLElement>
onPointerCancelCapture?
Section titled “onPointerCancelCapture?”PointerEventHandler<HTMLElement>
onPointerDown?
Section titled “onPointerDown?”PointerEventHandler<HTMLElement>
onPointerDownCapture?
Section titled “onPointerDownCapture?”PointerEventHandler<HTMLElement>
onPointerEnter?
Section titled “onPointerEnter?”PointerEventHandler<HTMLElement>
onPointerLeave?
Section titled “onPointerLeave?”PointerEventHandler<HTMLElement>
onPointerMove?
Section titled “onPointerMove?”PointerEventHandler<HTMLElement>
onPointerMoveCapture?
Section titled “onPointerMoveCapture?”PointerEventHandler<HTMLElement>
onPointerOut?
Section titled “onPointerOut?”PointerEventHandler<HTMLElement>
onPointerOutCapture?
Section titled “onPointerOutCapture?”PointerEventHandler<HTMLElement>
onPointerOver?
Section titled “onPointerOver?”PointerEventHandler<HTMLElement>
onPointerOverCapture?
Section titled “onPointerOverCapture?”PointerEventHandler<HTMLElement>
onPointerUp?
Section titled “onPointerUp?”PointerEventHandler<HTMLElement>
onPointerUpCapture?
Section titled “onPointerUpCapture?”PointerEventHandler<HTMLElement>
onProgress?
Section titled “onProgress?”ReactEventHandler<HTMLElement>
onProgressCapture?
Section titled “onProgressCapture?”ReactEventHandler<HTMLElement>
onRateChange?
Section titled “onRateChange?”ReactEventHandler<HTMLElement>
onRateChangeCapture?
Section titled “onRateChangeCapture?”ReactEventHandler<HTMLElement>
onReset?
Section titled “onReset?”ReactEventHandler<HTMLElement>
onResetCapture?
Section titled “onResetCapture?”ReactEventHandler<HTMLElement>
onScroll?
Section titled “onScroll?”UIEventHandler<HTMLElement>
onScrollCapture?
Section titled “onScrollCapture?”UIEventHandler<HTMLElement>
onScrollEnd?
Section titled “onScrollEnd?”UIEventHandler<HTMLElement>
onScrollEndCapture?
Section titled “onScrollEndCapture?”UIEventHandler<HTMLElement>
onSeeked?
Section titled “onSeeked?”ReactEventHandler<HTMLElement>
onSeekedCapture?
Section titled “onSeekedCapture?”ReactEventHandler<HTMLElement>
onSeeking?
Section titled “onSeeking?”ReactEventHandler<HTMLElement>
onSeekingCapture?
Section titled “onSeekingCapture?”ReactEventHandler<HTMLElement>
onSelect?
Section titled “onSelect?”ReactEventHandler<HTMLElement>
onSelectCapture?
Section titled “onSelectCapture?”ReactEventHandler<HTMLElement>
onStalled?
Section titled “onStalled?”ReactEventHandler<HTMLElement>
onStalledCapture?
Section titled “onStalledCapture?”ReactEventHandler<HTMLElement>
onSubmit?
Section titled “onSubmit?”SubmitEventHandler<HTMLElement>
onSubmitCapture?
Section titled “onSubmitCapture?”SubmitEventHandler<HTMLElement>
onSuspend?
Section titled “onSuspend?”ReactEventHandler<HTMLElement>
onSuspendCapture?
Section titled “onSuspendCapture?”ReactEventHandler<HTMLElement>
onTimeUpdate?
Section titled “onTimeUpdate?”ReactEventHandler<HTMLElement>
onTimeUpdateCapture?
Section titled “onTimeUpdateCapture?”ReactEventHandler<HTMLElement>
onToggle?
Section titled “onToggle?”ToggleEventHandler<HTMLElement>
onTouchCancel?
Section titled “onTouchCancel?”TouchEventHandler<HTMLElement>
onTouchCancelCapture?
Section titled “onTouchCancelCapture?”TouchEventHandler<HTMLElement>
onTouchEnd?
Section titled “onTouchEnd?”TouchEventHandler<HTMLElement>
onTouchEndCapture?
Section titled “onTouchEndCapture?”TouchEventHandler<HTMLElement>
onTouchMove?
Section titled “onTouchMove?”TouchEventHandler<HTMLElement>
onTouchMoveCapture?
Section titled “onTouchMoveCapture?”TouchEventHandler<HTMLElement>
onTouchStart?
Section titled “onTouchStart?”TouchEventHandler<HTMLElement>
onTouchStartCapture?
Section titled “onTouchStartCapture?”TouchEventHandler<HTMLElement>
onTransitionCancel?
Section titled “onTransitionCancel?”TransitionEventHandler<HTMLElement>
onTransitionCancelCapture?
Section titled “onTransitionCancelCapture?”TransitionEventHandler<HTMLElement>
onTransitionEnd?
Section titled “onTransitionEnd?”TransitionEventHandler<HTMLElement>
onTransitionEndCapture?
Section titled “onTransitionEndCapture?”TransitionEventHandler<HTMLElement>
onTransitionRun?
Section titled “onTransitionRun?”TransitionEventHandler<HTMLElement>
onTransitionRunCapture?
Section titled “onTransitionRunCapture?”TransitionEventHandler<HTMLElement>
onTransitionStart?
Section titled “onTransitionStart?”TransitionEventHandler<HTMLElement>
onTransitionStartCapture?
Section titled “onTransitionStartCapture?”TransitionEventHandler<HTMLElement>
onVolumeChange?
Section titled “onVolumeChange?”ReactEventHandler<HTMLElement>
onVolumeChangeCapture?
Section titled “onVolumeChangeCapture?”ReactEventHandler<HTMLElement>
onWaiting?
Section titled “onWaiting?”ReactEventHandler<HTMLElement>
onWaitingCapture?
Section titled “onWaitingCapture?”ReactEventHandler<HTMLElement>
onWheel?
Section titled “onWheel?”WheelEventHandler<HTMLElement>
onWheelCapture?
Section titled “onWheelCapture?”WheelEventHandler<HTMLElement>
string
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part
popover?
Section titled “popover?”"" | "auto" | "manual" | "hint"
popoverTarget?
Section titled “popoverTarget?”string
popoverTargetAction?
Section titled “popoverTargetAction?”"toggle" | "hide" | "show"
prefix?
Section titled “prefix?”string
property?
Section titled “property?”string
radioGroup?
Section titled “radioGroup?”string
Ref<HTMLElement>
string
resource?
Section titled “resource?”string
results?
Section titled “results?”number
string
AriaRole
rootIcon?
Section titled “rootIcon?”ReactNode
Icon rendered before the first segment when that segment has no icon of
its own — typically a workspace or home glyph.
security?
Section titled “security?”string
separator?
Section titled “separator?”ReactNode
Separator inserted between segments. The default chevron scales with
size.
Default
<ChevronRightIcon size={size} decorative />Size = 'sm'
Typography and spacing scale. Also scales the default separator and the sibling-dropdown caret.
Default
"sm"string
spellCheck?
Section titled “spellCheck?”Booleanish
style?
Section titled “style?”CSSProperties
Custom inline styles
suppressContentEditableWarning?
Section titled “suppressContentEditableWarning?”boolean
suppressHydrationWarning?
Section titled “suppressHydrationWarning?”boolean
tabIndex?
Section titled “tabIndex?”number
testId?
Section titled “testId?”string
Test identifier for automated testing
title?
Section titled “title?”string
translate?
Section titled “translate?”"yes" | "no"
typeof?
Section titled “typeof?”string
unselectable?
Section titled “unselectable?”"off" | "on"
value?
Section titled “value?”Controlled current path. When provided, PathBar renders exactly this path
and never mutates it — drive changes from onNavigate.
vocab?
Section titled “vocab?”string
Returns
Section titled “Returns”ReactElement
Example
Section titled “Example”<PathBar defaultValue="src/components/Button/Button.tsx" rootIcon={<HomeIcon size="sm" decorative />} onNavigate={path => router.push(path)}/>