SplitButton extends AbstractButton

This button type renders a bootstrap split button.

public function __construct(
    protected readonly ComponentFactory $componentFactory,
) }

public function myAction(): ResponseInterface
{
    $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();

    $saveButton = $this->componentFactory->createInputButton()
         ->setName('save')
         ->setValue('1')
         ->setIcon($this->iconFactory->getIcon('actions-document-save', IconSize::SMALL))
         ->setTitle('Save');

    $saveAndCloseButton = $this->componentFactory->createInputButton()
         ->setName('save_and_close')
         ->setValue('1')
         ->setTitle('Save and close')
         ->setIcon($this->iconFactory->getIcon('actions-document-save-close', IconSize::SMALL));

    $saveAndShowPageButton = $this->componentFactory->createInputButton()
         ->setName('save_and_show')
         ->setValue('1')
         ->setTitle('Save and show')
         ->setIcon($this->iconFactory->getIcon('actions-document-save-view', IconSize::SMALL));

    $moduleLink = $this->componentFactory->createLinkButton()
         ->setHref((string)$this->uriBuilder->buildUriFromRoute('file_edit', $parameter))
         ->setDataAttributes(['customAttribute' => 'customValue'])
         ->setShowLabelText(true)
         ->setTitle('Edit file')
         ->setIcon($this->iconFactory->getIcon('file-edit', IconSize::SMALL));

    $splitButtonElement = $this->componentFactory->createSplitButton()
         ->addItem($saveButton, true)
         ->addItem($saveAndCloseButton)
         ->addItem($moduleLink)
         ->addItem($saveAndShowPageButton);
}

Table of Contents

Properties

$attributes  : array<string|int, mixed>

Attributes for the button

$classes  : string

CSS classes to apply to the rendered element

$containsPrimaryAction  : bool

Internal var that determines whether the split button has received any primary actions yet

$dataAttributes  : array<string, string>

HTML data-* attributes for the control

$disabled  : bool

Whether the button is in disabled state

$icon  : Icon|null

Optional icon to display on the button

$options  : array<string|int, AbstractButton>

Array of option buttons for the dropdown

$primary  : AbstractButton|null

Primary action button

$showLabelText  : bool

Whether to show the button's label text (from title property).

$title  : string

Title/label text for the control

Methods

__toString()  : string

Implementation from ButtonInterface This object is an abstract, so no implementation is necessary

addItem()  : static

Adds an instance of any button to the split button

getAttributes()  : array<string, string>

getClasses()  : string

getDataAttributes()  : array<string|int, mixed>

getIcon()  : Icon|null

getItems()  : SplitButtonItems

Returns the split button items as a typed DTO.

getShowLabelText()  : bool

getTitle()  : string

getType()  : string

Returns the fully qualified class name as the component type identifier.

isDisabled()  : bool

isValid()  : bool

Implementation from ButtonInterface This object is an abstract, so no implementation is necessary

render()  : string

Renders the HTML markup of the button

setAttributes()  : static

setClasses()  : static

setDataAttributes()  : static

setDisabled()  : static

setIcon()  : static

setShowLabelText()  : static

setTitle()  : static