material-web icon indicating copy to clipboard operation
material-web copied to clipboard

docs: unclear request-activation event without documentation

Open silamon opened this issue 2 years ago • 5 comments

What is affected?

Accessibility, Component

Description

In the playground sample, there's a md-list basic example with request-activation. The event is documented without description, so I may misinterpret what it's doing exactly, but I expect it to activate when the item is clicked or selected through tab and activated with "enter" keypress.

The request-activation event isn't fired when you tabselected an item (tab into list and using arrow keys to navigate) and press enter.

Reproduction

https://lit.dev/playground/#project=W3sibmFtZSI6InNpbXBsZS1ncmVldGluZy50cyIsImNvbnRlbnQiOiJpbXBvcnQge2h0bWwsIGNzcywgTGl0RWxlbWVudH0gZnJvbSAnbGl0JztcbmltcG9ydCB7Y3VzdG9tRWxlbWVudCwgcHJvcGVydHl9IGZyb20gJ2xpdC9kZWNvcmF0b3JzLmpzJztcblxuaW1wb3J0IFwiQG1hdGVyaWFsL3dlYi9hbGxcIjtcbmltcG9ydCBcIkBtYXRlcmlhbC9td2MtbGlzdC9td2MtbGlzdFwiO1xuaW1wb3J0IFwiQG1hdGVyaWFsL213Yy1saXN0L213Yy1saXN0LWl0ZW1cIjtcblxuQGN1c3RvbUVsZW1lbnQoJ29sZC1saXN0JylcbmV4cG9ydCBjbGFzcyBPbGRMaXN0IGV4dGVuZHMgTGl0RWxlbWVudCB7XG4gIG9uUmVxdWVzdEFjdGl2YXRpb24oZXYpe1xuICAgICBjb25zb2xlLmxvZyhldik7IFxuICB9XG4gIHJlbmRlcigpIHtcbiAgICByZXR1cm4gaHRtbGBcbiAgICAgPG13Yy1saXN0IGFyaWEtbGFiZWw9XCJJbnRlcmFjdGl2ZSBleGFtcGxlXCI-XG4gICAgICAgIDxtd2MtbGlzdC1pdGVtIHR5cGU9XCJidXR0b25cIiBAcmVxdWVzdC1zZWxlY3RlZD0ke3RoaXMub25SZXF1ZXN0QWN0aXZhdGlvbn0-XG4gICAgICAgICAgQnV0dG9uIGl0ZW0gMVxuICAgICAgICA8L213Yy1saXN0LWl0ZW0-XG5cbiAgICAgICAgPG13Yy1saXN0LWl0ZW0gdHlwZT1cImJ1dHRvblwiIEByZXF1ZXN0LXNlbGVjdGVkPSR7dGhpcy5vblJlcXVlc3RBY3RpdmF0aW9ufT5cbiAgICAgICAgICBCdXR0b24gaXRlbSAyIFxuICAgICAgICA8L213Yy1saXN0LWl0ZW0-XG4gICAgICA8L213Yy1saXN0PlxuICAgIGA7XG4gIH1cbn1cblxuQGN1c3RvbUVsZW1lbnQoJ25ldy1saXN0JylcbmV4cG9ydCBjbGFzcyBOZXdMaXN0IGV4dGVuZHMgTGl0RWxlbWVudCB7XG4gIG9uUmVxdWVzdEFjdGl2YXRpb24oZXYpe1xuICAgICBjb25zb2xlLmxvZyhldik7IFxuICB9XG4gIHJlbmRlcigpIHtcbiAgICByZXR1cm4gaHRtbGBcbiAgICAgPG1kLWxpc3QgYXJpYS1sYWJlbD1cIkludGVyYWN0aXZlIGV4YW1wbGVcIj5cbiAgICAgICAgPG1kLWxpc3QtaXRlbSB0eXBlPVwiYnV0dG9uXCIgQHJlcXVlc3QtYWN0aXZhdGlvbj0ke3RoaXMub25SZXF1ZXN0QWN0aXZhdGlvbn0-XG4gICAgICAgICAgQnV0dG9uIGl0ZW0gMVxuICAgICAgICA8L21kLWxpc3QtaXRlbT5cblxuICAgICAgICA8bWQtbGlzdC1pdGVtIHR5cGU9XCJidXR0b25cIiBAcmVxdWVzdC1hY3RpdmF0aW9uPSR7dGhpcy5vblJlcXVlc3RBY3RpdmF0aW9ufT5cbiAgICAgICAgICBCdXR0b24gaXRlbSAyXG4gICAgICAgIDwvbWQtbGlzdC1pdGVtPlxuICAgICAgPC9tZC1saXN0PlxuICAgIGA7XG4gIH1cbn1cbiJ9LHsibmFtZSI6ImluZGV4Lmh0bWwiLCJjb250ZW50IjoiPCFET0NUWVBFIGh0bWw-XG48aGVhZD5cbiAgPHNjcmlwdCB0eXBlPVwibW9kdWxlXCIgc3JjPVwiLi9zaW1wbGUtZ3JlZXRpbmcuanNcIj48L3NjcmlwdD5cbjwvaGVhZD5cbjxib2R5PlxuICBtd2MtbGlzdFxuICA8b2xkLWxpc3Q-PC9vbGQtbGlzdD5cbiAgbWQtbGlzdFxuICA8bmV3LWxpc3Q-PC9uZXctbGlzdD5cbjwvYm9keT5cbiJ9LHsibmFtZSI6InBhY2thZ2UuanNvbiIsImNvbnRlbnQiOiJ7XG4gIFwiZGVwZW5kZW5jaWVzXCI6IHtcbiAgICBcImxpdFwiOiBcIl4zLjAuMC1wcmUuMVwiLFxuICAgIFwiQGxpdC9yZWFjdGl2ZS1lbGVtZW50XCI6IFwiXjIuMC4wLXByZS4xXCIsXG4gICAgXCJsaXQtZWxlbWVudFwiOiBcIl40LjAuMC1wcmUuMVwiLFxuICAgIFwibGl0LWh0bWxcIjogXCJeMy4wLjAtcHJlLjFcIlxuICB9XG59IiwiaGlkZGVuIjp0cnVlfV0

Workaround

I have not found a workaround

Is this a regression?

Yes. This used to work, but now it doesn't.

Affected versions

1.1.1

Browser/OS/Node environment

Chrome latest version, firefox latest version

silamon avatar Jan 07 '24 10:01 silamon

I expect it to activate when the item is clicked or selected through tab and activated with "enter" keypress.

I believe this event is used to notify the list of tabindex change requests. It's used for setting up controllers, I don't think it's meant for client usage (@e111077 may know more).

What are you trying to use the event for? From your use case description, I believe the click event is what you're looking for.

asyncliz avatar Jan 08 '24 18:01 asyncliz

That seems to work well indeed, thank you for the clarification. Shall I leave the issue open to add the documentation for the request-activation event?

silamon avatar Jan 08 '24 19:01 silamon

@e111077 is the request-activation event intended to be used by folks? If so, we can add docs. Otherwise, we should remove it from the docs

asyncliz avatar Jan 08 '24 19:01 asyncliz

request-activation is still documented, but our docs bot is still broken.

It's really only meant to be used by people trying to make their own list/menu/select item or if someone wants to preventDefault / stopPropagation for complex menu interactions. I think it should stay documented

e111077 avatar Jan 08 '24 21:01 e111077

sg, I'll leave this open to fix the docs

asyncliz avatar Jan 11 '24 22:01 asyncliz