Skip to content

Deprecate buttons parameter for Buttongrid element #2713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lolodomo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Deprecate buttons parameter for Buttongrid element #2713

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ui/sitemaps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,12 +319,12 @@ A Buttongrid represents a grid of buttons and enables commands to be sent to an

This is a typical element for simulating a remote control, for example.

- `item` commands triggered by the buttons are sent to the item identified by this parameter. This parameter is only required if the `buttons` parameter is also used.
- (deprecated) `item` commands triggered by the buttons are sent to the item identified by this parameter. This parameter is only required if the `buttons` parameter is also used.
- `label` if set, a header row will be displayed containing this label and the icon.
- `buttons` defines the position of each button within the grid and the command associated with each button; provided as an array.
- (deprecated) `buttons` defines the position of each button within the grid and the command associated with each button; provided as an array.

When buttons are defined by the `buttons` parameter, all buttons are linked to the same Item and a command can only be sent to that item when one button is clicked (and not when it is pressed and released); buttons never appear as selected, they do not display the current state of the linked Item.
The `buttons` parameter is optional, using Button elements as children is now the best option because it provides more functionality, but this option is not yet supported by all sitemap UIs.
The `buttons` parameter is optional and now deprecated, using Button elements as children is now the best option because it provides more functionality, but this option is not yet supported by all sitemap UIs.

Buttons syntax:

Expand Down