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

    Interface RadioGroupHandle<TItem>

    Imperative handle returned by radioGroup.

    interface RadioGroupHandle<TItem extends RadioGroupItem = RadioGroupItem> {
        activeId(): string | undefined;
        focus(): void;
        focusItem(id: string): string | undefined;
        next(): string | undefined;
        previous(): string | undefined;
        selectActive(): string | undefined;
        value(): string | undefined;
        element: BoxElement;
        destroy(): void;
        setData(data: RadioGroupData): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Moves the cursor to an enabled identifier.

      Parameters

      • id: string

      Returns string | undefined

    • Moves the cursor to the previous enabled option, wrapping at the start.

      Returns string | undefined