small-wait-cursor.md

SmallWaitCursor

A small circular loading indicator.

Usage

You should have the chayns-components package installed. If that is not the case already, run

yarn add chayns-components

or

npm i chayns-components

After the chayns-components package is installed, you can import the component and use it with React:

import React from 'react'
import { SmallWaitCursor } from 'chayns-components';

// ...

<SmallWaitCursor {...} />

Props

The SmallWaitCursor-component takes the following props:

Name	Type	Default	Required
show	boolean	false
style	{ [key: string]: number | string }
showBackground	boolean	true
inline	boolean	false
className	string

show

show?: boolean

Wether the wait cursor should be shown.

---

style

style?: { [key: string]: number | string }

A React style object that will be applied to the wrapper.

---

showBackground

showBackground?: boolean

Wether a background should be shown behind the spinner.

---

inline

inline?: boolean

Wether the spinner should be rendered with display: inline-block;. This does not work when showBackground is true

---

className

className?: string

A classname sring that will be applied to the container element of the spinner.