Skip to content

SiSplitPartComponent documentation

selector
si-split-part

Input Properties

NameTypeDefaultDescription
actions
Action[][]
collapseDirection
CollapseTo'start'
collapseIconClass
string'element-double-right'Sets the icon class that is used in the buttons of split parts to collapse and uncollapse the parts.
collapseLabel
string'collapse'Aria label for collapse button. Needed for a11y
collapseOthers
booleantrueThis toggles the behavior when collapsing this split part. If enabled, all split parts between this one and the end of the split in the respective direction will be collapsed if this part is collapsed. If disabled, only this split part will be collapsed.

The default value will change to false in v48.
collapseToMinSize
booleanfalseCollapse only to the given min size.
expanded
booleantrue
headerTemplate
TemplateRef<any>
heading
stringSets the title of the split part header.
minSize
number0Minimum size in px.
removeContentOnCollapse
booleanfalseWhen a split part is collapsed, the content gets hidden but it will still remain within the DOM. If you want to remove and destroy the component in collapsed mode and recreate it on un-collapse, set this property to true.
scale
Scale'auto'Defines the behavior of the split part during scaling. E.g. when set to none , the spit part will keep its current size even when the parent container grows or shrinks.
showCollapseButton
booleantrueDefines if the collapse button of a split part is displayed. Default value is true.
showHeader
booleantrueDefines if the header of the split part is visible. Default is true.
size
numberExpanded size in px.
stateId
stringAn optional stateId to uniquely identify a component instance. Required for persistence of ui state.
headerStatusColor
Deprecated
stringSets the status color on the split part header, visible as a bottom border and, if a headerStatusIcon is defined, as the icon´s background color.
Deprecated: Legacy input with no functionality. Will be removed in future major release.
headerStatusIconClass
Deprecated
stringSets the icon class that is used as status icon in the split part header.
Deprecated: Legacy input with no functionality. Will be removed in future major release.

Output Properties

NameTypeDescription
(readonly) collapseChanged
EventEmitter<boolean>
(readonly) stateChange
EventEmitter<PartState>

Attributes and Methods

NameTypeDefaultDescription
(readonly) collapsed
booleanGet collapsed state.
Returns True if the split part is collapsed, false is expanded.
toggleCollapse()
() => voidToggles the collapsed or expanded state.

Types Documentation

Properties
click: (evt: Event) => void
iconClass: string
tooltip: string
("start" | "end")
Copyright (c) Siemens 2016 - 2025 SPDX-License-Identifier: MIT
("none" | "auto")
Properties
expanded?: boolean
size?: number

Except where otherwise noted, content on this site is licensed under MIT License.