Interface AppShellOptions

Options accepted by the Blessed appShell adapter.

interface AppShellOptions {
    box?: BoxElementOptions;
    content?: AppShellRegionOptions;
    data?: AppShellData;
    footer?: AppShellRegionOptions;
    header?: AppShellRegionOptions;
    overlay?: AppShellRegionOptions;
    parent: Node;
    sidebar?: AppShellRegionOptions;
}

Index

Properties

box? content? data? footer? header? overlay? parent sidebar?

Properties

`Optional`box

box?: BoxElementOptions

Position, dimensions, border, padding, and standard Blessed settings.

`Optional`content

content?: AppShellRegionOptions

Optional content region settings.

`Optional`data

data?: AppShellData

Shell layout, state, content, and semantic theme data.

`Optional`footer

footer?: AppShellRegionOptions

Optional footer region settings.

`Optional`header

header?: AppShellRegionOptions

Optional header region settings.

`Optional`overlay

overlay?: AppShellRegionOptions

Optional overlay region settings.

parent

parent: Node

Blessed screen or node receiving the AppShell root.

`Optional`sidebar

sidebar?: AppShellRegionOptions

Optional sidebar region settings.