Splitter Javascript API

Class

Splitter

Splitter is a layout component that supports all important features such as resizing, collapsing, and nesting panels.

Selector

smart-splitter

Properties

Events

Methods

Properties

animation"none" | "simple" | "advanced"

Specifies or retrieves the current animation mode. When the property is set to 'none', all animations are disabled, resulting in static display without transition effects. Assigning any other valid value enables the corresponding animation mode.

Allowed Values

• "none" - animation is disabled
• "simple" - ripple animation is disabled
• "advanced" - all animations are enabled

 <smart-splitter animation='none'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.animation = 'simple';

 const splitter = document.querySelector('smart-splitter');

 let animation = splitter.animation;

autoFitMode"end" | "proportional" | "overflow"

Specifies how items are positioned and resized within the Splitter component.

Possible values:

• 
  end – All items are resized to fit exactly within the available space of the Splitter. When a new item is inserted, the required space is taken from the adjacent (neighboring) item, adjusting their sizes so that the total size remains constant and nothing overflows.
  


• 
  proportional – All items expand or contract proportionally to occupy the full size of the Splitter. When a new item is added, the space it needs is proportionally deducted from the existing items, maintaining their relative sizes within the total available space.
  


• 
  overflow – Items are not resized to fit the Splitter. Instead, each item retains its natural size, even if the total size exceeds the Splitter’s dimensions. In this case, a scrollbar will appear, allowing users to scroll and view all the content that overflows beyond the visible area.
  

 <smart-splitter auto-fit-mode='end'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.autoFitMode = 'proportional';

 const splitter = document.querySelector('smart-splitter');

 let autoFitMode = splitter.autoFitMode;

disabledboolean

Determines whether the element is interactive or inactive. When enabled, users can interact with the element; when disabled, the element is non-interactive and typically appears visually distinct (e.g., grayed out) to indicate its inactive state.

 <smart-splitter disabled></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.disabled = false;

 const splitter = document.querySelector('smart-splitter');

 let disabled = splitter.disabled;

dataSourcearray

Configures or retrieves the data source for the splitter component. When setting, it specifies the structure and content (such as panels or sections) that will be managed and displayed within the splitter. When getting, it returns the current data source used by the splitter.

 <smart-splitter data-source='[object Object],[object Object]'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.dataSource = [object Object],[object Object],[object Object];

 const splitter = document.querySelector('smart-splitter');

 let dataSource = splitter.dataSource;

itemsarray

A getter method that retrieves and returns an array containing all the current Splitter items. This allows you to access the complete list of items managed by the Splitter component.

keepProportionsOnResizeboolean

When enabled, this setting ensures that all items within the element maintain their original aspect ratios relative to each other whenever the element is resized. This behavior is preserved regardless of whether the size properties of the items are defined in pixels, percentages, or other units. In other words, resizing the overall element will proportionally scale all its child items, keeping their relative dimensions consistent.

 <smart-splitter keep-proportions-on-resize></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.keepProportionsOnResize = false;

 const splitter = document.querySelector('smart-splitter');

 let keepProportionsOnResize = splitter.keepProportionsOnResize;

unlockKeystring

Sets or retrieves the unlockKey value used to authorize and enable access to the product's features. When setting, this key unlocks the product for use. When getting, it returns the currently assigned unlockKey.

 <smart-splitter unlock-key=''></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.unlockKey = '1111-2222-3333-4444-5555';

 const splitter = document.querySelector('smart-splitter');

 let unlockKey = splitter.unlockKey;

localestring

Specifies the language to be used for displaying messages. This property can be set to change the current language or retrieved to identify the active language. It works in conjunction with the messages property, which contains localized message strings for each supported language. Adjusting this property enables seamless switching between different language options in the application’s user interface.

 <smart-splitter locale='de'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.locale = 'fr';

 const splitter = document.querySelector('smart-splitter');

 let locale = splitter.locale;

localizeFormatFunctionfunction | null

Callback function associated with the localization module, typically used to handle language changes, translate content, or process localization-related events within the application.

 <smart-splitter localize-format-function='function(){return '...'}'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.localizeFormatFunction = function(){return '...'};

 const splitter = document.querySelector('smart-splitter');

 let localizeFormatFunction = splitter.localizeFormatFunction;

messagesobject

Defines an object that maps password strength states to their corresponding string values. Each key in the object represents a specific password strength level (such as "weak," "medium," or "strong"), and its value provides the associated descriptive label or message to display to users. This allows for customizable text based on the current password strength state.

 <smart-splitter messages='{"de":{"propertyUnknownType":"Die Eigenschaft '{{name}}' hat ein nicht definiertes 'type'-Member!","propertyInvalidValue":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualValue}}, Erwarteter Wert: {{value}}!","propertyInvalidValueType":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualType}}, Erwarteter Wert: {{type}}!","elementNotInDOM":"Element existiert nicht in DOM! Bitte fugen Sie das Element zum DOM hinzu, bevor Sie eine Methode aufrufen.","moduleUndefined":"Modul ist nicht definiert.","missingReference":"{{elementType}}: Fehlender Verweis auf {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser unterstutzt keine HTMLTemplate-Elemente.","invalidTemplate":"{{elementType}}: '{{property}}' Die Eigenschaft akzeptiert eine Zeichenfolge, die mit der ID eines HTMLTemplate-Elements aus dem DOM ubereinstimmen muss.","invalidIndex":"{{elementType}}: '{{method}}' Methode akzeptiert einen Index der Typennummer.","indexOutOfBound":"{{elementType}}: Nicht gebundener Index / Indizes in Methode '{{method}}'.","invalidNode":"{{elementType}}: '{{method}}' Die Methode akzeptiert ein Objekt oder ein Array von Objekten als zweiten Parameter.","invalidSettings":"{{elementType}}: '{{method}}' 1  62/5000 Die Methode akzeptiert einen string oder ein Objekt als zweiten Parameter.","invalidType":"{{elementType}}: '{{propertyName}}' muss vom Typ string oder Nummer sein."}}'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.messages = {"en":{"propertyUnknownType":"'{{name}}' property is with undefined 'type' member!","propertyInvalidValue":"Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!","propertyInvalidValueType":"Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!","elementNotInDOM":"Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.","moduleUndefined":"Module is undefined.","missingReference":"{{elementType}}: Missing reference to {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser doesn't support HTMLTemplate elements.","invalidTemplate":"{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.","invalidIndex":"{{elementType}}: '{{method}}' method accepts an index of type number.","indexOutOfBound":"{{elementType}}: Out of bound index/indexes in '{{method}}' method.","invalidNode":"{{elementType}}: '{{method}}' method accepts an object or an array of objects as it's second parameter.","invalidSettings":"{{elementType}}: '{{method}}' method accepts a string or an object as it's second parameter.","invalidType":"{{elementType}}: '{{propertyName}}' must be of type string or number."}};

 const splitter = document.querySelector('smart-splitter');

 let messages = splitter.messages;

orientation"horizontal" | "vertical"

Sets or retrieves the orientation of the splitter, determining whether it is displayed vertically (dividing the area into left and right sections) or horizontally (dividing the area into top and bottom sections).

 <smart-splitter orientation='horizontal'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.orientation = 'vertical';

 const splitter = document.querySelector('smart-splitter');

 let orientation = splitter.orientation;

readonlyboolean

When the element has the 'readonly' attribute, users can view its value but cannot modify, edit, or otherwise change its contents. However, the element may still be focused and its content can be selected and copied by the user. No direct interaction—such as typing, pasting, or deleting—is allowed.

 <smart-splitter readonly></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.readonly = true;

 const splitter = document.querySelector('smart-splitter');

 let readonly = splitter.readonly;

resizeMode"none" | "adjacent" | "end" | "proportional"

'Specifies how the splitter handles resizing when a user drags the splitter bar. The available modes are:'

- 'None:' Resizing is disabled; splitter bars cannot be moved.
- 'Adjacent (default):' Only the two panels immediately adjacent to the splitter bar are resized when the bar is dragged. Other panels remain unchanged.
- 'End:' Dragging the splitter bar affects only the first panel (located at the left or top, depending on splitter orientation) and the last panel. All intermediate panels between these two remain unaffected.
- 'Proportional:' All panels located in the direction the splitter bar is dragged (for example, all panels to the right if dragging right, or below if dragging down) are resized proportionally. The new sizes are calculated based on the current size ratios of these panels, ensuring they maintain their proportional widths or heights relative to each other after resizing.

'Use this property to control which panels are resized and how space is distributed when users interact with the splitter.'

 <smart-splitter resize-mode='end'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.resizeMode = 'proportional';

 const splitter = document.querySelector('smart-splitter');

 let resizeMode = splitter.resizeMode;

resizeStepnumber

Specifies the increment or decrement value by which the element's size changes during a resize operation. This value controls how much the element grows or shrinks with each resizing step, allowing for precise adjustments.

 <smart-splitter resize-step='10'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.resizeStep = 20;

 const splitter = document.querySelector('smart-splitter');

 let resizeStep = splitter.resizeStep;

rightToLeftboolean

Gets or sets a value that specifies whether the element's alignment should accommodate right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, the element's content and layout will adjust to support RTL text direction, ensuring proper display for locales that use right-to-left scripts.

 <smart-splitter right-to-left></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.rightToLeft = false;

 const splitter = document.querySelector('smart-splitter');

 let rightToLeft = splitter.rightToLeft;

liveResizeboolean

When this feature is enabled, the resizing operation updates the layout in real-time as the user drags the splitter, providing immediate visual feedback. By default, live resizing is disabled; instead, a highlighted guide bar appears during the drag operation, showing where the splitter will be positioned once the user releases the mouse button. The actual layout is only updated after the drag is complete.

 <smart-splitter live-resize></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.liveResize = true;

 const splitter = document.querySelector('smart-splitter');

 let liveResize = splitter.liveResize;

themestring

Specifies the theme for the element. The theme determines the overall appearance, including colors, fonts, and styling, to ensure a consistent and visually appealing look.

 <smart-splitter theme='blue'></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.theme = 'red';

 const splitter = document.querySelector('smart-splitter');

 let theme = splitter.theme;

unfocusableboolean

If set to true, the element will be excluded from keyboard navigation and cannot receive focus via keyboard or mouse interactions.

 <smart-splitter unfocusable></smart-splitter>

 const splitter = document.querySelector('smart-splitter');

 splitter.unfocusable = false;

 const splitter = document.querySelector('smart-splitter');

 let unfocusable = splitter.unfocusable;

Events

collapseCustomEvent

This event is triggered when a splitter item is collapsed by the user, either through a UI interaction (such as clicking a collapse button) or programmatically. It allows you to execute custom logic or respond to the change when a particular panel within the splitter component is minimized or hidden.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onCollapse

Arguments

const splitter = document.querySelector('smart-splitter');
splitter.addEventListener('collapse', function (event) {
	// event handling code goes here.
})

expandCustomEvent

This event is triggered whenever a splitter item is expanded by the user, either through interaction (such as clicking or dragging) or programmatically. It allows developers to execute custom logic in response to the expansion of a specific splitter item within the UI component.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onExpand

Arguments

const splitter = document.querySelector('smart-splitter');
splitter.addEventListener('expand', function (event) {
	// event handling code goes here.
})

resizeStartCustomEvent

This event is triggered when a user initiates the resizing of a splitter component, such as clicking and dragging the divider to adjust the size of adjacent panels. It marks the start of the resizing interaction, allowing developers to perform actions or apply styles in response to the beginning of the splitter's adjustment process.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onResizeStart

Arguments

const splitter = document.querySelector('smart-splitter');
splitter.addEventListener('resizeStart', function (event) {
	// event handling code goes here.
})

resizeEndCustomEvent

This event is triggered after the user completes resizing the splitter, indicating that the resizing action has finished and the new panel sizes have been set.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onResizeEnd

Arguments

const splitter = document.querySelector('smart-splitter');
splitter.addEventListener('resizeEnd', function (event) {
	// event handling code goes here.
})

Methods

appendChild( node: Node): T

Arguments

nodeNode

The node to append

collapse( item: any, far?: boolean): void

Collapses the specified splitter panel, minimizing its size and hiding its content within the container or layout.

Arguments

itemany

number indicating the index of the item or an isntance of Smart.SplitterItem

far?boolean

Indicates whether the item should collapse to it's far or near side

const splitter = document.querySelector('smart-splitter');
splitter.collapse("1, true");

expand( item: any): void

Attempts to expand the splitter item, provided sufficient space is available. The expansion is only performed if there is enough remaining space in the container to accommodate the item's increased size.

Arguments

itemany

number indicating the index of the item or an isntance of Smart.SplitterItem

const splitter = document.querySelector('smart-splitter');
splitter.expand("1");

hideBar( splitterBar: number): number

Conceals the splitter bar element from view, preventing users from interacting with or resizing the associated panels.

Arguments

splitterBarnumber

A Smart.SplitterBar instance.

Returnsnumber

const splitter = document.querySelector('smart-splitter');
const result = splitter.hideBar(1);

insert( index: number, details: any): void

Inserts a new Splitter component into the specified position within the layout, allowing the user to divide and resize adjacent sections of the interface.

Arguments

indexnumber

The index at which a new item will be inserted.

detailsany

An Object or string used as content if the splitter item.

const splitter = document.querySelector('smart-splitter');
splitter.insert(1,{"label":"New TAB","content":"New content"});

insertBefore( newNode: Node, referenceNode?: Node | null): T

Arguments

newNodeNode

The "smart-splitter-item" node to insert.

referenceNode?Node | null

The "smart-splitter-item" node before which newNode is inserted.

ReturnsNode

lockItem( index: number): void

Prevents a splitter item from being resized by the user, ensuring that its current size remains fixed and unchangeable during layout adjustments.

Arguments

indexnumber

The index of a Splitter Bar or it's instance.

const splitter = document.querySelector('smart-splitter');
splitter.lockItem(5);

lockBar( index: number): void

Prevents the splitter bar from being moved by disabling user drag interactions, effectively locking its position and ensuring that adjacent panes cannot be resized.

Arguments

indexnumber

The index of a Splitter Bar or it's instance.

const splitter = document.querySelector('smart-splitter');
splitter.lockBar(5);

removeAt( index: number): void

Removes a Splitter item from the layout, detaching it from its parent container and updating the interface accordingly. This action permanently deletes the specified Splitter component and any associated layout adjustments.

Arguments

indexnumber

An item to be removed.

const splitter = document.querySelector('smart-splitter');
splitter.removeAt(5);

removeAll(): void

Clears all items currently contained within the Splitter component, effectively resetting it to an empty state. This operation removes every panel, section, or child element inside the Splitter, leaving no content displayed.

const splitter = document.querySelector('smart-splitter');
splitter.removeAll();

removeChild( node: Node): T

Arguments

nodeNode

The "smart-splitter-item" node to remove.

ReturnsNode

refresh(): void

Reloads and updates the Splitter component, re-rendering its layout and recalculating its size and position to reflect any recent changes to its content, configuration, or container.

const splitter = document.querySelector('smart-splitter');
splitter.refresh();

showBar( splitterBar: number): void

Reveals a previously hidden splitter bar, allowing users to resize adjacent panes or sections within the interface.

Arguments

splitterBarnumber

An instance of a splitter bar.

const splitter = document.querySelector('smart-splitter');
splitter.showBar(5);

unlockItem( item: number): void

Enables access to a splitter item that was previously locked, allowing users to interact with or modify the item as intended. This action removes any restrictions, making the splitter fully functional within the application.

Arguments

itemnumber

The index of a Splitter Item or it's instance.

const splitter = document.querySelector('smart-splitter');
splitter.unlockItem(0);

unlockBar( item: number): void

Enables user interaction with a previously disabled or locked splitter bar, allowing users to adjust the size of adjacent panes or panels by dragging the splitter.

Arguments

itemnumber

The index of a Splitter Bar or it's instance.

const splitter = document.querySelector('smart-splitter');
splitter.unlockBar(1);

update( item: any, settings: any): void

Updates the configuration of a specific Splitter item within a Splitter component, allowing changes to its properties such as size, orientation, minimum and maximum limits, or other customizable options. This enables dynamic adjustment of the Splitter item's behavior and appearance within the parent Splitter layout.

Arguments

itemany

The index of a Smart.SplitterItem or it's instance.

settingsany

An object containing the properties of a Smart.SplitterItem.

const splitter = document.querySelector('smart-splitter');
splitter.update("0, settings");

CSS Variables

--smart-splitter-default-widthvar()

smartSplitter default width

--smart-splitter-default-heightvar()

smartSplitter default height

--smart-splitter-bar-sizevar()

The width of the scrollbar when vertical and the height of the scrollbar when horizontal

--smart-splitter-bar-fit-sizevar()

The size of the splitter according to the orientation of the Splitter. By 'default' a SplitterBar fits the size of the Splitter.

--smart-splitter-item-paddingvar()

Splitter item padding

--smart-splitter-item-content-paddingvar()

Splitter item content padding

--smart-splitter-item-sizevar()

The default size of the Splitter Items