JavaScript
EditEdit This DocumentInstall NuGet
Demos
Support
Forum
FREE TRIAL
Search results

SplitButton

SplitButton component has primary and secondary button. Primary button is used to select default action and secondary button is used to toggle contextual overlays for displaying list of action items. It can contain both text and images.

<button id="element"></button>
<script>
var splitBtnObj = new SplitButton({content: 'SplitButton'});
splitBtnObj.appendTo("#element");
</script>

Properties

closeActionEvents

string

Specifies the event to close the DropDownButton popup.

Defaults to ""

content

string

Defines the content of the SplitButton primary action button can either be a text or HTML elements.

Defaults to ""

createPopupOnClick

boolean

Specifies the popup element creation on open.

Defaults to false

cssClass

string

Defines class/multiple classes separated by a space in the SplitButton element. The SplitButton size and styles can be customized by using this.

Defaults to ""

disabled

boolean

Specifies a value that indicates whether the SplitButton is disabled or not.

Defaults to false.

enableHtmlSanitizer

boolean

Specifies whether to enable the rendering of untrusted HTML values in the DropDownButton component. If ‘enableHtmlSanitizer’ set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.

Defaults to true

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

iconCss

string

Defines class/multiple classes separated by a space for the SplitButton that is used to include an icon. SplitButton can also include font icon and sprite image.

Defaults to ""

iconPosition

SplitButtonIconPosition

Positions the icon before/top of the text content in the SplitButton. The possible values are

  • Left: The icon will be positioned to the left of the text content.
  • Top: The icon will be positioned to the top of the text content.

Defaults to “Left”

items

ItemModel[]

Specifies action items with its properties which will be rendered as SplitButton secondary button popup.

Defaults to []

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ”

target

string | Element

Allows to specify the SplitButton popup item element.

Defaults to ""

Methods

addEventListener

Adds the handler to the given event listener.

Parameter Type Description
eventName string A String that specifies the name of the event
handler Function Specifies the call to run when the event occurs.

Returns void

addItems

Adds a new item to the menu. By default, new item appends to the list as the last item, but you can insert based on the text parameter.

Parameter Type Description
items ItemModel[] Specifies an array of JSON data.
text (optional) string Specifies the text to insert the newly added item in the menu.

Returns void

appendTo

Appends the control within the given HTML element

Parameter Type Description
selector (optional) string | HTMLElement Target element where control needs to be appended

Returns void

attachUnloadEvent

Adding unload event to persist data when enable persistence true

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

detachUnloadEvent

Removing unload event to persist data when enable persistence true

Returns void

focusIn

Sets the focus to SplitButton its native method

Returns void

getLocalData

Returns the persistence data for component

Returns any

getPersistData

Get the properties to be maintained in the persisted state.

Returns string

getRootElement

Returns the route element of the component

Returns HTMLElement

handleUnload

Handling unload event to persist data when enable persistence true

Returns void

onPropertyChanged

Called internally if any of the property value changed.

Parameter Type Description
newProp SplitButtonModel Specifies new properties
oldProp SplitButtonModel Specifies old properties

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Parameter Type Description
eventName string A String that specifies the name of the event to remove
handler Function Specifies the function to remove

Returns void

removeItems

Removes the items from the menu.

Parameter Type Description
items string[] Specifies an array of string to remove the items.
isUniqueId (optional) boolean Set true if specified items is a collection of unique id.

Returns void

toggle

To open/close SplitButton popup based on current state of the SplitButton.

Returns void

Inject

Dynamically injects the required modules to the component.

Parameter Type Description
moduleList Function[] ?

Returns void

Events

beforeClose

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before closing the SplitButton popup.

beforeItemRender

EmitType<MenuEventArgs>

Triggers while rendering each Popup item of SplitButton.

beforeOpen

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before opening the SplitButton popup.

click

EmitType<ClickEventArgs>

Triggers when the primary button of SplitButton has been clicked.

close

EmitType<OpenCloseMenuEventArgs>

Triggers while closing the SplitButton popup.

created

EmitType<Event>

Triggers once the component rendering is completed.

open

EmitType<OpenCloseMenuEventArgs>

Triggers while opening the SplitButton popup.

select

EmitType<MenuEventArgs>

Triggers while selecting action item of SplitButton popup.

Previous
Next