Skip to content

Commit c9d308c

Browse files
author
Cathy Siller
committed
refactor(element-docs): make elements documentations in sync
1 parent 0de9dca commit c9d308c

File tree

13 files changed

+44
-81
lines changed

13 files changed

+44
-81
lines changed

docs/elements/hx-accordion-panel/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
{% endblock %}
4141
{% block properties %}
4242
<dl>
43-
<dt>open <small>(Boolean)</small></dt>
43+
<dt>open (Boolean)</dt>
4444
<dd>Determines if panel is open.</dd>
4545
</dl>
4646
{% endblock %}

docs/elements/hx-accordion/index.html

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -51,37 +51,30 @@ <h2 id="modes">Modes</h2>
5151
<section>
5252
<h2 id="methods">Methods</h2>
5353
<dl>
54-
<dt><code>nextPanel()</code></dt>
54+
<dt>nextPanel()</dt>
5555
<dd>
5656
Opens the next sibling panel.
5757
<br />
58-
<small>
59-
<hx-icon type="exclamation-triangle"></hx-icon>
60-
Requires the <code>current-panel</code> attribute to be present.</em>
61-
</small>
58+
<hx-icon type="exclamation-triangle"></hx-icon>
59+
Requires the <code>current-panel</code> attribute to be present.
6260
</dd>
6361

64-
<dt><code>previousPanel()</code></dt>
62+
<dt>previousPanel()</dt>
6563
<dd>
6664
Opens the previous sibling panel.
6765
<br />
68-
<small>
69-
<hx-icon type="exclamation-triangle"></hx-icon>
70-
Requires the <code>current-panel</code> attribute to be present.</em>
71-
</small>
66+
<hx-icon type="exclamation-triangle"></hx-icon>
67+
Requires the <code>current-panel</code> attribute to be present.
7268
</dd>
7369
</dl>
7470
</section>
7571
{% endblock %}
7672

7773
{% block attributes %}
7874
<dl>
79-
<dt>
80-
<code>current-panel</code>
81-
<small>{Number} <i>(optional)</i></small>
82-
</dt>
75+
<dt>current-panel {Number} <i>(optional)</i></dt>
8376
<dd>
84-
<small><i>(optional)</i></small>
77+
<i>(optional)</i>
8578
Zero-based index of the panel you wish to open. For example, a value
8679
of "0" will open the first panel, "1" will open the second, etc.).
8780
If omitted, any number of panels can be opened at once.
@@ -91,20 +84,14 @@ <h2 id="methods">Methods</h2>
9184

9285
{% block properties %}
9386
<dl>
94-
<dt>
95-
<code>currentPanel</code>
96-
<small>{Number}</small>
97-
</dt>
87+
<dt>currentPanel {Number}</dt>
9888
<dd>
9989
Manipulates the <code>current-panel</code> attribute
10090
</dd>
10191

102-
<dt>
103-
<code>panels</code>
104-
<small>{Array&lt;Element&gt;}</small>
105-
</dt>
92+
<dt>panels {Array&lt;Element&gt;}</dt>
10693
<dd>
107-
<small><i>(read-only)</i></small>
94+
<i>(read-only)</i>
10895
Returns an array of live <code>&lt;hx-accordion-panel&gt;</code> elements.
10996
</dd>
11097
</dl>

docs/elements/hx-alert/index.html

Lines changed: 10 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
Any of the following:
2727
<ul>
2828
<li>
29-
<code>dismiss</code> <small>(cancelable)</small> - User clicks "X" to dismiss the alert.
29+
<code>dismiss</code> (cancelable) - User clicks "X" to dismiss the alert.
3030
</li>
3131
<li><code>submit</code> - User clicks CTA</li>
3232
</ul>
@@ -38,44 +38,32 @@
3838
<section>
3939
<h2 id="methods">Methods</h2>
4040
<dl>
41-
<dt><code>dismiss()</code></dt>
41+
<dt>dismiss()</dt>
4242
<dd>Dismisses the alert.</dd>
4343
</dl>
4444
</section>
4545
{% endblock %}
4646

4747
{% block attributes %}
4848
<dl>
49-
<dt>
50-
<code>cta</code>
51-
<small>{String} <i>(optional)</i></small>
52-
</dt>
49+
<dt>cta {String} <i>(optional)</i></dt>
5350
<dd>
5451
Set the text of the CTA button.
5552
If absent or blank, the CTA button will not be displayed.
5653
</dd>
5754

58-
<dt>
59-
<code>static</code>
60-
<small>{Boolean} <i>(optional)</i></small>
61-
</dt>
55+
<dt>static {Boolean} <i>(optional)</i></dt>
6256
<dd>
6357
When present, alert will not be dismissable.
6458
</dd>
6559

