Skip to content

Commit 2185b63

Browse files
committed
Editorial: define defaults for EventListenerOptions
Although this is also done in prose, this nonetheless simplifies the prose a bit and makes it clearer to those skimming the standard what is going on (although skimming is not recommended). Fixes #239.
1 parent a77a920 commit 2185b63

File tree

2 files changed

+16
-22
lines changed

2 files changed

+16
-22
lines changed

dom.bs

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -951,12 +951,12 @@ callback interface EventListener {
951951
};
952952

953953
dictionary EventListenerOptions {
954-
boolean capture;
954+
boolean capture = false;
955955
};
956956

957957
dictionary AddEventListenerOptions : EventListenerOptions {
958-
boolean passive;
959-
boolean once;
958+
boolean passive = false;
959+
boolean once = false;
960960
};
961961
</pre>
962962

@@ -1039,8 +1039,8 @@ steps:
10391039

10401040
<li><p>If <var>options</var> is a boolean, set <var>capture</var> to <var>options</var>.
10411041

1042-
<li><p>If <var>options</var> is a dictionary and <code>{{EventListenerOptions/capture}}</code> is
1043-
present in <var>options</var> with value true, then set <var>capture</var> to true.
1042+
<li><p>If <var>options</var> is a dictionary, then set <var>capture</var> to <var>options</var>'s
1043+
<code>{{EventListenerOptions/capture}}</code>.
10441044

10451045
<li><p>Return <var>capture</var>.
10461046
</ol>
@@ -1053,11 +1053,9 @@ steps:
10531053

10541054
<li><p>Let <var>once</var> and <var>passive</var> be false.
10551055

1056-
<li><p>If <var>options</var> is a dictionary and <code>{{AddEventListenerOptions/passive}}</code>
1057-
is present in <var>options</var> with value true, then set <var>passive</var> to true.
1058-
1059-
<li><p>If <var>options</var> is a dictionary and <code>{{AddEventListenerOptions/once}}</code> is
1060-
present in <var>options</var> with value true, then set <var>once</var> to true.
1056+
<li><p>If <var>options</var> is a dictionary, then set <var>passive</var> to <var>options</var>'s
1057+
<code>{{AddEventListenerOptions/passive}}</code> and <var>once</var> to <var>options</var>'s
1058+
<code>{{AddEventListenerOptions/once}}</code>.
10611059

10621060
<li><p>Return <var>capture</var>, <var>passive</var>, and <var>once</var>.
10631061
</ol>

dom.html

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -705,12 +705,12 @@ <h3 class="heading settled" data-level="3.6" id="interface-eventtarget"><span cl
705705
};
706706

707707
dictionary <dfn class="idl-code" data-dfn-type="dictionary" data-export="" id="dictdef-eventlisteneroptions">EventListenerOptions<a class="self-link" href="#dictdef-eventlisteneroptions"></a></dfn> {
708-
boolean <dfn class="idl-code" data-dfn-for="EventListenerOptions" data-dfn-type="dict-member" data-export="" data-type="boolean " id="dom-eventlisteneroptions-capture">capture<a class="self-link" href="#dom-eventlisteneroptions-capture"></a></dfn>;
708+
boolean <dfn class="idl-code" data-default="false" data-dfn-for="EventListenerOptions" data-dfn-type="dict-member" data-export="" data-type="boolean " id="dom-eventlisteneroptions-capture">capture<a class="self-link" href="#dom-eventlisteneroptions-capture"></a></dfn> = false;
709709
};
710710

