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

Hierarchy

Hierarchy

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrCircularProgressProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get animationDuration(): number
  • Animation duration in milliseconds.

    Returns number

  • set animationDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get hideLabel(): boolean
  • Shows/hides the label of the control.

    Returns boolean

  • set hideLabel(v): void
  • Parameters

    • v: boolean

    Returns void

  • get indeterminate(): boolean
  • The indeterminate state of the control.

    Returns boolean

  • set indeterminate(v): void
  • Parameters

    • v: boolean

    Returns void

  • get labelFormat(): string
  • Format string for the default label of the control. Placeholders: {0} - current value of the control. {1} - max value of the control.

    Returns string

  • set labelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get max(): number
  • Maximum value of the control.

    Returns number

  • set max(v): void
  • Parameters

    • v: number

    Returns void

  • get value(): number
  • The value of the control.

    Returns number

  • set value(v): void
  • Parameters

    • v: number

    Returns void

  • get variant(): ProgressBaseVariant
  • The variant of the control.

    Returns ProgressBaseVariant

  • set variant(v): void
  • Parameters

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Returns DOMElement<any, Element>

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean