API reference
components/navigation-rail
Import
Section titled “Import”import * as api from "@fungi.computer/caps/components/navigation-rail";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | NavigationRailProps | Props accepted by NavigationRail. |
| constant | NavigationRail | A horizontal navigation list that signals when links continue off-screen. |
NavigationRailPropstype alias
Section titled “NavigationRailProps”type NavigationRailProps = HTMLAttributes<HTMLElement> & object;Props accepted by NavigationRail.
Type Declaration
Section titled “Type Declaration”| Name | Type | Description |
|---|---|---|
fitAtWide? |
boolean |
Let a long rail fit across wide layouts while retaining mobile scrolling. |
NavigationRailconstant
Section titled “NavigationRail”const NavigationRail: ForwardRefExoticComponent< HTMLAttributes<HTMLElement> & object & RefAttributes<HTMLElement>>;A horizontal navigation list that signals when links continue off-screen.