Interface SidebarLayoutOptions

Options accepted by the Blessed sidebarLayout adapter.

interface SidebarLayoutOptions {
    box?: BoxElementOptions;
    data?: SidebarLayoutData;
    main?: SidebarLayoutRegionOptions;
    parent: Node;
    sidebar?: SidebarLayoutRegionOptions;
}

Index

Properties

box? data? main? parent sidebar?

Properties

`Optional`box

box?: BoxElementOptions

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

`Optional`data

data?: SidebarLayoutData

Layout, state, content, and semantic theme data.

`Optional`main

main?: SidebarLayoutRegionOptions

Optional main region settings.

parent

parent: Node

Blessed screen or node receiving the SidebarLayout root.

`Optional`sidebar

sidebar?: SidebarLayoutRegionOptions

Optional sidebar region settings.