API: Core

SplitterService

Service reference for SplitterService.

Overview

Kind: Service
Source: packages/core/src/splitter/splitter.service.ts:6

Properties

Name	Type	Description
`readonly position`	`Signal<number>`
`readonly orientation`	`Signal<SplitterOrientation>`
`readonly isDragging`	`Signal<boolean>`
`readonly containerRect`	`Signal<DOMRect \| null>`
`readonly direction`	`Signal<Direction>`	Writing direction of the container; flips the horizontal axis in `rtl`.
`readonly disabled`	`Signal<boolean>`	Whether resizing is turned off (pointer and keyboard).
`readonly resizing`	`Signal<boolean>`	`true` while a pointer drag is in progress. Alias of `isDragging`.
`readonly isHorizontal`	`Signal<boolean>`
`readonly isVertical`	`Signal<boolean>`
`readonly minSize`	`Signal<number>`
`readonly maxSize`	`Signal<number>`
`readonly step`	`Signal<number>`

Public methods

updateConfig

updateConfig(config: Partial<SplitterConfig>): void

Units: every size is a percentage (0–100) of the container's main-axis size taken by the primary panel; the secondary panel gets the remainder. minSize/maxSize bound the primary panel, so the secondary panel's minimum is 100 - maxSize.

Non-finite values fall back to the defaults; maxSize is raised to minSize when smaller. The current position is re-clamped so dynamic bounds never leave it out of range.

Parameter	Type	Optional	Description
`config`	`Partial<SplitterConfig>`

setDirection

setDirection(direction: Direction): void

Parameter	Type	Optional	Description
`direction`	`Direction`

setDisabled

setDisabled(disabled: boolean): void

Parameter	Type	Optional	Description
`disabled`	`boolean`

setOrientation

setOrientation(orientation: SplitterOrientation): void

Parameter	Type	Optional	Description
`orientation`	`SplitterOrientation`

setContainerRect

setContainerRect(rect: DOMRect): void

Parameter	Type	Optional	Description
`rect`	`DOMRect`

setPosition

setPosition(position: number): void

Parameter	Type	Optional	Description
`position`	`number`

startDragging

startDragging(): void

stopDragging

stopDragging(): void

calculatePositionFromEvent

calculatePositionFromEvent(clientX: number, clientY: number): number

Parameter	Type	Optional	Description
`clientX`	`number`
`clientY`	`number`

calculatePositionFromTouch

calculatePositionFromTouch(touch: Touch): number

Parameter	Type	Optional	Description
`touch`	`Touch`