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

    Interface RenderBadgeOptions

    Options accepted by renderBadge.

    interface RenderBadgeOptions {
        delimiters?: BadgeDelimiters;
        markers?: BadgeMarkers;
        showMarker?: boolean;
        text: string;
        tone?: keyof BadgeMarkers;
        variant?: BadgeVariant;
    }
    Index

    Properties

    delimiters? markers? showMarker? text tone? variant?

    Properties

    delimiters?: BadgeDelimiters

    Delimiters used by the bracketed variant.

    Both values must be non-empty.

    { open: '[', close: ']' }

    markers?: BadgeMarkers

    Semantic marker mapping.

    Every marker must be non-empty.

    Unicode status markers
    showMarker?: boolean

    Whether the semantic marker is rendered.

    Disabling the marker removes the non-color status cue. Do this only when surrounding text already communicates the state.

    true

    text

    text: string

    Non-empty text displayed by the Badge.

    tone?: keyof BadgeMarkers

    Semantic status used to select a marker.

    'neutral'

    variant?: BadgeVariant

    Whether delimiters surround badge content.

    'bracketed'

    Settings

    Member Visibility

    On This Page

    Properties