BusyIndicator

<ui5-busy-indicator> | Since 0.12.0

The ui5-busy-indicator signals that some operation is going on and that the user must wait. It does not block the current UI screen so other operations could be triggered in parallel. It displays 3 dots and each dot expands and shrinks at a different rate, resulting in a cascading flow of animation.

Usage

For the ui5-busy-indicator you can define the size, the text and whether it is shown or hidden. In order to hide it, use the "active" property.

In order to show busy state over an HTML element, simply nest the HTML element in a ui5-busy-indicator instance.

Note: Since ui5-busy-indicator has display: inline-block; by default and no width of its own, whenever you need to wrap a block-level element, you should set display: block to the busy indicator as well.

When to use:

• The user needs to be able to cancel the operation.
• Only part of the application or a particular component is affected.

When not to use:

• The operation takes less than one second.
• You need to block the screen and prevent the user from starting another activity.
• Do not show multiple busy indicators at once.

ES6 Module Import

import "@ui5/webcomponents/dist/BusyIndicator.js";

Basic Sample

Properties

active

Description	Defines if the busy indicator is visible on the screen. By default it is not.
Type	boolean
Default	false

delay

Description	Defines the delay in milliseconds, after which the busy indicator will be visible on the screen.
Type	number
Default	1000

size

Description	Defines the size of the component.
Type	"L" | "M" | "S" (value descriptions in: BusyIndicatorSize)
Default	"M"

text

Description	Defines text to be displayed below the component. It can be used to inform the user of the current operation.
Type	string | undefined
Default	undefined
Since	1.0.0-rc.7

textPlacement

Description	Defines the placement of the text.
Type	"Bottom" | "Top" (value descriptions in: BusyIndicatorTextPlacement)
Default	"Bottom"

Slots

default

Description	Determines the content over which the component will appear.
Type	Array<Node>

Events

No events available for this component.

Methods

No methods available for this component.

CSS Parts

No CSS parts available for this component.

CSS Custom States

No CSS custom states available for this component.

More Samples

Sizes

The BusyIndicator comes in several sizes - S, M and L.

Text Placement with display text

The BusyIndicator can display text either above (via text-placement="Top") or below the animated dots (by default).

Busy component

The BusyIndicator can be placed over another web component.