HTML

The attribute's missing value default is the No Popover state, its invalid value default is the Manual state, and its empty value default is the Auto state.

The popover IDL attribute must reflect the popover attribute, limited to only known values .

The following attribute change steps , given element , localName , oldValue , value , and namespace , are used for all HTML elements :

1. If namespace is not null, then return.

2. If localName is not popover , then return.

3. If element 's popover visibility state is in the showing state and oldValue and value are in different states , then run the hide popover algorithm given element , true, true, false, and null.

The showPopover( options ) method steps are:

1. Let source be options [" source "] if it exists ; otherwise, null.

2. Run show popover given this , true, and source .

To show popover , given an HTML element element , a boolean throwExceptions , and an HTML element or null source :

1. If the result of running check popover validity given element , false, throwExceptions , and null is false, then return.

2. Let checkAncestor be the following steps:

   1. Let ancestor be the result of running the topmost popover ancestor algorithm given element , source , and true.

   2. If ancestor is not null, element 's popover attribute is in the Auto state, and ancestor 's popover attribute is in the Hint state:

      1. If throwExceptions is true, then throw an " InvalidStateError " DOMException .

      2. Return false.

      Hint popovers are lower priority than Auto popovers, so an Auto popover cannot have a Hint popover as a 'parent'.

   3. Return true.

3. If the result of running checkAncestor is false, then return.

4. Let document be element 's node document .

5. Assert : element 's popover trigger is null.

6. Assert : element is not in document 's top layer .

7. Let nestedShow be element 's popover showing or hiding .

8. Let fireEvents be the boolean negation of nestedShow .

9. Set element 's popover showing or hiding to true.

10. Let cleanupShowingFlag be the following steps:

    1. If nestedShow is false, then set element 's popover showing or hiding to false.

11. If the result of firing an event named beforetoggle , using ToggleEvent , with the cancelable attribute initialized to true, the oldState attribute initialized to " closed ", the newState attribute initialized to " open ", and the source attribute initialized to source at element is false, then run cleanupShowingFlag and return.

12. If the result of running check popover validity given element , false, throwExceptions , and document is false, then run cleanupShowingFlag and return.

    Check popover validity is called again because firing the beforetoggle event could have disconnected this element or changed its popover attribute.

13. If the result of running checkAncestor is false, then run cleanupShowingFlag and return.

    These checks are performed again because firing the beforetoggle event could have modified element state.

14. Let shouldRestoreFocus be false.

15. Let originalType be the current state of element 's popover attribute.

16. Let stackToAppendTo be null. Let autoAncestor be the result of running the topmost popover ancestor algorithm given element , document 's showing auto popover list , source , and true. Let hintAncestor be the result of running the topmost popover ancestor algorithm given element , document 's showing hint popover list , source , and true.

17. If originalType is the Auto or Hint state, then: Run close entire then run hide popover list stack until given document 's showing hint popover list , shouldRestoreFocus , and fireEvents . Let ancestor be the result of running the topmost popover ancestor algorithm given element , document 's showing auto popover list , source , and true. If ancestor is null, then set ancestor to document . Run hide all popovers until given ancestor , Hint , shouldRestoreFocus , and fireEvents .

18. Set stackToAppendTo to " auto ". If originalType is the Hint Auto state, then: If hintAncestor is not null, then: Run then run hide all popovers popover stack until given hintAncestor , shouldRestoreFocus ancestor , and fireEvents . Set stackToAppendTo to " hint ". Otherwise: Run close entire popover list given document 's showing hint popover list , shouldRestoreFocus , and fireEvents . If autoAncestor is not null, then: Run hide all popovers until given autoAncestor , Auto , shouldRestoreFocus , and fireEvents .

19. Set stackToAppendTo to " auto ". Otherwise, set stackToAppendTo to " hint ".

    If originalType is Auto or Hint , then:

    1. Assert : stackToAppendTo is not null.

       If originalType is not equal to the value of element 's popover attribute, then:

       1. If throwExceptions is true, then throw an " InvalidStateError " DOMException .

       2. Return.

    2. If the result of running check popover validity given element , false, throwExceptions , and document is false, then run cleanupShowingFlag and return.

       Check popover validity is called again because running hide all popovers popover stack until above could have fired the beforetoggle event, and an event handler could have disconnected this element or changed its popover attribute.

    3. If the result of running checkAncestor is false, then run cleanupShowingFlag and return.

       These checks are performed again because running hide popover stack until above could have fired the beforetoggle event, and an event handler could have altered DOM state.

    4. If the result of running topmost auto or hint popover on document is null, then set shouldRestoreFocus to true.

       This ensures that focus is returned to the previously-focused element only for the first popover in a stack.

    5. If stackToAppendTo originalType is " auto ": Auto :

       1. Assert : document 's showing auto popover list does not contain element .

       2. Set element 's opened in popover mode to " auto ".

       Otherwise:

       1. Assert : stackToAppendTo originalType is " hint ". Hint .

       2. Assert : document 's showing hint popover list does not contain element .

       3. Set element 's opened in popover mode to " hint ".

    6. Set element 's popover close watcher to the result of establishing a close watcher given element 's relevant global object , with:

       • cancelAction being to return true.

       • closeAction being to hide a popover given element , true, true, false, and null.

       • getEnabledState being to return true.

