Spinner
BitSpinner is an outline of a circle which animates around itself indicating to the user that things are processing. A Spinner is shown when it's unsure how long a task will take making it the indeterminate version of a ProgressIndicator. They can be various sizes, located inline with content or centered. They generally appear after an action is being processed or committed. They are subtle and generally do not take up much space, but are transitions from the completed task.
Usage
BitSpinner
To create a spinner, you can use a BitSpinner component.
Label positioning
By setting LabelPosition attribute, change position of spinner to bottom, top, left or right.
I am definitely loading...
Seriously, still loading...
Wait, wait...
Nope, still loading...
Implementation
BitSpinner parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| AriaLive | BitSpinnerAriaLive | BitSpinnerAriaLive.Polite | Politeness setting for label update announcement. |
| Label | string? | null | The label to show next to the spinner. Label updates will be announced to the screen readers. |
| LabelPosition | BitLabelPosition | BitLabelPosition.Top | The position of the label in regards to the spinner animation. |
| Size | BitSpinnerSize | BitSpinnerSize.Medium | The size of spinner to render. |
BitComponentBase parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| AriaLabel | string? | null | The aria-label of the control for the benefit of screen readers. |
| Class | string? | null | Custom CSS class for the root element of the component. |
| HtmlAttributes | Dictionary<string, object> | new Dictionary<string, object>() | Capture and render additional attributes in addition to the component's parameters. |
| Id | string? | null | Custom id attribute for the root element. if null the UniqueId will be used instead. |
| IsEnabled | bool | true | Whether or not the component is enabled. |
| Style | string? | null | Custom CSS style for the root element of the component. |
| Visibility | BitVisibility | BitVisibility.Visible | Whether the component is visible, hidden or collapsed. |
BitComponentBase public members
Name |
Type |
Default value |
Description |
|---|---|---|---|
| UniqueId | Guid | Guid.NewGuid() | The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction. |
| RootElement | ElementReference | The ElementReference of the root element. |
BitSpinnerAriaLive enum
Name |
Value |
Description |
|---|---|---|
| Assertive | 0 | |
| Polite | 1 | |
| Off | 2 |
BitLabelPosition enum
Name |
Value |
Description |
|---|---|---|
| Top | 0 | The label shows on the top of the spinner. |
| Right | 1 | The label shows on the right side of the spinner. |
| Bottom | 2 | The label shows on the bottom of the spinner. |
| Left | 3 | The label shows on the left side of the spinner. |
BitSpinnerSize enum
Name |
Value |
Description |
|---|---|---|
| Medium | 0 | 20px Spinner diameter. |
| Large | 1 | 28px Spinner diameter. |
| Small | 2 | 16px Spinner diameter. |
| XSmall | 3 | 12px Spinner diameter. |
BitVisibility enum
Name |
Value |
Description |
|---|---|---|
| Visible | 0 | The content of the component is visible. |
| Hidden | 1 | The content of the component is hidden, but the space it takes on the page remains (visibility:hidden). |
| Collapsed | 2 | The component is hidden (display:none). |