Class IgcCircularProgressComponent

A circular progress indicator used to express unspecified wait time or display the length of a process.

igc-circular-progress

  • The text area container.

gradient - Customize the progress bar in order to use a color gradient instead of a solid color. Accepts igc-circular-gradient elements.

svg - The igc-circular-progress SVG element.

gradient_start - The igc-circular-progress linear-gradient start color.

gradient_end - The igc-circular-progress linear-gradient end color.

track - The igc-circular-progress ring track area.

fill - The igc-circular-progress indicator area.

label - The igc-circular-progress label.

value - The igc-circular-progress label value.

indeterminate - The igc-circular-progress indeterminate state.

primary - The igc-circular-progress primary state.

danger - The igc-circular-progress error state.

warning - The igc-circular-progress warning state.

info - The igc-circular-progress info state.

success - The igc-circular-progress success state.

Hierarchy

Hierarchy

  • IgcProgressBaseComponent
    • IgcCircularProgressComponent

Other

animationDuration: number = 500

Animation duration in milliseconds.

animation-duration

hideLabel: boolean = false

Shows/hides the label of the control.

hide-label

indeterminate: boolean = false

The indeterminate state of the control.

labelFormat: string

Format string for the default label of the control. Placeholders: {0} - current value of the control. {1} - max value of the control.

label-format

max: number = 100

Maximum value of the control.

value: number = 0

The value of the control.

variant:
    | "success"
    | "primary"
    | "info"
    | "warning"
    | "danger" = 'primary'

The variant of the control.

lifecycle

  • Invoked when the component is added to the document's DOM.

    In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

    connectedCallback() {
    super.connectedCallback();
    addEventListener('keydown', this._handleKeydown);
    }

    Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

    Returns Promise<void>

styles

styles: CSSResult[] = ...

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

<script>
// Generated and unique per request:
window.litNonce = 'a1b2c3d4';
</script>