20. Set element 's previously focused element to null.

21. Let originallyFocusedElement be document 's focused area of the document 's DOM anchor .

22. Add an element to the top layer given element .

23. Set element 's popover visibility state to showing .

24. Set element 's popover trigger to source .

25. Set element 's implicit anchor element to source .

26. Run the popover focusing steps given element .

27. If shouldRestoreFocus is true and element 's popover attribute is not in the No Popover state, then set element 's previously focused element to originallyFocusedElement .

28. If originalType is Hint and ancestor 's opened in popover mode is " auto ", then set document 's hint stack parent to ancestor .

29. Queue a popover toggle event task given element , " closed ", " open ", and source .

30. Run cleanupShowingFlag .

To queue a popover toggle event task given an element element , a string oldState , a string newState , and an Element or null source :

1. If element 's popover toggle task tracker is not null, then:

   1. Set oldState to element 's popover toggle task tracker 's old state .

   2. Remove element 's popover toggle task tracker 's task from its task queue .

   3. Set element 's popover toggle task tracker to null.

2. Queue an element task given the DOM manipulation task source and element to run the following steps:

   1. Fire an event named toggle at element , using ToggleEvent , with the oldState attribute initialized to oldState , the newState attribute initialized to newState , and the source attribute initialized to source .

   2. Set element 's popover toggle task tracker to null.

3. Set element 's popover toggle task tracker to a struct with task set to the just-queued task and old state set to oldState .

The hidePopover() method steps are:

1. Run the hide popover algorithm given this , true, true, true, and null.

To hide a popover given an HTML element element , a boolean focusPreviousElement , a boolean fireEvents , a boolean throwExceptions , and an HTML element or null source :

1. If the result of running check popover validity given element , true, throwExceptions , and null is false, then return.

2. Let document be element 's node document .

3. Let nestedHide be element 's popover showing or hiding .

4. Set element 's popover showing or hiding to true.

5. If nestedHide is true, then set fireEvents to false.

6. Let cleanupSteps be the following steps:

   1. If nestedHide is false, then set element 's popover showing or hiding to false.

   2. If element 's popover close watcher is not null, then:

      1. Destroy element 's popover close watcher .

      2. Set element 's popover close watcher to null.

7. Let autoPopoverListContainsElement be true if document 's showing auto popover list contains element .

8. Let hintPopoverListContainsElement be true if document 's showing hint popover list contains element .

9. If element 's opened in popover mode is " auto " or " hint ", then:

   1. Run If hintPopoverListContainsElement is true, then hide popover stack until given element , document , Hint , focusPreviousElement , and fireEvents .

   2. If element is document 's hint stack parent , then hide popover stack until given null, document , Hint , focusPreviousElement , and fireEvents .

      If the document 's hint stack parent is to hide, then all hint popovers are hidden.

   3. If autoPopoverListContainsElement is true, then hide popover stack until given element , document , Auto , focusPreviousElement , and fireEvents .

   4. If the result of running check popover validity given element , true, throwExceptions , and null is false, then run cleanupSteps and return.

      Check popover validity is called again because running hide all popovers popover stack until could have disconnected element or changed its popover attribute.

