AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.ButtonGroup Class

    Defined in: alloy-ui/src/aui-button/js/aui-button-core.js:426
    Module: aui-button

    A base class for ButtonGroup.

    Constructor

    Methods

    _afterSelectionChange

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:588

    Fires after 'selectionChange' event.

    initializer

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:438

    Constructor for A.ButtonGroup. Lifecycle.

    item

    (
    • index
    )
    Button | Node

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:484

    Returns the item or node of specified index.

    Parameters:

    Returns:

    Button | Node:

    The item as Button or Node instance.

    renderUI

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:448

    Renders the ButtonGroup component instance. Lifecycle.

    select

    (
    • items
    )

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:505

    Selects items by adding the active class name.

    Parameters:

    • items Array

    syncAriaSelected

    (
    • buttons
    )

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:515

    Updates the 'aria-selected' attribute on all buttons.

    Parameters:

    • buttons Array

    toggleSelect

    (
    • items
    • forceSelection
    )

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:531

    Toggles selection by adding or removing the active class name.

    Parameters:

    • items Array
    • forceSelection Boolean

      Whether selection should be forced.

    unselect

    (
    • items
    )

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:578

    Selects items by adding the active class name.

    Parameters:

    • items Array