React Spinner Component API
Spinner API
Explore the API reference for the React Spinner component and discover how to effectively utilize its props for customization.
CSpinner
import { CSpinner } from '@coreui/react-pro'
| Property | Default | Type |
|---|
| ariaLoadingLabel6.0.0+ | - | string |
Sets the text screen readers read as the spinner's status, 'Loading' unless set. An empty string hides the spinner from assistive technologies. |
| as | div | (ElementType & 'symbol') | (ElementType & 'object') | (ElementType & 'div') | (ElementType & 'slot') | (ElementType & 'style') | ... 175 more ... |
Component used for the root node. Either a string to use a HTML element or a component. |
| className | - | string |
A string of all className you want applied to the component. |
| color | - | 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'inverse', string |
Sets the color context of the component to one of CoreUI’s themed colors. |
| size | - | 'sm' |
Size the component small. |
| variant | border | 'border', 'grow' |
Set the button variant to an outlined button or a ghost button. |
| visuallyHiddenLabelDeprecated 6.0.0 | - | string |
Sets the visually hidden label of the spinner. Use ariaLoadingLabel instead — visuallyHiddenLabel is ignored when ariaLoadingLabel is set. |