alfresco-ng2-components/docs/core/menu-button.model.md
Andy Stark 28ba09897e [ADF-2764] Added new type linker features and applied them to core docs (#3442)
* [ADF-2764] Added basic support for composite and external types

* [ADF-2764] Added new type linker features and applied to core docs
2018-06-06 13:21:31 +02:00

1.3 KiB

Added, Status, Last reviewed
Added Status Last reviewed
v2.4.0 Active 2018-05-25

Menu button model

Defines the properties for an item in a Buttons Menu component.

Basic usage

let button = new MenuButton({
    label: 'Export',
    icon: 'file_download',
    handler: this.exportItem.bind(this),
    id: 'export-button',
    isVisible: this.isItemValid.bind(this)
});

Properties

Name Type Description
label string Label to display for the button.
icon string Icon to display for the button.
handler function Callback for the event handler for button clicks.
styles string CSS classes to apply to the button.
id string Id of the button.
isVisible function Boolean function that determines whether the button is visible (returns true) or hidden (returns false).

Details

An array of MenuButton instances is passed to the Button Menu component via its buttons property. See the Buttons Menu component page for a code sample and further details about setting up the menu.

See also