66-
<dt>
67-
<code>status</code>
68-
<small>{String} <i>(optional)</i></small>
69-
</dt>
60+
<dt>status {String} <i>(optional)</i></dt>
7061
<dd>
7162
Sets the status text at the beginning of the alert description.
7263
If absent or blank, the status element will not be displayed.
7364
</dd>
7465

75-
<dt>
76-
<code>type</code>
77-
<small>{Enum&lt;String&gt;} <i>(optional)</i></small>
78-
</dt>
66+
<dt>type {Enum&lt;String&gt;} <i>(optional)</i></dt>
7967
<dd>
8068
Identifies the type of alert. Valid values are as follows:
8169
<ul>
@@ -90,34 +78,22 @@ <h2 id="methods">Methods</h2>
9078

9179
{% block properties %}
9280
<dl>
93-
<dt>
94-
<code>cta</code>
95-
<small>{String}</small>
96-
</dt>
81+
<dt>cta {String}</dt>
9782
<dd>
9883
Manipulates the <code>cta</code> attribute.
9984
</dd>
10085

101-
<dt>
102-
<code>static</code>
103-
<small>{Boolean}</small>
104-
</dt>
86+
<dt>static {Boolean}</dt>
10587
<dd>
10688
When <code>true</code>, alert will not be dismissable.
10789
</dd>
10890

109-
<dt>
110-
<code>status</code>
111-
<small>{String}</small>
112-
</dt>
91+
<dt>status {String}</dt>
11392
<dd>
11493
Manipulates the <code>status</code> attribute.
11594
</dd>
11695

117-
<dt>
118-
<code>type</code>
119-
<small>{String}</small>
120-
</dt>
96+
<dt>type {String}</dt>
12197
<dd>
12298
Manipulates the <code>type</code> attribute.
12399
</dd>

docs/elements/hx-busy/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
{% block properties %}
3636
<dl>
37-
<dt>paused <small>(Boolean [false])</small></dt>
37+
<dt>paused (Boolean [false])</dt>
3838
<dd>Pauses animation, when set to true</dd>
3939
</dl>
4040
{% endblock %}

docs/elements/hx-checkbox/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@
4444

4545
{% block properties %}
4646
<dl>
47-
<dt>checked <small>(Boolean [false])</small></dt>
47+
<dt>checked (Boolean [false])</dt>
4848
<dd>Determines if checkbox is checked.</dd>
4949

50-
<dt>disabled <small>(Boolean [false])</small></dt>
50+
<dt>disabled (Boolean [false])</dt>
5151
<dd>Determines if checkbox is disabled.</dd>
5252

53-
<dt>indeterminate <small>(Boolean [false])</small></dt>
53+
<dt>indeterminate (Boolean [false])</dt>
5454
<dd>Determines if checkbox is indeterminate.</dd>
5555
</dl>
5656
{% endblock %}

docs/elements/hx-disclosure/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ <h2 id="target-element">Target Element</h2>
6363

6464
{% block properties %}
6565
<dl>
66-
<dt>expanded <small>(Boolean)</small></dt>
66+
<dt>expanded (Boolean)</dt>
6767
<dd>
6868
Mirrors the <code>aria-expanded</code> attribute.
6969
<ul>

docs/elements/hx-menu/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
<dt>position</dt>
5252
<dd>Positions the menu</dd>
5353

54-
<dt>relative-to <small>(optional)</small></dt>
54+
<dt>relative-to (optional)</dt>
5555
<dd>
5656
ID of an element that the menu is positioned relative to. If not
5757
set, the menu will be positioned relative to the element with the

docs/elements/hx-modal/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454

5555
{% block properties %}
5656
<dl>
57-
<dt>open <small>(Boolean [false])</small></dt>
57+
<dt>open (Boolean [false])</dt>
5858
<dd>Determines if modal is open.</dd>
5959
</dl>
6060
{% endblock %}

docs/elements/hx-popover/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@
5454

5555
{% block properties %}
5656
<dl>
57-
<dt>open <small>(Boolean [false])</small></dt>
57+
<dt>open (Boolean [false])</dt>
5858
<dd>Determines if the popover is open.</dd>
5959

60-
<dt>position <small>(String [bottom-right])</small></dt>
60+
<dt>position (String [bottom-right])</dt>
6161
<dd>Determines the position of the popover.</dd>
6262
</dl>
6363
{% endblock %}

docs/elements/hx-reveal/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646

4747
{% block properties %}
4848
<dl>
49-
<dt>open <small>(Boolean)</small></dt>
49+
<dt>open (Boolean)</dt>
5050
<dd>Determines if reveal is open.</dd>
5151
</dl>
5252
{% endblock %}

0 commit comments

Comments
 (0)