Hex Core JS
    Preparing search index...

    Type Alias ProgressModalProps

    ProgressModalProps: {
        action?: string;
        heading?: React.ReactNode;
        max?: number | null;
        timeEstimateThresholdMS?: number;
        value?: number | null;
    } & Pick<ModalProps, "ifRef" | "onClose" | "className" | "style">

    Type Declaration

    • Optionalaction?: string

      The name of the action that is being performed. Should be a present participle (e.g. "Processing").

    • Optionalheading?: React.ReactNode

      Heading text in the modal.

    • Optionalmax?: number | null

      The progress max/total. Same as the max attribute on the HTML <progress> element.

    • OptionaltimeEstimateThresholdMS?: number

      The amount of time (ms) below which updates are ignored in time estimate calculation. Useful if a cache is being used so that cache reads do not throw off the estimate.

    • Optionalvalue?: number | null

      The progress value. Same as the value attribute on the HTML <progress> element.