tsargp
    Preparing search index...

    Type Alias HelpLayout

    The layout settings of a groups section.

    type HelpLayout = {
        descr?: WithBasicLayout & WithAbsoluteLayout | null | WithMergedLayout;
        items?: HelpItems;
        names?: WithBasicLayout & WithSlottedLayout | null;
        param?: WithBasicLayout & WithAbsoluteLayout | null | WithMergedLayout;
        responsive?: boolean;
    }
    Index

    Properties

    descr? items? names? param? responsive?

    Properties

    descr?: WithBasicLayout & WithAbsoluteLayout | null | WithMergedLayout

    The layout settings for the description column. Use the value null to hide it from the help message.

    items?: HelpItems

    The (order of) items to display in option descriptions.

    names?: WithBasicLayout & WithSlottedLayout | null

    The layout settings for the names column. Use the value null to hide it from the help message.

    param?: WithBasicLayout & WithAbsoluteLayout | null | WithMergedLayout

    The layout settings for the parameter column. Use the value null to hide it from the help message.

    responsive?: boolean

    Whether the layout is responsive (a.k.a, terminal-aware).

    true

    Settings

    Member Visibility

    On This Page

    Properties