711711
dictionary <dfn class="idl-code" data-dfn-type="dictionary" data-export="" id="dictdef-addeventlisteneroptions">AddEventListenerOptions<a class="self-link" href="#dictdef-addeventlisteneroptions"></a></dfn> : <a data-link-type="idl-name" href="#dictdef-eventlisteneroptions">EventListenerOptions</a> {
712-
boolean <dfn class="idl-code" data-dfn-for="AddEventListenerOptions" data-dfn-type="dict-member" data-export="" data-type="boolean " id="dom-addeventlisteneroptions-passive">passive<a class="self-link" href="#dom-addeventlisteneroptions-passive"></a></dfn>;
713-
boolean <dfn class="idl-code" data-dfn-for="AddEventListenerOptions" data-dfn-type="dict-member" data-export="" data-type="boolean " id="dom-addeventlisteneroptions-once">once<a class="self-link" href="#dom-addeventlisteneroptions-once"></a></dfn>;
712+
boolean <dfn class="idl-code" data-default="false" data-dfn-for="AddEventListenerOptions" data-dfn-type="dict-member" data-export="" data-type="boolean " id="dom-addeventlisteneroptions-passive">passive<a class="self-link" href="#dom-addeventlisteneroptions-passive"></a></dfn> = false;
713+
boolean <dfn class="idl-code" data-default="false" data-dfn-for="AddEventListenerOptions" data-dfn-type="dict-member" data-export="" data-type="boolean " id="dom-addeventlisteneroptions-once">once<a class="self-link" href="#dom-addeventlisteneroptions-once"></a></dfn> = false;
714714
};
715715
</pre>
716716
<p>The <code class="idl"><a data-link-type="idl" href="#eventtarget">EventTarget</a></code> object represents the target to which an <a data-link-type="dfn" href="#concept-event">event</a> is <a data-link-type="dfn" href="#concept-event-dispatch">dispatched</a> when something has occurred. </p>
@@ -760,8 +760,7 @@ <h3 class="heading settled" data-level="3.6" id="interface-eventtarget"><span cl
760760
<li>
761761
<p>If <var>options</var> is a boolean, set <var>capture</var> to <var>options</var>. </p>
762762
<li>
763-
<p>If <var>options</var> is a dictionary and <code><code class="idl"><a data-link-type="idl" href="#dom-eventlisteneroptions-capture">capture</a></code></code> is
764-
present in <var>options</var> with value true, then set <var>capture</var> to true. </p>
763+
<p>If <var>options</var> is a dictionary, then set <var>capture</var> to <var>options</var>’s <code><code class="idl"><a data-link-type="idl" href="#dom-eventlisteneroptions-capture">capture</a></code></code>. </p>
765764
<li>
766765
<p>Return <var>capture</var>. </p>
767766
</ol>
@@ -773,10 +772,7 @@ <h3 class="heading settled" data-level="3.6" id="interface-eventtarget"><span cl
773772
<li>
774773
<p>Let <var>once</var> and <var>passive</var> be false. </p>
775774
<li>
776-
<p>If <var>options</var> is a dictionary and <code><code class="idl"><a data-link-type="idl" href="#dom-addeventlisteneroptions-passive">passive</a></code></code> is present in <var>options</var> with value true, then set <var>passive</var> to true. </p>
777-
<li>
778-
<p>If <var>options</var> is a dictionary and <code><code class="idl"><a data-link-type="idl" href="#dom-addeventlisteneroptions-once">once</a></code></code> is
779-
present in <var>options</var> with value true, then set <var>once</var> to true. </p>
775+
<p>If <var>options</var> is a dictionary, then set <var>passive</var> to <var>options</var>’s <code><code class="idl"><a data-link-type="idl" href="#dom-addeventlisteneroptions-passive">passive</a></code></code> and <var>once</var> to <var>options</var>’s <code><code class="idl"><a data-link-type="idl" href="#dom-addeventlisteneroptions-once">once</a></code></code>. </p>
780776
<li>
781777
<p>Return <var>capture</var>, <var>passive</var>, and <var>once</var>. </p>
782778
</ol>
@@ -6406,12 +6402,12 @@ <h2 class="no-num no-ref heading settled" id="idl-index"><span class="content">I
64066402
};
64076403

64086404
dictionary <a href="#dictdef-eventlisteneroptions">EventListenerOptions</a> {
6409-
boolean <a data-type="boolean " href="#dom-eventlisteneroptions-capture">capture</a>;
6405+
boolean <a data-default="false" data-type="boolean " href="#dom-eventlisteneroptions-capture">capture</a> = false;
64106406
};
64116407

64126408
dictionary <a href="#dictdef-addeventlisteneroptions">AddEventListenerOptions</a> : <a data-link-type="idl-name" href="#dictdef-eventlisteneroptions">EventListenerOptions</a> {
6413-
boolean <a data-type="boolean " href="#dom-addeventlisteneroptions-passive">passive</a>;
6414-
boolean <a data-type="boolean " href="#dom-addeventlisteneroptions-once">once</a>;
6409+
boolean <a data-default="false" data-type="boolean " href="#dom-addeventlisteneroptions-passive">passive</a> = false;
6410+
boolean <a data-default="false" data-type="boolean " href="#dom-addeventlisteneroptions-once">once</a> = false;
64156411
};
64166412

64176413
[NoInterfaceObject,

0 commit comments

Comments
 (0)