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.

Hierarchy

Constructors

Properties

The attributes passed into the component.

See

https://mithril.js.org/components.html#passing-data-to-components

element: Element

The root DOM element for the component.

state: undefined

Class component state that is persisted between redraws.

Updating this will not automatically trigger a redraw, unlike other frameworks.

This is different to Vnode state, which is always an instance of your class component.

This is undefined by default.

Methods

  • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

    For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

    Returns

    the jQuery object for the DOM node

    Final

    Parameters

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

  • Initialize the component's attrs.

    This can be used to assign default values for missing, optional attrs.

    Parameters

    • attrs: unknown

    Returns void

Generated using TypeDoc v0.23.24