Vue Spinner Component
Indicate the loading state of a component or page with CoreUI spinners, built entirely with HTML, CSS, and no JavaScript.
Other frameworks
CoreUI components are available as native Angular, Bootstrap (Vanilla JS), and React components. To learn more please visit the following pages.
About
CoreUI "spinners" can be used to show the loading state in your projects. They're built only with HTML and CSS, meaning you don't need any JavaScript to create them. You will, however, need some custom JavaScript to toggle their visibility. Their appearance, alignment, and sizing can be easily customized with our amazing utility classes.
For accessibility purposes, each loader here includes role="status" and a nested <span class="visually-hidden">Loading...</span>.
Border spinner
Use the border spinners for a lightweight loading indicator.
Basic usage
<CSpinner/>
Colors
The border spinner uses currentColor for its border-color. You can use any of our text color utilities on the standard spinner.
<CSpinner color="primary"/>
<CSpinner color="secondary"/>
<CSpinner color="success"/>
<CSpinner color="danger"/>
<CSpinner color="warning"/>
<CSpinner color="info"/>
<CSpinner color="light"/>
<CSpinner color="dark"/>
Growing spinner
If you don't fancy a border spinner, switch to the grow spinner. While it doesn't technically spin, it does repeatedly grow!
<CSpinner variant="grow"/>
Once again, this spinner is built with currentColor, so you can easily change its appearance. Here it is in blue, along with the supported variants.
<CSpinner color="primary" variant="grow"/>
<CSpinner color="secondary" variant="grow"/>
<CSpinner color="success" variant="grow"/>
<CSpinner color="danger" variant="grow"/>
<CSpinner color="warning" variant="grow"/>
<CSpinner color="info" variant="grow"/>
<CSpinner color="light" variant="grow"/>
<CSpinner color="dark" variant="grow"/>
Size
Add size="sm"property` to make a smaller spinner that can quickly be used within other components.
<CSpinner size="sm"/>
<CSpinner size="sm" variant="grow"/>
Buttons
Use spinners within buttons to indicate an action is currently processing or taking place. You may also swap the text out of the spinner element and utilize button text as needed.
<CButton disabled>
<CSpinner component="span" size="sm" aria-hidden="true"/>
</CButton>
<CButton disabled>
<CSpinner component="span" size="sm" aria-hidden="true"/>
Loading...
</CButton>
<CButton disabled>
<CSpinner component="span" size="sm" variant="grow" aria-hidden="true"/>
</CButton>
<CButton disabled>
<CSpinner component="span" size="sm" variant="grow" aria-hidden="true"/>
Loading...
</CButton>
Customizing
CSS variables
Vue spinners use local CSS variables on .spinner-border and .spinner-grow for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
Border spinner variables:
--cui-spinner-width: #{$spinner-width};
--cui-spinner-height: #{$spinner-height};
--cui-spinner-vertical-align: #{$spinner-vertical-align};
--cui-spinner-border-width: #{$spinner-border-width};
--cui-spinner-animation-speed: #{$spinner-animation-speed};
--cui-spinner-animation-name: spinner-border;
Growing spinner variables:
--cui-spinner-width: #{$spinner-width};
--cui-spinner-height: #{$spinner-height};
--cui-spinner-vertical-align: #{$spinner-vertical-align};
--cui-spinner-animation-speed: #{$spinner-animation-speed};
--cui-spinner-animation-name: spinner-grow;
For both spinners, small spinner modifier classes are used to update the values of these CSS variables as needed. For example, the .spinner-border-sm class does the following:
--cui-spinner-width: #{$spinner-width-sm};
--cui-spinner-height: #{$spinner-height-sm};
--cui-spinner-border-width: #{$spinner-border-width-sm};
How to use CSS variables
const vars = {
'--my-css-var': 10,
'--my-another-css-var': "red"
}
return <CSpinner :style="vars">...</CSpinner>
SASS variables
$spinner-width: 2rem;
$spinner-height: $spinner-width;
$spinner-vertical-align: -.125em;
$spinner-border-width: .25em;
$spinner-animation-speed: .75s;
$spinner-width-sm: 1rem;
$spinner-height-sm: $spinner-width-sm;
$spinner-border-width-sm: .2em;
API
CSpinner
import { CSpinner } from '@coreui/vue'
// or
import CSpinner from '@coreui/vue/src/components/spinner/CSpinner'
Props
| Prop name | Description | Type | Values | Default |
|---|---|---|---|---|
| color | Sets the color context of the component to one of CoreUI’s themed colors. | string | 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light' | - |
| component | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'div' |
| size | Size the component small. | string | 'sm' | - |
| variant | Set the button variant to an outlined button or a ghost button. | string | 'border', 'grow' | 'border' |
| visually-hidden-label | Set visually hidden label for accessibility purposes. | string | - | 'Loading...' |