Skip to content

@sqlrooms/layout / LayoutSliceState

Type Alias: LayoutSliceState

LayoutSliceState = object

Properties

layout

layout: object

NameTypeDescription
initialize()?() => Promise<void>-
destroy()?() => Promise<void>-
configLayoutSliceConfig-
panelsPanels-
setConfig()(layout) =>-
setLayout()(layout) =>-
togglePanel()(panel, show?) => voidDeprecated Use setActiveTab / addTab / removeTab instead
togglePanelPin()(panel) => voidDeprecated
setActiveTab()(tabsId, tabId) => voidSet the active (visible) tab in a tabs node
addTab()(tabsId, tabIdOrNode) => voidAdd a tab to a tabs node
removeTab()(tabsId, tabId) => voidRemove (close/hide) a tab from a tabs node
deleteTab()(tabsId, tabId) => voidPermanently delete a tab from a tabs node
reorderTabs()(tabsId, tabIds) => voidReorder visible tabs within a tabs node
setCollapsed()(id, collapsed) => voidCollapse or expand a collapsible node
toggleCollapsed()(id) => voidToggle collapse state of a collapsible node
getTabs()(tabsId) => string[]Get the list of all tab IDs in a tabs node (both visible and hidden)
getVisibleTabs()(tabsId) => string[]Get the list of visible tab IDs in a tabs node
getHiddenTabs()(tabsId) => string[]Get the list of hidden tab IDs in a tabs node
getActiveTab()(tabsId) => string | undefinedGet the active tab ID in a tabs node
isCollapsed()(id) => booleanCheck if a node is currently collapsed
registerPanel()(panelId, info) => voidRegister a panel dynamically (adds to panels registry)
unregisterPanel()(panelId) => voidUnregister a dynamically added panel
addChildToSplit()(splitId, panelId) => voidAdd a panel as a child of a named split node
findAncestorOfType()(nodeId, type) => LayoutTabsNode | LayoutSplitNode | LayoutGridNode | undefinedFind the nearest ancestor of a given type for a node