Skip to main content

foundation-layout.foundationlayoutitem

Home > @genesislcap/foundation-layout > FoundationLayoutItem

FoundationLayoutItem class​

FoundationLayoutItem is a custom element that represents an item in the layout.

Signature:

export declare class FoundationLayoutItem extends FoundationElement implements LayoutComponent 

Extends: FoundationElement

Implements: LayoutComponent

Remarks​

This element is used to wrap html elements and configure their layout settings as part of the layout system.

This is a simple component which is only used to define the layout splits; any JavaScript API interactions or custom styling is used via FoundationLayout.

The item can either use slotted content or a factory function registered via registerFactory(). When a factory is registered with the same name as the registration attribute, it takes precedence over slotted content.

Properties​

Property

Modifiers

Type

Description

closable

boolean

Boolean attribute controls whether the window can be closed in the GUI. Defaults to false.

registration

string

Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem().

size

string

optional string describing the size of the new item (see the written documentation for more info)

title

string

Sets the title of the item which is displayed on the tab.