10. Let autoPopoverListContainsElement be true if document 's showing auto popover list 's last item is element , otherwise false.

    If fireEvents is true:

    1. Fire an event named beforetoggle , using ToggleEvent , with the oldState attribute initialized to " open ", the newState attribute initialized to " closed ", and the source attribute set to source at element .

    2. If autoPopoverListContainsElement hintPopoverListContainsElement is true and document 's showing auto hint popover list 's last item is not element , then run hide all popover stack until given element , document , Hint , focusPreviousElement , and false.

       This happens if popovers are shown during the beforetoggle event. This is usually a developer error, so user agents are encouraged to show a warning.

    3. Otherwise, if autoPopoverListContainsElement is true and document 's showing auto popover list 's last item is not element , run hide popover stack until given element , document , Auto , focusPreviousElement , and false.

       This happens if popovers are shown during the beforetoggle event. This is usually a developer error, so user agents are encouraged to show a warning.

    4. If the result of running check popover validity given element , true, throwExceptions , and null is false, then run cleanupSteps and return.

       Check popover validity is called again because firing the beforetoggle event could have disconnected element or changed its popover attribute.

    5. Request an element to be removed from the top layer given element .

    6. Set element 's implicit anchor element to null.

11. Otherwise, remove an element from the top layer immediately given element .

12. Set element 's popover trigger to null.

13. Set element 's opened in popover mode to null.

14. Set element 's popover visibility state to hidden .

15. If element is document 's hint stack parent , or document 's showing hint popover list is empty , then set document 's hint stack parent to null.

16. If fireEvents is true, then queue a popover toggle event task given element , " open ", " closed ", and source .

17. Let previouslyFocusedElement be element 's previously focused element .

18. If previouslyFocusedElement is not null, then:

    1. Set element 's previously focused element to null.

    2. If focusPreviousElement is true and document 's focused area of the document 's DOM anchor is a shadow-including inclusive descendant of element , then run the focusing steps for previouslyFocusedElement ; the viewport should not be scrolled by doing this step.

19. Run cleanupSteps .

The togglePopover( options ) method steps are:

1. Let force be null.

2. If options is a boolean, set force to options .

3. Otherwise, if options [" force "] exists , set force to options [" force "].

4. Let source be options [" source "] if it exists ; otherwise, null.

5. If this 's popover visibility state is showing , and force is null or false, then run the hide popover algorithm given this , true, true, true, and null.

6. Otherwise, if force is null or true, then run show popover given this , true, and source .

7. Otherwise:

   1. Let expectedToBeShowing be true if this 's popover visibility state is showing ; otherwise false.

   2. Run check popover validity given expectedToBeShowing , true, and null.

8. Return true if this 's popover visibility state is showing ; otherwise false.

To hide all popovers until , given an HTML element or null endpoint , Document endpoint document , a boolean focusPreviousElement , and a boolean fireEvents :

1. If endpoint is an HTML element and endpoint is not in the popover showing state , then return. Let document be endpoint 's node document . Assert : endpoint is a Document or endpoint 's popover visibility state is showing . Assert : endpoint is a Document or endpoint 's popover attribute is in the Auto state or endpoint 's popover attribute is in the Hint state. If endpoint is a Document : Run close entire popover list given document 's showing hint popover list , focusPreviousElement , and fireEvents . Run close entire popover list given document 's showing auto popover list , focusPreviousElement , and fireEvents . Return. If document 's showing hint popover list contains endpoint : Assert : endpoint 's popover attribute is in the Hint state. Run hide popover stack until given endpoint , document 's showing hint popover list , focusPreviousElement , and fireEvents . Return. Run close entire popover list given document 's showing hint popover list Hint , focusPreviousElement , and fireEvents .

2. If document 's showing auto popover list does not contain endpoint , then return. Run hide popover stack until given endpoint , document 's showing auto popover list , Auto , focusPreviousElement , and fireEvents .

To hide popover stack until , given an HTML element or null endpoint , a list Document popoverList document , an Auto or Hint stackType , a boolean focusPreviousElement , and a boolean fireEvents :

1. Let repeatingHide popoverList be false. Perform the following steps at least once: document 's showing auto popover list if stackType is Auto ; otherwise document 's showing hint popover list .

2. Let lastToHide lastHideIndex be null. For each 0 if popover popoverList does not contain endpoint ; otherwise the index of endpoint in popoverList : plus 1.

3. If Let popover toHide is be a slice of endpoint , then break . popoverList from index lastHideIndex .

4. Set lastToHide to Reverse popover toHide .

5. If Let lastToHide toRemain is null, then return. While be a slice of lastToHide popoverList 's popover visibility state is showing : from index 0 to lastHideIndex .

6. Assert : For each popoverList popover is not empty. Run of toHide : run the hide popover algorithm given the last item in popoverList popover , focusPreviousElement , fireEvents , false, and null.

7. Assert : Let repeatingHide newPopoverList is false or be popoverList document 's last item showing auto popover list if stackType is Auto ; otherwise endpoint . document 's showing hint popover list .

8. Set repeatingHide to true if popoverList contains Reverse endpoint and newPopoverList .

