SplitButton
Represents the Kendo UI for Vue SplitButton component. Accepts properties of type SplitButtonProps. Use the SplitButton to run a main action with a click and to show more actions in a popup.
Definition
Package:@progress/kendo-vue-buttons
Properties Interface:SplitButtonProps
Syntax:
<SplitButton :text="'Save'" :items="['Save As', 'Save Copy']" />
Properties
accessKey?
string
Sets the accesskey attribute of the main button. Users press this key to focus the main button.
ariaLabel?
string
Sets the aria-label attribute of the main button. If you do not set it and the main button shows only an icon, the SplitButton uses Action.
buttonClass?
string
Sets the CSS class of the main button.
className?
string
Sets additional CSS classes to the SplitButton.
dir?
string
Sets the direction of the SplitButton. Accepts ltr or rtl.
disabled?
boolean
Sets whether the SplitButton is disabled (see example).
endIcon?
string
Sets the name of a font icon to render after the text of the main button. It does not change the arrow button.
endSvgIcon?
SVGIcon
Sets the SVGIcon to render after the text of the main button.
It does not change the arrow button.
fillMode?
"solid" | "outline" | "flat" | "link"
Sets the fill style of the SplitButton.
The available options are:
- solid
- outline
- flat
- link
undefined
icon?
string
Sets the name of a font icon that the SplitButton renders next to the text of the main button (see example).
iconClass?
string
Sets a CSS class for a custom icon that the SplitButton renders next to the text of the main button (see example).
imageUrl?
string
Sets the URL of an image that the SplitButton shows next to the text of the main button (see example).
item?
any
Sets a custom template for each item (see example). Accepts a slot name, a render function, or a Vue component. The default template renders an icon, an image, and text.
itemRender?
any
Sets a custom template for each item. Use it to change the default look of the items.
If you do not set the item property, itemRender works like item. This keeps backward compatibility with versions before 4.2.0.
items?
any[]
Sets the items of the popup list (see example).
[]
onBlur?
(event: SplitButtonBlurEvent) => void
Fires when the SplitButton loses the focus (see example). The event name is blur.
onButtonclick?
(event: SplitButtonClickEvent) => void
Fires when the user clicks the main button (see example). The event name is buttonclick.
onClose?
(event: SplitButtonCloseEvent) => void
Fires when the popup with the items closes (see example). The event name is close.
onFocus?
(event: SplitButtonFocusEvent) => void
Fires when the SplitButton gets the focus (see example). The event name is focus.
onItemclick?
(event: SplitButtonItemClickEvent) => void
Fires when the user clicks an item (see example). The event name is itemclick.
onOpen?
(event: SplitButtonOpenEvent) => void
Fires when the popup with the items opens (see example). The event name is open.
opened?
boolean
Sets whether the popup of the SplitButton is open. When you set it, you control the open state.
Sets the settings of the popup (see example).
rounded?
"small" | "medium" | "large" | "none" | "full"
Sets the border radius of the SplitButton.
The available options are:
- none
- small
- medium
- large
- circle
- full
undefined
size?
"xs" | "small" | "medium" | "large"
Sets the size of the SplitButton.
The available options are:
- xs
- small
- medium
- large
undefined
svgIcon?
SVGIcon
Sets the SVGIcon that the SplitButton renders next to the text of the main button.
tabIndex?
number
Sets the tabindex attribute of the main button.
text?
string
Sets the text of the main button (see example).
textField?
string
Sets the field of the data item that provides the text of each item. Use it together with the items property (see example).
themeColor?
"base" | "primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "error" | "inverse"
Sets the theme color of the SplitButton.
The available options are:
- base
- primary
- secondary
- tertiary
- info
- success
- warning
- error
- inverse
undefined