NProgress
@stellaria/nebula-webNProgressPropsPreview
Props
8| Prop | Type | Default |
|---|---|---|
className | string | — |
color The scale the bar is drawn from, at the 500 step. | ColorExtended | "primary" |
height How thick the bar is, in pixels. | number | 3 |
label What is announced while the bar runs. The bar itself is a thin line with no text, so this is the whole of what a screen reader gets. English by default (ADR-120). | string | "Loading the page" |
loading Whether the bar is running. Without a `value` this is the whole control: turning it on starts the bar creeping and turning it off unmounts it. | boolean | false |
value The percentage, controlled. Passing it takes over from the automatic creep entirely — and it also keeps the bar mounted once `loading` goes false, so a controlled bar has to be unmounted by its parent when the work ends. | number | — |
withinPortal Renders through a portal, which is what keeps the bar pinned to the top of the viewport rather than to whatever region happens to contain it. | boolean | true |
zIndex Where it sits in the stack. It starts above the affix range so a page-level bar stays visible over floating content. | number | 400 |
Also accepts
On top of its own props, this component forwards these groups.