@chromakit/core
    Preparing search index...

    Interface BannerOptions

    Options to control the visual appearance of banner.

    interface BannerOptions {
        char?: string;
        color?: string;
        spacing?: boolean;
        style?: (text: string) => string;
    }
    Index

    Properties

    char? color? spacing? style?

    Properties

    char?: string

    Single character used to draw the top/bottom lines.

    Default: "=". If you pass a multi-code-unit string, it will be repeated as-is without width measurement (see grapheme note in banner).

    color?: string

    Foreground color for both the banner lines and the headline text.

    Color names/hex are parsed by colorText. Invalid inputs fall back as implemented by that function’s underlying utilities.

    spacing?: boolean

    If true, insert a blank line before and after the banner block.

    true

    style?: (text: string) => string

    Text style transform. Applied before coloring.

    Defaults to bold(underline(t)). Provide any unary function (t) => string such as a composition built with your composeStyles helper.

    Settings

    Member Visibility

    On This Page

    Properties