Reference Source
import {Wait} from '@adobe/coral-spectrum'
public class | source

Wait

Expression Extends:

class Wait extends BaseComponent(HTMLElement)

Mixin Extends:

HTMLElement, BaseComponent

A Wait component to be used to indicate a process that is in-progress for an indefinite amount of time. When the time is known, Progress should be used instead.

See:

Example:

Markup
<coral-wait></coral-wait>
JS constructor
new Coral.Wait();

Static Member Summary

Static Public Members
public static

Returns Wait sizes.

public static

Returns Wait variants.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

Whether the component is centered or not.

public

Whether to hide the current value and show an animation.

public

The size of the wait indicator.

public

The current progress in percent.

public

The wait's variant. See WaitVariantEnum.

  • WaitVariantEnum.DEFAULT by default.
  • reflected

Static Public Members

public static size: WaitSizeEnum: * source

Returns Wait sizes.

Return:

WaitSizeEnum

public static variant: WaitVariantEnum: * source

Returns Wait variants.

Return:

WaitVariantEnum

Public Constructors

public constructor() source

Public Members

public centered: Boolean source

Whether the component is centered or not. The container needs to have the style position: relative for the centering to work correctly.

  • false by default.
  • reflected

public indeterminate: Boolean source

Whether to hide the current value and show an animation. Set to true for operations whose progress cannot be determined.

  • false by default.
  • reflected

public size: String source

The size of the wait indicator. Currently 'S' (the default), 'M' and 'L' are available. See WaitSizeEnum.

  • WaitSizeEnum.MEDIUM by default.
  • reflected

public value: Number source

The current progress in percent. If no value is set on initialization, wait is forced into indeterminate state.

  • 0 by default.
  • reflected

Emit:

coral-wait:change

public variant: String source

The wait's variant. See WaitVariantEnum.

  • WaitVariantEnum.DEFAULT by default.
  • reflected