Splitter Blazor API

Splitter Properties

NameTypeDefaultDescription
AutoFitModeSplitterAutoFitModeSplitterAutoFitMode.ProportionalDetermines how the items are arranged inside the Splitter.
Possible values:
  • end - all items will fit the size of the Splitter. When inserting a new item the space required for the item to fit will be deducted from it's neighbour.
  • proportional - all items will fit the size of the Splitter. When inserting a new item the space required for it to fit will be the result from the proportional deduction of the size from the rest of the items inside the element.
  • overflow - the items inside the Splitter will not fit it's size. Instead they overflow by taking the exact amount of space they need and a scrollbar is displayed in order to view the content.
DisabledboolfalseEnables or disables the element.
DataSourceIEnumerable<object>N/ASets or gets splitter's data source.
ItemsIEnumerable<object>A getter that returns an array of all Splitter items.
KeepProportionsOnResizeboolfalseIf set the element keeps the same proportions of the items after the whole element has been resized regardless of the size property unit ( pixels or percentages) of the items.
Localestring"en"Sets or gets the language. Used in conjunction with the property messages.
MessagesobjectN/ASets an object with string values, related to the different states of passwords strength.
OrientationOrientationOrientation.VerticalSets or gets splitter's orientation.
ReadonlyboolfalseIf the element is readonly, users cannot interact with it.
ResizeModeSplitterResizeModeSplitterResizeMode.AdjacentDetermines the resize mode of the splitter. Possible values are:
- None - resizing is disabled.
- Adjacent - only the two adjacent items between the target splitter bar are being affected. This is the default behavior.
- End - only the first item( left or top according to the orientation) of the target Splitter bar and the last item are affected.
Proportional - all of the items positioned in the direction to which the splitter bar is dragged will be affected. For example, when a splitter bar is dragged to the right all the items positioned on it's the right side will be affected. The items will obtain a proportional size corresponding to their current size.
ResizeStepint5Determines the resize step during reisizing
RightToLeftboolfalseSets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
LiveResizeboolfalseWhen enabled the resizing operation happens live. By default this feature is not enabled and the user sees a hightlighted bar while dragging instead of the actual splitter bar.
Themestring""Determines the theme. Theme defines the look of the element
UnfocusableboolfalseIf is set to true, the element cannot be focused.

Splitter Methods

NameTypeArgumentsDescription
AppendChildvoiddynamic nodeAppends a new node.Args: dynamic node - The node to append
Collapsevoidobject item, bool farCollapses splitter item.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
Collapsevoidobject itemCollapses splitter item.
Collapsevoidint item, bool farCollapses splitter item.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
Collapsevoidint itemCollapses splitter item.
Expandvoidobject itemExpands the splitter item if possible (if there's enough space available).Args: dynamic item - number indicating the index of the item or an isntance of Smart.SplitterItem
Expandvoidint itemExpands the splitter item if possible (if there's enough space available).Args: int item - number indicating the index of the item or an isntance of Smart.SplitterItem
GetDataSourceAsync()Task<IEnumerable<object>>'N/A'Gets the &quot;DataSource&quot; property as Task&lt;IEnumerable&lt;object&gt;&gt;.
HideBarintint splitterBarHides a splitter barArgs: int splitterBar - A Smart.SplitterBar instance.
Insertvoidint index, object detailsInsert a new Splitter item at a given position.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.
Insertvoidint index, string detailsInsert a new Splitter item at a given position.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.
InsertBeforedynamicdynamic newNode, dynamic referenceNodeInserts the specified "smart-splitter-item" node before the reference "smart-splitter-item" node.Args: dynamic newNode - The "smart-splitter-item" node to insert.,dynamic referenceNode - The "smart-splitter-item" node before which newNode is inserted.
InsertBeforedynamicdynamic newNodeInserts the specified "smart-splitter-item" node before the reference "smart-splitter-item" node.
LockBarvoidint indexLocks a splitter bar so it can't be dragged.Args: int index - The index of a Splitter Bar or it's instance.
LockItemvoidint indexLocks a splitter item so it's size can't change.Args: int index - The index of a Splitter Bar or it's instance.
Refreshvoid'N/A'Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements.
RefreshvoidN/ARefreshes the Splitter
RemoveAllvoidN/ARemoves all items from the Splitter
RemoveAtvoidint indexRemoves a Splitter item.Args: int index - An item to be removed.
RemoveChilddynamicdynamic nodeRemoves a child "smart-splitter-item" node.Args: dynamic node - The "smart-splitter-item" node to remove.
Rendervoid'N/A'Re-renders the Blazor Component. This method will make a full re-render.
ShowBarvoidint splitterBarUnhides a Splitter BarArgs: int splitterBar - An instance of a splitter bar.
StateHasChangedvoid'N/A'Refreshes the state and Re-renders the Blazor Component, if necessary.
UnlockBarvoidint itemUnlocks a previously locked splitter bar.Args: int item - The index of a Splitter Bar or it's instance.
UnlockItemvoidint itemUnlocks a previously locked splitter item.Args: int item - The index of a Splitter Item or it's instance.
Updatevoidobject item, object settingsUpdates the properties of a Splitter item inside the Splitter.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

NameTypeDescriptionEvent Detail
OnCollapseEventCallback<Event>This event is triggered when splitter item is collapsed.N/A
Collapsedevent SplitterCollapsedEventHandlerThis event is triggered when splitter item is collapsed.SplitterCollapsedEventArgs
OnExpandEventCallback<Event>This event is triggered when splitter item is expanded.N/A
Expandedevent SplitterExpandedEventHandlerThis event is triggered when splitter item is expanded.SplitterExpandedEventArgs
OnResizeStartEventCallback<Event>This event is triggered when splitter resizing begins.N/A
ResizeStartedevent SplitterResizeStartedEventHandlerThis event is triggered when splitter resizing begins.SplitterResizeStartedEventArgs
OnResizeEndEventCallback<Event>This event is triggered when splitter resizing finishes.N/A
ResizeEndedevent SplitterResizeEndedEventHandlerThis event is triggered when splitter resizing finishes.SplitterResizeEndedEventArgs

Enums

SplitterAutoFitMode

SplitterAutoFitMode.End
SplitterAutoFitMode.Proportional
SplitterAutoFitMode.Overflow

Orientation

Orientation.Horizontal
Orientation.Vertical

SplitterResizeMode

SplitterResizeMode.None
SplitterResizeMode.Adjacent
SplitterResizeMode.End
SplitterResizeMode.Proportional