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

    Interface SpinnerData

    Stateful data accepted by the Blessed spinner adapter.

    interface SpinnerData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        autoStart?: boolean;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        frames?: readonly string[];
        interval?: number;
        onFrame?: (context: SpinnerFrameContext) => void;
        tone?: keyof ThemeColors;
        label?: string;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? autoStart? capabilities? frames? interval? onFrame? tone? label?

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    autoStart?: boolean

    Whether animation starts immediately.

    true

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

    Explicit capabilities used for deterministic output.

    frames?: readonly string[]

    Custom ordered one-cell animation frames.

    interval?: number

    Timer delay in milliseconds.

    80

    onFrame?: (context: SpinnerFrameContext) => void

    Called after an owned timer or manual tick advances the frame.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'primary'

    label?: string

    Optional literal text rendered after the frame.

    Settings

    Member Visibility

    On This Page

    Properties