React Loading Button Component API

Loading Button API

Explore the API reference for the React Loading Button component and discover how to effectively utilize its props for customization.

On this page

CLoadingButton#

import { CLoadingButton } from '@coreui/react-pro'
// or
import CLoadingButton from '@coreui/react-pro/src/components/loading-button/CLoadingButton'

Property	Default	Type
active#	-	`boolean`
Toggle the active state for the component.
as#	-	`ElementType`
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 base component.
color#	-	`'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `string`
Sets the color context of the component to one of CoreUI’s themed colors.
disabled#	-	`boolean`
Toggle the disabled state for the component.
disabledOnLoading#	-	`boolean`
Makes button disabled when loading.
href#	-	`string`
The href attribute specifies the URL of the page the link goes to.
loading#	-	`boolean`
Loading state (set to true to start animation).
role#	-	`string`
The role attribute describes the role of an element in programs that can make use of it, such as screen readers or magnifiers.
shape#	-	`'rounded'`, `'rounded-top'`, `'rounded-end'`, `'rounded-bottom'`, `'rounded-start'`, `'rounded-circle'`, `'rounded-pill'`, `'rounded-0'`, `'rounded-1'`, `'rounded-2'`, `'rounded-3'`, `string`
Select the shape of the component.
size#	-	`'sm'`, `'lg'`
Size the component small or large.
spinnerType#	`border`	`'border'`, `'grow'`
Sets type of spinner.
timeout#	-	`number`
Automatically starts loading animation and stops after a determined amount of milliseconds.
type#	-	`'button'`, `'submit'`, `'reset'`
Specifies the type of button. Always specify the type attribute for the `<button>` element. Different browsers may use different default types for the `<button>` element.
variant#	-	`'outline'`, `'ghost'`
Set the button variant to an outlined button or a ghost button.