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.

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

Add new mutation observer init options elementByAttributeFilter and elementFilter #885

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add new mutation observer init options elementByAttributeFilter and elementFilter #885

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d1c9cb6
Add mutation observer init options elementHasAttributeNameFilter and…
Mar 26, 2020
8dff3a0
minor fixes
Sep 21, 2020
e0b4bcb
fix formatting
annevk Sep 24, 2020
cb4b0d9
minor fixes
Sep 25, 2020
f9d51aa
add links
Feb 6, 2021
63b316d
Merge branch 'main' into new-mutation-observer-init-options
AndrewRot Sep 14, 2021
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
92 changes: 92 additions & 0 deletions dom.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3320,6 +3320,8 @@ dictionary MutationObserverInit {
boolean attributeOldValue;
boolean characterDataOldValue;
sequence<DOMString> attributeFilter;
sequence<DOMString> elementByAttributeFilter;
sequence<DOMString> elementFilter;
};
</pre>

Expand Down Expand Up @@ -3398,6 +3400,19 @@ dictionary MutationObserverInit {
<a>attribute</a> mutations need to be
observed and {{MutationObserverInit/attributes}} is true
or omitted.

<dt>{{MutationObserverInit/elementByAttributeFilter}}
<dd>Set to a list of <a>attribute</a>
<a for=Attr>local names</a> (without <a for=Attr>namespace</a>) to observe changes
to the presence of an elements <a>attributes</a>.

<dt>{{MutationObserverInit/elementFilter}}
<dd>Set to a list of <a for=/>element</a>
<a for=Element>local names</a> (without <a for=Attr>namespace</a>) to observe
changes to the presence of specific <a for=/>element</a> <a for=Element>local names</a>
if not all <a for=/>element</a> <a for=Element>local names</a> need to be
observed and {{MutationObserverInit/attributes}} is true
or omitted.
</dl>

<dt><code><var>observer</var> . {{disconnect()}}</code>
Expand Down Expand Up @@ -3437,6 +3452,14 @@ method, when invoked, must run these steps:
<var>options</var>'s {{MutationObserverInit/characterData}} is omitted, then set
<var>options</var>'s {{MutationObserverInit/characterData}} to true.

<li><p>If <var>options</var>'s {{MutationObserverInit/elementByAttributeFilter}} is present and
<var>options</var>'s {{MutationObserverInit/childList}} is omitted, then set
<var>options</var>'s {{MutationObserverInit/childList}} to true.

<li><p>If <var>options</var>'s {{MutationObserverInit/elementFilter}} is present and
<var>options</var>'s {{MutationObserverInit/childList}} is omitted, then set
<var>options</var>'s {{MutationObserverInit/childList}} to true.

<li><p>If none of <var>options</var>'s {{MutationObserverInit/childList}},
{{MutationObserverInit/attributes}}, and {{MutationObserverInit/characterData}} is true, then
<a>throw</a> a <code>TypeError</code>.
Expand All @@ -3453,6 +3476,14 @@ method, when invoked, must run these steps:
<var>options</var>'s {{MutationObserverInit/characterData}} is false, then <a>throw</a> a
<code>TypeError</code>.

<li><p>If <var>options</var>'s {{MutationObserverInit/elementByAttributeFilter}} is present and
<var>options</var>'s {{MutationObserverInit/childList}} is false, then <a>throw</a> a
<code>TypeError</code>.

<li><p>If <var>options</var>'s {{MutationObserverInit/elementFilter}} is present and
<var>options</var>'s {{MutationObserverInit/childList}} is false, then <a>throw</a> a
<code>TypeError</code>.

<li>
<p><a for=list>For each</a> <var>registered</var> of <var>target</var>'s
<a>registered observer list</a>, if <var>registered</var>'s
Expand Down Expand Up @@ -3594,6 +3625,67 @@ run these steps:
<ol>
<li><p>Assert: either <var>addedNodes</var> or <var>removedNodes</var> <a for=set>is not empty</a>.

<li>
<p>If either <var>options</var>'s' {{MutationObserverInit/elementFilter}} or
{{MutationObserverInit/elementByAttributeFilter}} is present, then:

<ol>
<li><p>Let <var>filteredAddedNodes</var> be an empty <a for=/>list</a>.

<li><p>Let <var>filterRemovedNodes</var> be an empty <a for=/>list</a>.

<li>
<p>For each <var>node</var> in <var>addedNodes</var></a>:

<ol>
<li><p>Let <var>nodeAttributesList</var> be the set of local names of <var>node</var>'s
attributes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"local names" and "attributes" should xref the relevant definitions. (We should also have a test with two attributes that have the same local name and see if this is all working as designed.)


<li>
<p>If none of the following are true

<ul class=brief>
<li>if <var>options</var>'s {{MutationObserverInit/elementFilter}} is present, and the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the nested "if" works here. This needs rephrasing.

<a>node</a>'s <var>localName</var> is in {{MutationObserverInit/elementFilter}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is quite confusing. Isn't node the variable and local name the field?


<li><var>options</var>'s {{MutationObserverInit/elementByAttributeFilter}} is present, and
<var>options</var>'s {{MutationObserverInit/elementByAttributeFilter}} contains any of the
attribute name in <var>nodeAttributesList</var>
</ul>

<p>then <a for=queue>enqueue</a> <var>record</var> node in <var>filteredAddedNodes</var>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you might mean <a for=list>append</a> <var>node</var> to <var>filteredAddedNodes</var> here?

</ol>

<li>
<p>For each <var>node</var> in <var>removedNodes</var></a>:

<ol>
<li><p>Let <var>nodeAttributesList</var> be the set of local names of <var>node</var>'s
attributes.

<li>
<p>If none of the following are true

<ul class=brief>
<li>if <var>options</var>'s {{MutationObserverInit/elementFilter}} is present, and the
<a>node</a>'s <var>localName</var> is in {{MutationObserverInit/elementFilter}}

<li>if <var>options</var>'s {{MutationObserverInit/elementByAttributeFilter}} is present, and
<var>options</var>'s {{MutationObserverInit/elementByAttributeFilter}} contains any of the
attribute names in <var>nodeAttributesList</var>
</ul>

<p>then <a for=queue>enqueue</a> <var>record</var> node in <var>filterRemovedNodes</var>.
</ol>

<li><p>Assert: either <var>filteredAddedNodes</var> or <var>filteredRemovedNodes</var>
<a for=set>is not empty</a>.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How can we assert this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both of these are now defined in scope. Check if filteredAddedNodes length > 0 or filteredRemovedNodes length > 0.


<li><p>Set <var>addedNodes</var> to <var>filteredAddedNodes</var>

<li><p>Set <var>removedNodes</var> to <var>filteredRemovedNodes</var>
</ol>

<li><p><a>Queue a mutation record</a> of "<code>childList</code>" for <var>target</var> with
null, null, null, <var>addedNodes</var>, <var>removedNodes</var>, <var>previousSibling</var>,
and <var>nextSibling</var>.
Expand Down