blessed-components - v1.20.0
    Preparing search index...

    Interface TaskProgressData

    Stateful data accepted by the Blessed taskProgress adapter.

    interface TaskProgressData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        markers?: TaskProgressMarkers;
        stepMarkers?: StepIndicatorMarkers;
        tone?: keyof ThemeColors;
        activity?: string;
        characters?: ProgressBarCharacters;
        formatValue?: (context: ProgressBarValueContext) => string;
        height?: number;
        max?: number;
        min?: number;
        showMarker?: boolean;
        showProgress?: boolean;
        steps?: readonly StepIndicatorStep[];
        status?: TaskProgressStatus;
        title: string;
        value?: number;
        width?: number;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? capabilities? markers? stepMarkers? tone? activity? characters? formatValue? height? max? min? showMarker? showProgress? steps? status? title value? width?

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">

    Explicit terminal capabilities used for deterministic rendering.

    markers?: TaskProgressMarkers

    Custom title markers.

    stepMarkers?: StepIndicatorMarkers

    Custom step markers.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    activity?: string

    Optional current activity text rendered under the title.

    characters?: ProgressBarCharacters

    Characters used by the optional progress bar.

    formatValue?: (context: ProgressBarValueContext) => string

    Formats optional progress value text.

    height?: number

    Maximum rendered line count.

    max?: number

    Upper bound for the optional progress value.

    100

    min?: number

    Lower bound for the optional progress value.

    0

    showMarker?: boolean

    Whether the title status marker is rendered.

    true

    showProgress?: boolean

    Whether the optional progress bar is rendered.

    true

    steps?: readonly StepIndicatorStep[]

    Optional steps rendered after the progress bar.

    status?: TaskProgressStatus

    Semantic task status.

    'running'

    title: string

    Non-empty task title.

    value?: number

    Optional numeric progress value.

    width?: number

    Maximum rendered width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties