smart-html-elements

Splitter Blazor API

Splitter Properties

Name	Type	Default	Description
AutoFitMode	SplitterAutoFitMode	SplitterAutoFitMode.Proportional	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.
Disabled	bool	false	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.
DataSource	IEnumerable<object>	N/A	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.
Items	IEnumerable<object>		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.
KeepProportionsOnResize	bool	false	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.
UnlockKey	string	""	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.
Locale	string	"en"	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.
Messages	object	N/A	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.
Orientation	Orientation	Orientation.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).
Readonly	bool	false	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.
ResizeMode	SplitterResizeMode	SplitterResizeMode.Adjacent	'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.'
ResizeStep	int	5	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.
RightToLeft	bool	false	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.
LiveResize	bool	false	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.
Theme	string	""	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.
Unfocusable	bool	false	If set to true, the element will be excluded from keyboard navigation and cannot receive focus via keyboard or mouse interactions.

Splitter Methods

Name	Type	Arguments	Description
AppendChild	void	dynamic node	Appends a new node to the end of the current list or container, adding it as the last child element. This operation updates the data structure to include the newly added node as the final element in the sequence.Args: dynamic node - The node to append
Collapse	void	object item, bool far	Collapses the specified splitter panel, minimizing its size and hiding its content within the container or layout.Args: dynamic item - number indicating the index of the item or an isntance of Smart.SplitterItem,bool far - Indicates whether the item should collapse to it's far or near side
Collapse	void	object item	Collapses the specified splitter panel, minimizing its size and hiding its content within the container or layout.
Collapse	void	int item, bool far	Collapses the specified splitter panel, minimizing its size and hiding its content within the container or layout.Args: int item - number indicating the index of the item or an isntance of Smart.SplitterItem,bool far - Indicates whether the item should collapse to it's far or near side
Collapse	void	int item	Collapses the specified splitter panel, minimizing its size and hiding its content within the container or layout.
Expand	void	object item	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.Args: dynamic item - number indicating the index of the item or an isntance of Smart.SplitterItem
Expand	void	int item	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.Args: int item - number indicating the index of the item or an isntance of Smart.SplitterItem
GetDataSourceAsync()	Task<IEnumerable<object>>	'N/A'	Gets the "DataSource" property as Task<IEnumerable<object>>.
HideBar	int	int splitterBar	Conceals the splitter bar element from view, preventing users from interacting with or resizing the associated panels.Args: int splitterBar - A Smart.SplitterBar instance.
Insert	void	int index, object details	Inserts a new Splitter component into the specified position within the layout, allowing the user to divide and resize adjacent sections of the interface.Args: int index - The index at which a new item will be inserted.,object details - An Object or string used as content if the splitter item.
Insert	void	int index, string details	Inserts a new Splitter component into the specified position within the layout, allowing the user to divide and resize adjacent sections of the interface.Args: int index - The index at which a new item will be inserted.,string details - An Object or string used as content if the splitter item.
InsertBefore	dynamic	dynamic newNode, dynamic referenceNode	Inserts the specified "smart-splitter-item" node into the DOM immediately before the reference "smart-splitter-item" node, ensuring that the new element appears directly before the reference node within the splitter container. This operation preserves the order of splitter items and updates their layout accordingly.Args: dynamic newNode - The "smart-splitter-item" node to insert.,dynamic referenceNode - The "smart-splitter-item" node before which newNode is inserted.
InsertBefore	dynamic	dynamic newNode	Inserts the specified "smart-splitter-item" node into the DOM immediately before the reference "smart-splitter-item" node, ensuring that the new element appears directly before the reference node within the splitter container. This operation preserves the order of splitter items and updates their layout accordingly.
LockBar	void	int index	Prevents the splitter bar from being moved by disabling user drag interactions, effectively locking its position and ensuring that adjacent panes cannot be resized.Args: int index - The index of a Splitter Bar or it's instance.
LockItem	void	int index	Prevents a splitter item from being resized by the user, ensuring that its current size remains fixed and unchangeable during layout adjustments.Args: int index - The index of a Splitter Bar or it's instance.
Refresh	void	'N/A'	Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements.
Refresh	void	N/A	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.
RemoveAll	void	N/A	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.
RemoveAt	void	int index	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.Args: int index - An item to be removed.
RemoveChild	dynamic	dynamic node	Removes a child node of type "smart-splitter-item" from its parent element in the DOM, effectively deleting the specified splitter pane and updating the layout accordingly.Args: dynamic node - The "smart-splitter-item" node to remove.
Render	void	'N/A'	Re-renders the Blazor Component. This method will make a full re-render.
ShowBar	void	int splitterBar	Reveals a previously hidden splitter bar, allowing users to resize adjacent panes or sections within the interface.Args: int splitterBar - An instance of a splitter bar.
StateHasChanged	void	'N/A'	Refreshes the state and Re-renders the Blazor Component, if necessary.
UnlockBar	void	int item	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.Args: int item - The index of a Splitter Bar or it's instance.
UnlockItem	void	int item	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.Args: int item - The index of a Splitter Item or it's instance.
Update	void	object item, object settings	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.Args: dynamic item - The index of a Smart.SplitterItem or it's instance.,object settings - An object containing the properties of a Smart.SplitterItem.

Splitter Events

Name	Type	Description	Event Detail
OnCollapse	EventCallback<Event>	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.	N/A
Collapsed	event SplitterCollapsedEventHandler	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.	SplitterCollapsedEventArgs
OnExpand	EventCallback<Event>	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.	N/A
Expanded	event SplitterExpandedEventHandler	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.	SplitterExpandedEventArgs
OnResizeStart	EventCallback<Event>	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.	N/A
ResizeStarted	event SplitterResizeStartedEventHandler	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.	SplitterResizeStartedEventArgs
OnResizeEnd	EventCallback<Event>	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.	N/A
ResizeEnded	event SplitterResizeEndedEventHandler	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.	SplitterResizeEndedEventArgs