Skip to content
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.

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

Add popover documentation for methods, events, and psuedo selectors #26145

Merged
merged 6 commits into from
Apr 14, 2023

Conversation

keithamus
Copy link
Contributor

Description

This adds more documentation related to popover. Most of the specifications for which can be found here: https://html.spec.whatwg.org/multipage/popover.html.

Motivation

This feature is currently not documented. This follows on from #25961 which added the initial links to various pages.

Additional details

Related issues and pull requests

#25125

@keithamus keithamus requested review from a team as code owners April 12, 2023 09:11
@keithamus keithamus requested review from sideshowbarker, schalkneethling and estelle and removed request for a team April 12, 2023 09:11
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs labels Apr 12, 2023
@keithamus keithamus changed the title More popover docs Add popover documentation for methods, events, and psuedo selectors Apr 12, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Apr 12, 2023

Preview URLs (8 pages)
Flaws (11)

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

URL: /en-US/docs/Web/HTML/Global_attributes/popover
Title: popover
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/HTML/button#popovertarget
    • Can't resolve /en-US/docs/Web/API/HTMLElement/showPopover/

URL: /en-US/docs/Web/API/ToggleEvent
Title: ToggleEvent
Flaw count: 4

  • macros:
    • /en-US/docs/Web/API/ToggleEvent/ToggleEvent does not exist
    • /en-US/docs/Web/API/ToggleEvent/oldState does not exist
    • /en-US/docs/Web/API/ToggleEvent/newState does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.ToggleEvent

URL: /en-US/docs/Web/API/HTMLElement/beforetoggle_event
Title: HTMLElement: beforetoggle event
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/ToggleEvent/oldState does not exist
    • /en-US/docs/Web/API/ToggleEvent/newState does not exist

URL: /en-US/docs/Web/API/HTMLElement/toggle_event
Title: HTMLElement: toggle event
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/ToggleEvent/oldState does not exist
    • /en-US/docs/Web/API/ToggleEvent/newState does not exist

URL: /en-US/docs/Web/CSS/:popover-open
Title: :popover-open
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: css.selectors.popover-open
External URLs (1)

URL: /en-US/docs/Web/HTML/Global_attributes/popover
Title: popover

(comment last updated: 2023-04-14 13:40:19)

files/en-us/web/api/htmlelement/showpopover/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/htmlelement/toggle_event/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/htmlelement/toggle_event/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/htmlelement/togglepopover/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/htmlelement/hidepopover/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/toggleevent/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/toggleevent/index.md Outdated Show resolved Hide resolved
files/en-us/web/html/global_attributes/popover/index.md Outdated Show resolved Hide resolved
@sideshowbarker sideshowbarker merged commit 8448c8e into mdn:main Apr 14, 2023
@keithamus keithamus deleted the more-popover-docs branch April 14, 2023 14:31
@chrisdavidmills
Copy link
Contributor

@keithamus Hey there Keith! This is amazing: I was just starting to document the popover API when I noticed that you had done most of it already ;-)

Question — there are still a few bits of this API that could still do with documenting. Are you intending to do any more work on this, or shall I just jump in and get it finished off? I was thinking of creating a landing page for the overall API, pages for popovertarget and popovertargetaction, etc.

@keithamus
Copy link
Contributor Author

@chrisdavidmills I'll still be doing more. I intend to document popovertarget & popovertargetaction, as well as refining the existing work I've done. I considered a landing page - but perhaps I'll leave that one for you to work on 😝

@chrisdavidmills
Copy link
Contributor

@keithamus nice one, it'll be great to work alongside you. In case it helps, here is my research doc where I've looked into all the stuff that needs to be documented: https://docs.google.com/document/d/1ryC_4hvkLom0E7aaNnAB82_Ki5Rb_cKgrOJGSBU9fuw/edit# (you've done most of them, but there are a few more to do)

It would be good to have example code for all these pages as well.

I tested all the features today and noted down that everything seemed to be working.

I am happy to write the landing page. I'll start work on that tomorrow. I can also update the browser compact data if you like, to include anything that's missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants