Skip to content

Commit c28fac5

Browse files
author
Cathy Siller
committed
docs(hx-error): add documentation for custom element
1 parent d11b690 commit c28fac5

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed

docs/_data/nav.json5

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@
7777
{ label: '<hx-disclosure>', path: 'hx-disclosure' },
7878
{ label: '<hx-dl>', path: 'hx-dl' },
7979
{ label: '<hx-dt>', path: 'hx-dt' },
80+
{ label: '<hx-error>', path: 'hx-error' },
8081
{ label: '<hx-file-icon>', path: 'hx-file-icon' },
8182
//{ label: '<hx-file-tile>', path: 'hx-file-tile' },
8283
{ label: '<hx-icon>', path: 'hx-icon' },

docs/components/typography/index.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Typography
33
minver: 0.1.6
4+
also:
5+
elements/hx-error: <hx-error>
46
---
57
{% extends 'component.njk' %}
68
{% block content %}

docs/elements/hx-error/index.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: <hx-error>
3+
minver: 0.4.0
4+
also:
5+
components/Typography: Typography
6+
---
7+
{% extends 'element.njk' %}
8+
{% block content %}
9+
<section>
10+
<p>
11+
The custom <code>{{page.title}}</code> element provides an informative
12+
icon and applies styling to communicate an error message to users.
13+
</p>
14+
15+
<hx-dl class="hxBox-md metadata">
16+
<hx-def>
17+
<hx-dt>Permitted Parents</hx-dt>
18+
<hx-dd>Any that accept Phrasing Content</hx-dd>
19+
</hx-def>
20+
<hx-def>
21+
<hx-dt>Permitted Children</hx-dt>
22+
<hx-dd>Phrasing Content</hx-dd>
23+
</hx-def>
24+
<hx-def>
25+
<hx-dt>Events</hx-dt>
26+
<hx-dd><em>none</em></hx-dd>
27+
</hx-def>
28+
</hx-dl>
29+
</section>
30+
{% endblock %}
31+

0 commit comments

Comments
 (0)