foundation-layout
Home > @genesislcap/foundation-layout
foundation-layout package
Classes
Class | Description |
---|---|
FoundationLayout | Top level web component which is used to initialise a custom layout |
FoundationLayoutItem | FoundationLayoutItem is a custom element that represents an item in the layout. |
FoundationLayoutRegion | FoundationLayoutRegion is a custom element that represents a region in the layout. |
LayoutRegistrationError | |
LayoutUsageError |
Interfaces
Interface | Description |
---|---|
RegisteredElementConfig | The parameters that can be set on a new item when being added by the FoundationLayout.addItem() API |
Variables
Variable | Description |
---|---|
DEFAULT_RELOAD_BUFFER | Default time in milliseconds for the layout to buffer calls to reloading the layout while the declarative API is loading. During the first load of the layout, a loading spinner will be shown. |
foundationLayoutComponents | Registration object to register the layout with your design system. |
LayoutEmitEvents | Defines events that the layout system emits 'firstLoaded' - emitted when the layout has finished loading the first time using the declarative API after DEFAULT_RELOAD_BUFFER ms. |
LayoutReceiveEvents | Defines events that the layout system listens for 'changeTitle' - emit this from a contained item to update the title of the window that contains it. |
layoutStyles | ElementStyles which defines the css for FoundationLayout. |
layoutTemplate | ViewTemplate which defines the html for FoundationLayout. |
Type Aliases
Type Alias | Description |
---|---|
LayoutReceiveEventsDetail | Defines the shape of the detail that the layout listens works with for events it listens on 'changeTitle' - |
LayoutRegionType | Union type describing the three different types of region splits. Set on the type attribute on FoundationLayoutRegion. |
Placement | Where to and how to add the new item(s) into the layout when using the FoundationLayout.addItem() API. |
SerialisedLayout | Versioned layout config objects. v is the version and c contains the layout config. |