SiSplitPartComponent documentation¶
selector
si-split-part
Input Properties¶
Name | Type | Default | Description |
---|---|---|---|
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 ¶ | boolean | true | This 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 ¶ | boolean | false | Collapse only to the given min size. |
expanded ¶ | boolean | true | |
headerTemplate ¶ | TemplateRef <any > | ||
heading ¶ | string | Sets the title of the split part header. | |
minSize ¶ | number | 0 | Minimum size in px. |
removeContentOnCollapse ¶ | boolean | false | When 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 ¶ | boolean | true | Defines if the collapse button of a split part is displayed. Default value is true. |
showHeader ¶ | boolean | true | Defines if the header of the split part is visible. Default is true. |
size ¶ | number | Expanded size in px. | |
stateId ¶ | string | An optional stateId to uniquely identify a component instance. Required for persistence of ui state. | |
headerStatusColor | string | Sets 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 | string | Sets 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¶
Name | Type | Description |
---|---|---|
(readonly) collapseChanged ¶ | EventEmitter <boolean > | |
(readonly) stateChange ¶ | EventEmitter <PartState > |
Attributes and Methods¶
Name | Type | Default | Description |
---|---|---|---|
(readonly) collapsed ¶ | boolean | Get collapsed state. Returns True if the split part is collapsed, false is expanded. | |
toggleCollapse() ¶ | () => void | Toggles the collapsed or expanded state. |
Types Documentation¶
|
Copyright (c) Siemens 2016 - 2025 SPDX-License-Identifier: MIT |
---|
|
Except where otherwise noted, content on this site is licensed under MIT License.