9. For each popoverList popover 's last item is not in endpoint , otherwise false. newPopoverList :

   1. If repeatingHide toRemain is true, then set contains fireEvents to false. popover , then continue.

   2. Run the hide popover algorithm given popover , focusPreviousElement , false, false, and keep performing them while null.

      This happens if popovers are shown whilst hiding popovers. For example, in beforetoggle events. This is usually a developer error, so user agents are encouraged to show a warning. In this additional hiding phase, repeatingHide fireEvents is true. ignored, and false is used instead.

To find the topmost popover ancestor , given a Node newPopoverOrTopLayerElement , a list popoverList , an HTML element or null source , and a boolean isPopover , perform the following steps. They return an HTML element or null.

1. If isPopover is true:

   1. Assert : newPopoverOrTopLayerElement is an HTML element .

   2. Assert : newPopoverOrTopLayerElement 's popover attribute is not in the No Popover State or the Manual state.

   3. Assert : newPopoverOrTopLayerElement 's popover visibility state is not in the popover showing state .

2. Otherwise:

   1. Assert : source is null.

3. Let popoverPositions document be an empty ordered map newPopoverOrTopLayerElement 's node document .

4. Let index combinedPopovers be 0. For each popover document of popoverList : Set 's showing auto popover list extended with popoverPositions document [ 's showing hint popover ] to index . Increment index by 1. list .

5. If Let isPopover popoverAncestorIndex is true, then set be the index of the last item in popoverPositions combinedPopovers [ of which newPopoverOrTopLayerElement ] to index . Increment index by 1. is a flat tree descendant , otherwise infinity.

6. Let topmostPopoverAncestor be null. Let checkAncestor sourceAncestorIndex be an algorithm which performs the following steps given candidate : infinity.

7. If candidate source is not null, then return. Let okNesting be false. Let candidateAncestor be null. While okNesting is false: Set set candidateAncestor sourceAncestorIndex to the result index of running nearest inclusive open popover given candidate . If candidateAncestor is null or popoverPositions does not contain candidateAncestor , then return. Assert : candidateAncestor 's popover attribute is not in the Manual or None state. Set okNesting to true if isPopover is false, newPopoverOrTopLayerElement 's popover last item attribute is in the Hint state, or candidateAncestor combinedPopovers 's popover attribute is in the Auto state. If of which okNesting source is false, then set candidate to candidateAncestor 's parent in the a flat tree . descendant , otherwise infinity.

8. Let candidatePosition ancestorIndex be the minimum of popoverPositions popoverAncestorIndex [ and candidateAncestor ]. sourceAncestorIndex .

9. If topmostPopoverAncestor is null or popoverPositions [ topmostPopoverAncestor ancestorIndex ] is less than candidatePosition , infinity, then set topmostPopoverAncestor to candidateAncestor . return null.

10. Run checkAncestor given Return newPopoverOrTopLayerElement combinedPopovers 's parent node within the flat tree . Run [ checkAncestor ancestorIndex given source . Return topmostPopoverAncestor . ].

To find the nearest inclusive open popover given a Node node , perform the following steps. They return an HTML element or null.

1. Let currentNode be node .

2. While currentNode is not null:

   1. If currentNode 's popover attribute is in the Auto state or the Hint state, and currentNode 's popover visibility state is showing , then return currentNode .

   2. Set currentNode to currentNode 's parent in the flat tree .

3. Return null.

To find the topmost auto or hint popover given a Document document , perform the following steps. They return an HTML element or null.

1. If document 's showing hint popover list is not empty, then return document 's showing hint popover list 's last element.

2. If document 's showing auto popover list is not empty, then return document 's showing auto popover list 's last element.

3. Return null.

To perform the popover focusing steps for an HTML element subject :

1. If the allow focus steps given subject 's node document return false, then return.

2. If subject is a dialog element, then run the dialog focusing steps given subject and return.

3. If subject has the autofocus attribute, then let control be subject .

4. Otherwise, let control be the autofocus delegate for subject given " other ".

5. If control is null, then return.

6. Run the focusing steps given control .

7. Let topDocument be control 's node navigable 's top-level traversable 's active document .

8. If control 's node document 's origin is not the same as the origin of topDocument , then return.

9. Empty topDocument 's autofocus candidates .

10. Set topDocument 's autofocus processed flag to true.

To check popover validity for an HTML element element given a boolean expectedToBeShowing , a boolean throwExceptions , and a Document or null expectedDocument , perform the following steps. They throw an exception or return a boolean.

