Interface IOptions

An options object for creating a side panel widget.

interface IOptions {
    alignment?: Alignment;
    content?: Panel;
    header?: Panel;
    layout?: AccordionLayout;
    orientation?: Orientation;
    renderer?: IRenderer;
    spacing?: number;
    titleSpace?: number;
    toolbar?: Toolbar<Widget>;
    translator?: ITranslator;
}

Hierarchy

  • IOptions
    • IOptions

Properties

alignment? content? header? layout? orientation? renderer? spacing? titleSpace? toolbar? translator?

Properties

Optionalalignment

alignment?: Alignment

The content alignment of the layout.

Possible values are documented in SplitLayout.Alignment.

The default is 'start'.

Optionalcontent

content?: Panel

The main child of the side panel

If nothing is provided it fallback to an AccordionToolbar panel.

Optionalheader

header?: Panel

The header is at the top of the SidePanel, and that extensions can populate.

Defaults to an empty Panel if requested otherwise it won't be created.

Optionallayout

layout?: AccordionLayout

The accordion layout to use for the accordion panel.

If this is provided, the other options are ignored.

The default is a new AccordionLayout.

Optionalorientation

orientation?: Orientation

The orientation of the layout.

Possible values are documented in SplitLayout.Orientation.

The default is 'horizontal'.

Optionalrenderer

renderer?: IRenderer

The renderer to use for the accordion layout.

Optionalspacing

spacing?: number

The spacing between items in the layout.

The default is 4.

OptionaltitleSpace

titleSpace?: number

The section title height or width depending on the orientation.

The default is 22.

Optionaltoolbar

toolbar?: Toolbar<Widget>

The toolbar to use for the widget. It sits between the header and the content

Defaults to an empty toolbar if requested otherwise it won't be created.

Optionaltranslator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

On This Page

Properties