mirror of
https://github.com/flarum/core.git
synced 2025-06-07 15:16:00 +02:00
57 lines
2.1 KiB
TypeScript
57 lines
2.1 KiB
TypeScript
/// <reference types="mithril" />
|
|
import Component, { ComponentAttrs } from '../Component';
|
|
export interface LoadingIndicatorAttrs extends ComponentAttrs {
|
|
/**
|
|
* Custom classes for the loading indicator's container.
|
|
*/
|
|
className?: string;
|
|
/**
|
|
* Custom classes for the loading indicator's container.
|
|
*/
|
|
containerClassName?: string;
|
|
/**
|
|
* Optional size for the loading indicator.
|
|
*/
|
|
size?: 'large' | 'medium' | 'small';
|
|
/**
|
|
* Optional attributes to apply to the loading indicator's container.
|
|
*/
|
|
containerAttrs?: Partial<ComponentAttrs>;
|
|
/**
|
|
* Display type of the spinner.
|
|
*
|
|
* @default 'block'
|
|
*/
|
|
display?: 'block' | 'inline' | 'unset';
|
|
}
|
|
/**
|
|
* The `LoadingIndicator` component displays a simple CSS-based loading spinner.
|
|
*
|
|
* To set a custom color, use the CSS `color` property.
|
|
*
|
|
* To increase spacing around the spinner, use the CSS `height` property on the
|
|
* spinner's **container**. Setting the `display` attribute to `block` will set
|
|
* a height of `100px` by default.
|
|
*
|
|
* To apply a custom size to the loading indicator, set the `--size` and
|
|
* `--thickness` CSS custom properties on the loading indicator container.
|
|
*
|
|
* If you *really* want to change how this looks as part of your custom theme,
|
|
* you can override the `border-radius` and `border` then set either a
|
|
* background image, or use `content: "\<glyph>"` (e.g. `content: "\f1ce"`)
|
|
* and `font-family: 'Font Awesome 5 Free'` to set an FA icon if you'd rather.
|
|
*
|
|
* ### Attrs
|
|
*
|
|
* - `containerClassName` Class name(s) to apply to the indicator's parent
|
|
* - `className` Class name(s) to apply to the indicator itself
|
|
* - `display` Determines how the spinner should be displayed (`inline`, `block` (default) or `unset`)
|
|
* - `size` Size of the loading indicator (`small`, `medium` or `large`)
|
|
* - `containerAttrs` Optional attrs to be applied to the container DOM element
|
|
*
|
|
* All other attrs will be assigned as attributes on the DOM element.
|
|
*/
|
|
export default class LoadingIndicator extends Component<LoadingIndicatorAttrs> {
|
|
view(): JSX.Element;
|
|
}
|