1. If element 's popover attribute is in the No Popover state, then:

   1. If throwExceptions is true, then throw a " NotSupportedError " DOMException .

   2. Return false.

2. If any of the following are true:

   • expectedToBeShowing is true and element 's popover visibility state is not showing ; or

   • expectedToBeShowing is false and element 's popover visibility state is not hidden ,

   then return false.

3. If any of the following are true:

   • element is not connected ;

   • element 's node document is not fully active ;

   • expectedDocument is not null and element 's node document is not expectedDocument ;

   • element is a dialog element and its is modal is set to true; or

   • element 's fullscreen flag is set,

   then:

   1. If throwExceptions is true, then throw an " InvalidStateError " DOMException .

   2. Return false.

4. Return true.

To get the showing auto popover list for a Document document :

1. Let popovers be « ».

2. For each Element element in document 's top layer :

   1. If all of the following are true:

      • element is an HTML element ;

      • element 's opened in popover mode is " auto "; and

      • element 's popover visibility state is showing ,

      then append element to popovers .

3. Return popovers .

To get the showing hint popover list for a Document document :

1. Let popovers be « ».

2. For each Element element in document 's top layer :

   1. If all of the following are true:

      • element is an HTML element ;

      • element 's opened in popover mode is " hint "; and

      • element 's popover visibility state is showing ,

      then append element to popovers .

3. Return popovers .

The attribute's missing value default and invalid value default are both the Toggle state.

The popoverTargetAction IDL attribute must reflect the popovertargetaction attribute, limited to only known values .

To run the popover target attribute activation behavior given a Node node and a Node eventTarget :

1. Let popover be node 's popover target element .

2. If popover is null, then return.

3. If eventTarget is a shadow-including inclusive descendant of popover and popover is a shadow-including descendant of node , then return.

4. If node 's popovertargetaction attribute is in the show state and popover 's popover visibility state is showing , then return.

5. If node 's popovertargetaction attribute is in the hide state and popover 's popover visibility state is hidden , then return.

6. If popover 's popover visibility state is showing , then run the hide popover algorithm given popover , true, true, false, and node .

7. Otherwise, if popover 's popover visibility state is hidden and the result of running check popover validity given popover , false, false, and null is true, then run show popover given popover , false, and node .

To get the popover target element given a Node node , perform the following steps. They return an HTML element or null.

1. If node is not a button , then return null.

2. If node is disabled , then return null.

3. If node has a form owner and node is a submit button , then return null.

4. Let popoverElement be the result of running node 's get the popovertarget -associated element .

5. If popoverElement is null, then return null.

6. If popoverElement 's popover attribute is in the No Popover state, then return null.

7. Return popoverElement .

To light dismiss open popovers , given a PointerEvent event :

1. Assert : event 's isTrusted attribute is true.

2. Let target be event 's target .

3. Let document be target 's node document .

4. Let topmostPopover be If the result of running topmost auto or hint popover given document . If topmostPopover is null, then return.

5. If event 's type is " pointerdown ", then: set document 's popover pointerdown target to the result of running topmost clicked popover given target .

6. If event 's type is " pointerup ", then:

   1. Let ancestor be the result of running topmost clicked popover given target .

   2. Let sameTarget be true if ancestor is document 's popover pointerdown target .

   3. Set document 's popover pointerdown target to null.

   4. If ancestor sameTarget is null, false, then set ancestor to document . return

   5. If sameTarget is true, then run Run hide all popovers until given ancestor , document , false, and true.

To find the topmost clicked popover , given a Node node :

1. Let clickedPopover be the result of running nearest inclusive open popover given node .

2. Let targetPopover be the result of running nearest inclusive target popover given node .

3. If the result of getting the popover stack position given clickedPopover is greater than the result of getting the popover stack position given targetPopover , then return clickedPopover .

4. Return targetPopover .

To get the popover stack position , given an HTML element popover :

1. Let hintList be popover 's node document 's showing hint popover list .

2. Let autoList be popover 's node document 's showing auto popover list .

3. If popover is in hintList , then return the index of popover in hintList + the size of autoList + 1.

4. If popover is in autoList , then return the index of popover in autoList + 1.

5. Return 0.

To find the nearest inclusive target popover given a Node node :

1. Let currentNode be node .

2. While currentNode is not null:

   1. Let targetPopover be currentNode 's popover target element .

   2. If targetPopover is not null and targetPopover 's popover attribute is in the Auto state or the Hint state, and targetPopover 's popover visibility state is showing , then return targetPopover .

   3. Set currentNode to currentNode 's ancestor in the flat tree .