Split button

A button whose end is a second control opening a menu of commands.

SplitButtonComponent · type key standard.split-button · Actions

The entries are a MenuComponent of the same MenuItem model a sidebar uses (icon, title, shortcut, enabled, a caption or a rule by Kind), drawn in a popup by the machinery a context menu uses.

new SplitButtonComponent("split-button")

Properties

Events

OnItemClick(string command)

Registers the command an entry runs when clicked.

OnItemClick(string command, params KeyValuePair<string, UIActionArgument>[] arguments)

Registers the command an entry runs when clicked, with UI action arguments.

OnItemClickWithItem(string command, string argumentName = "item")

Registers the command an entry runs, passing the entry as an argument.

OnItemClickWithItemKey(string command, string argumentName = "id")

Registers the command an entry runs, passing the entry's key as an argument.

OnClickShowingLoading(string command)

Runs the command on a click and shows the button waiting for exactly the round trip: two client interactions on Loading, one before the dispatch and one after the result, nothing bound and nothing for a controller to clear.
Named for what it shows, not for what it carries: With elsewhere in this API names an argument the command receives (OnItemClickWithItem), and nothing is passed here.

OnClick(string command)

Registers a click handler that invokes the specified command.

OnClick(string command, params KeyValuePair<string, UIActionArgument>[] arguments)

Registers a click handler that invokes the specified command with UI action arguments.

OnClickLiteral(string command, params KeyValuePair<string, object>[] arguments)

Registers a click handler that invokes the specified command with literal argument values.

OnSubmit(string formId, string command)

Registers a click command that first runs Submit-trigger validation for every input sharing formId, dispatching the command only if all of them pass.

OnSubmit(string formId, string command, params KeyValuePair<string, UIActionArgument>[] arguments)

Registers a click command that first runs Submit-trigger validation for every input sharing formId, dispatching the command only if all of them pass.

OnSubmitLiteral(string formId, string command, params KeyValuePair<string, object>[] arguments)

Registers a click command that first runs Submit-trigger validation for every input sharing formId, dispatching the command only if all of them pass.

Methods

SetItems(IEnumerable<MenuItem> items)

Replaces the menu's entries.

AddItem(MenuItem item)

Adds one entry to the menu.

BindItems(string path, UIBindingScope scope = UIBindingScope.Root)

Binds the menu's entries to a collection of MenuItem on the controller.