Add documentation for the "command" and "commandfor" attributes, and "command" event. #30829

keithamus · 2023-12-06T11:02:37Z

Description

This PR drafts up the documentation for "Invokers" (OpenUI explainer). This is a new experimental API for enabling buttons to control interactive elements.

Motivation

As this feature is starting to land (flagged) in 3 major browsers, it seems right to start documenting the featureset.

Additional details

Chrome Platform Status feature
Mozilla has positive signals on this feature and it has shipped behind the dom.element.invokers.enabled flag.
Safari has positive signals and the initial prototype has been merged for testing, behind a flag.

Related issues and pull requests

Initial BCD PR add data for Invokers (invoketarget, invokeaction, InvokeEvent) browser-compat-data#21542
Rename BCD PR rename invoker related attributes & events to command browser-compat-data#24362

teoli2003 · 2023-12-06T11:05:23Z

(Converted to draft so that nobody review this, yet)

github-actions · 2023-12-06T11:07:23Z

Preview URLs (9 pages)

Flaws (2)

Note! 7 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/Invoker_Commands_API
Title: Invoker Commands API
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: api.HTMLButtonElement.commandForElement

URL: /en-US/docs/Web/API/HTMLButtonElement/commandForElement
Title: HTMLButtonElement: commandForElement property
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: api.HTMLButtonElement.commandForElement

(comment last updated: 2024-10-17 19:46:10)

files/en-us/web/api/invokers_api/index.md

files/en-us/web/api/invokeevent/index.md

github-actions · 2024-07-11T21:01:17Z

This pull request has merge conflicts that must be resolved before it can be merged.

Josh-Cena

Thanks; I have a lot of nits proposed, but I think this looks good already.

files/en-us/web/api/commandevent/command/index.md

files/en-us/web/api/commandevent/commandevent/index.md

files/en-us/web/api/htmlbuttonelement/command/index.md

files/en-us/web/api/commandevent/source/index.md

files/en-us/web/api/invoker_commands_api/index.md

files/en-us/web/html/element/button/index.md

files/en-us/web/api/invoker_commands_api/index.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

files/en-us/web/api/commandevent/commandevent/index.md

Josh-Cena · 2024-09-23T21:38:12Z

Should I wait for the other reviewers to make a final pass?

keithamus · 2024-09-26T18:27:52Z

Given it's been three days since your comment perhaps the "waiting for other reviewers" has passed anyway? (Not a judgement btw).

Josh-Cena · 2024-09-26T22:56:46Z

I'll merge this some time next week.

lukewarlow · 2024-09-27T11:40:09Z

files/en-us/web/api/invoker_commands_api/index.md

+
+{{DefaultAPISidebar("Invoker Commands API")}}
+
+The **Invoker Commands API** provides a way to declaratively assign behaviors to buttons, allowing control of interactive elements when the button is enacted (clicked or invoked via a keypress, such as the spacebar or return key).


Perhaps "enacted" could be replaced with another word. It doesn't quite read naturally to me. Maybe "activated", idk what the normal word mdn uses is.

files/en-us/web/api/invoker_commands_api/index.md

lukewarlow · 2024-09-27T13:00:39Z

The preview suggests there's issues with the browser compat data is that expected?

files/en-us/web/html/element/button/index.md

lukewarlow · 2024-09-27T13:04:00Z

Is it worth mentioning the requirements around explicit type attribute when inside a form?

Josh-Cena · 2024-09-28T05:43:41Z

The preview suggests there's issues with the browser compat data is that expected?

I think the only issue is that there's no spec URL, which is kind of expected given that whatwg/html#9841 is still open. @keithamus if you want to make an issue to BCD to keep it in the backlog it would be great.

Josh-Cena · 2024-10-15T18:37:22Z

@keithamus Just waiting on the last bits of reviews to be addressed

Co-authored-by: Luke Warlow <luke@warlow.dev>

keithamus · 2024-10-16T11:08:32Z

The preview suggests there's issues with the browser compat data is that expected?

I think the only issue is that there's no spec URL, which is kind of expected given that whatwg/html#9841 is still open. @keithamus if you want to make an issue to BCD to keep it in the backlog it would be great.

mdn/browser-compat-data#24739

files/en-us/web/api/commandevent/index.md

Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>

Josh-Cena · 2024-10-24T16:18:38Z

@lukewarlow Let me know when this is good to merge

lukewarlow · 2024-10-24T16:21:15Z

Lgtm! @keithamus do we want to wait for the html pr?

keithamus · 2024-10-24T16:50:52Z

It doesn't seem necessary to me to wait but if people would like to I don't mind.

Josh-Cena · 2024-10-24T21:36:27Z

Thanks for all the work everyone; since we have BCD already, I think this meets the documentation criteria and we can merge it.

keithamus requested review from a team as code owners December 6, 2023 11:02

keithamus requested review from Elchi3 and chrisdavidmills and removed request for a team December 6, 2023 11:02

github-actions bot added Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs labels Dec 6, 2023

teoli2003 marked this pull request as draft December 6, 2023 11:04

lukewarlow reviewed Dec 6, 2023

View reviewed changes

files/en-us/web/api/invokers_api/index.md Outdated Show resolved Hide resolved

lukewarlow reviewed Dec 6, 2023

View reviewed changes

files/en-us/web/api/invokers_api/index.md Outdated Show resolved Hide resolved

lukewarlow reviewed Dec 6, 2023

View reviewed changes

files/en-us/web/api/invokers_api/index.md Outdated Show resolved Hide resolved

lukewarlow reviewed Dec 6, 2023

View reviewed changes

files/en-us/web/api/invokers_api/index.md Outdated Show resolved Hide resolved

lukewarlow reviewed Dec 6, 2023

View reviewed changes

files/en-us/web/api/invokeevent/index.md Outdated Show resolved Hide resolved

lukewarlow reviewed Dec 6, 2023

View reviewed changes

files/en-us/web/api/invokeevent/index.md Outdated Show resolved Hide resolved

files/en-us/web/api/invokeevent/index.md Outdated Show resolved Hide resolved

keithamus mentioned this pull request Dec 8, 2023

add data for Invokers (invoketarget, invokeaction, InvokeEvent) mdn/browser-compat-data#21542

Merged

chrisdavidmills removed their request for review January 16, 2024 10:58

keithamus mentioned this pull request Feb 13, 2024

Add commandfor & command attributes to HTMLButtonElement whatwg/html#9841

Open

5 tasks

github-actions bot added the merge conflicts 🚧 [PR only] label Jul 11, 2024

bsmth added the waiting for implementations Waiting for feature to be implemented in browsers label Jul 15, 2024

Elchi3 removed their request for review July 23, 2024 13:02

keithamus force-pushed the draft-invokers-api-docs branch from daeba33 to dd68146 Compare September 6, 2024 09:24

github-actions bot added the size/m [PR only] 51-500 LoC changed label Sep 6, 2024

keithamus force-pushed the draft-invokers-api-docs branch from dd68146 to 48a6f67 Compare September 6, 2024 09:26

keithamus added 2 commits September 6, 2024 10:27

draft Invokers API docs

a11676d

clean up wording

ad57385

keithamus force-pushed the draft-invokers-api-docs branch from 48a6f67 to bbc194f Compare September 6, 2024 09:27

Josh-Cena approved these changes Sep 23, 2024

View reviewed changes

Apply suggestions from code review

c4097c7

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

Josh-Cena reviewed Sep 23, 2024

View reviewed changes

files/en-us/web/api/commandevent/commandevent/index.md Outdated Show resolved Hide resolved

Update index.md

e6188f1