Skip to content

Commit 76dc378

Browse files
author
Ryan A. Johnson
committed
docs(versions): Add min version to relevant documentation
* Add pipeline logic to generate JSON files for VueJS consumption in docs * Add filtering feature to Icons component * Update Icon list layout
1 parent 9434e3c commit 76dc378

File tree

72 files changed

+518
-97
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+518
-97
lines changed

‎docs/_data/icons.json5‎

Lines changed: 260 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,262 @@
11
[
2-
'account',
3-
'angle-bottom',
4-
'angle-down',
5-
'angle-end',
6-
'angle-left',
7-
'angle-right',
8-
'angle-start',
9-
'angle-top',
10-
'angle-up',
11-
'bell',
12-
'billing',
13-
'calendar',
14-
'checkmark',
15-
'checkmark-circle',
16-
'cog',
17-
'copy',
18-
'download',
19-
'envelope',
20-
'exclamation-circle',
21-
'exclamation-diamond',
22-
'exclamation-triangle',
23-
'export',
24-
'external-link',
25-
'filter',
26-
'help-circle',
27-
'info-circle',
28-
'input-file',
29-
'input-time',
30-
'input-url',
31-
'kbd-arrow-down',
32-
'kbd-arrow-left',
33-
'kbd-arrow-right',
34-
'kbd-arrow-up',
35-
'kbd-capslock',
36-
'kbd-command',
37-
'kbd-delete',
38-
'kbd-eject',
39-
'kbd-option',
40-
'kbd-return',
41-
'kbd-shift',
42-
'kbd-space',
43-
'kbd-tab',
44-
'lock',
45-
'minus',
46-
'minus-circle',
47-
'monitoring',
48-
'payment',
49-
'pencil',
50-
'phone',
51-
'plus',
52-
'plus-or-minus',
53-
'search',
54-
'server',
55-
'sort',
56-
'sort-down',
57-
'sort-up',
58-
'support',
59-
'tag',
60-
'technical-change',
61-
'technical-incident',
62-
'ticketing',
63-
'times',
64-
'times-circle',
65-
'trash',
66-
'user',
2+
{
3+
name: 'account',
4+
minver: '0.1.10',
5+
},
6+
{
7+
name: 'angle-bottom',
8+
minver: '0.2.1',
9+
},
10+
{
11+
name: 'angle-down',
12+
minver: '0.1.0',
13+
},
14+
{
15+
name: 'angle-end',
16+
minver: '0.2.1',
17+
},
18+
{
19+
name: 'angle-left',
20+
minver: '0.1.0',
21+
},
22+
{
23+
name: 'angle-right',
24+
minver: '0.1.0',
25+
},
26+
{
27+
name: 'angle-start',
28+
minver: '0.2.1',
29+
},
30+
{
31+
name: 'angle-top',
32+
minver: '0.2.1',
33+
},
34+
{
35+
name: 'angle-up',
36+
minver: '0.1.0',
37+
},
38+
{
39+
name: 'bell',
40+
minver: '0.1.10',
41+
},
42+
{
43+
name: 'billing',
44+
minver: '0.1.10',
45+
},
46+
{
47+
name: 'calendar',
48+
minver: '0.1.0',
49+
},
50+
{
51+
name: 'checkmark',
52+
minver: '0.1.0',
53+
},
54+
{
55+
name: 'checkmark-circle',
56+
minver: '0.1.10',
57+
},
58+
{
59+
name: 'cog',
60+
minver: '0.1.0',
61+
},
62+
{
63+
name: 'copy',
64+
minver: '0.1.10',
65+
},
66+
{
67+
name: 'download',
68+
minver: '0.1.4',
69+
},
70+
{
71+
name: 'envelope',
72+
minver: '0.1.0',
73+
},
74+
{
75+
name: 'exclamation-circle',
76+
minver: '0.1.0',
77+
},
78+
{
79+
name: 'exclamation-diamond',
80+
minver: '0.2.1',
81+
},
82+
{
83+
name: 'exclamation-triangle',
84+
minver: '0.1.0',
85+
},
86+
{
87+
name: 'export',
88+
minver: '0.1.4',
89+
},
90+
{
91+
name: 'external-link',
92+
minver: '0.1.10',
93+
},
94+
{
95+
name: 'filter',
96+
minver: '0.1.4',
97+
},
98+
{
99+
name: 'help-circle',
100+
minver: '0.1.10',
101+
},
102+
{
103+
name: 'info-circle',
104+
minver: '0.1.0',
105+
},
106+
{
107+
name: 'input-file',
108+
minver: '0.1.0',
109+
},
110+
{
111+
name: 'input-time',
112+
minver: '0.1.0',
113+
},
114+
{
115+
name: 'input-url',
116+
minver: '0.1.0',
117+
},
118+
{
119+
name: 'kbd-arrow-down',
120+
minver: '0.1.0',
121+
},
122+
{
123+
name: 'kbd-arrow-left',
124+
minver: '0.1.0',
125+
},
126+
{
127+
name: 'kbd-arrow-right',
128+
minver: '0.1.0',
129+
},
130+
{
131+
name: 'kbd-arrow-up',
132+
minver: '0.1.0',
133+
},
134+
{
135+
name: 'kbd-capslock',
136+
minver: '0.1.0',
137+
},
138+
{
139+
name: 'kbd-command',
140+
minver: '0.1.0',
141+
},
142+
{
143+
name: 'kbd-delete',
144+
minver: '0.1.0',
145+
},
146+
{
147+
name: 'kbd-eject',
148+
minver: '0.1.0',
149+
},
150+
{
151+
name: 'kbd-option',
152+
minver: '0.1.0',
153+
},
154+
{
155+
name: 'kbd-return',
156+
minver: '0.1.0',
157+
},
158+
{
159+
name: 'kbd-shift',
160+
minver: '0.1.0',
161+
},
162+
{
163+
name: 'kbd-space',
164+
minver: '0.1.0',
165+
},
166+
{
167+
name: 'kbd-tab',
168+
minver: '0.1.0',
169+
},
170+
{
171+
name: 'lock',
172+
minver: '0.1.0',
173+
},
174+
{
175+
name: 'minus',
176+
minver: '0.2.0',
177+
},
178+
{
179+
name: 'minus-circle',
180+
minver: '0.1.10',
181+
},
182+
{
183+
name: 'monitoring',
184+
minver: '0.1.10',
185+
},
186+
{
187+
name: 'payment',
188+
minver: '0.2.0',
189+
},
190+
{
191+
name: 'pencil',
192+
minver: '0.1.10',
193+
},
194+
{
195+
name: 'phone',
196+
minver: '0.1.0',
197+
},
198+
{
199+
name: 'plus',
200+
minver: '0.2.0',
201+
},
202+
{
203+
name: 'plus-or-minus',
204+
minver: '0.1.0',
205+
},
206+
{
207+
name: 'search',
208+
minver: '0.1.0',
209+
},
210+
{
211+
name: 'server',
212+
minver: '0.1.10',
213+
},
214+
{
215+
name: 'sort',
216+
minver: '0.1.4',
217+
},
218+
{
219+
name: 'sort-down',
220+
minver: '0.1.4',
221+
},
222+
{
223+
name: 'sort-up',
224+
minver: '0.1.4',
225+
},
226+
{
227+
name: 'support',
228+
minver: '0.1.0',
229+
},
230+
{
231+
name: 'tag',
232+
minver: '0.1.10',
233+
},
234+
{
235+
name: 'technical-change',
236+
minver: '0.2.0',
237+
},
238+
{
239+
name: 'technical-incident',
240+
minver: '0.2.0',
241+
},
242+
{
243+
name: 'ticketing',
244+
minver: '0.1.10',
245+
},
246+
{
247+
name: 'times',
248+
minver: '0.1.0',
249+
},
250+
{
251+
name: 'times-circle',
252+
minver: '0.1.0',
253+
},
254+
{
255+
name: 'trash',
256+
minver: '0.1.10',
257+
},
258+
{
259+
name: 'user',
260+
minver: '0.1.10',
261+
},
67262
]

‎docs/_templates/component.njk‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
{% block layout %}
44
<main id="content" class="hxBox-md">
5-
<h1>{{ page.title }}</h1>
5+
<h1>{{ page.title }}
6+
{% include 'partials/min-version.njk' %}
7+
</h1>
68

79
{% block content %}
810
{# freeform page content goes here #}

‎docs/_templates/element.njk‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
{% block layout %}
44
<main id="content" class="hxBox-md">
5-
<h1>{{ page.title }}</h1>
5+
<h1>{{ page.title }}
6+
{% include 'partials/min-version.njk' %}
7+
</h1>
68

79
{% block content %}
810
{# freeform page content goes here #}

‎docs/_templates/partials/min-version.njk‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<min-version data-tooltip="page-min-version">
2+
{% if page.minver %}
3+
v{{page.minver}}+
4+
{% else %}
5+
NEW
6+
{% endif %}
7+
</min-version>
8+
9+
<hx-tooltip id="page-min-version" position="right">
10+
{% if page.minver %}
11+
HelixUI v{{page.minver}} or later required
12+
{% else %}
13+
Requires the latest version of HelixUI
14+
{% endif %}
15+
</hx-tooltip>

‎docs/components/accordions/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Accordions
3+
minver: 0.4.0
34
also:
45
elements/hx-accordion: <hx-accordion>
56
elements/hx-accordion-panel: <hx-accordion-panel>

‎docs/components/alerts/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Alerts
3+
minver: 0.1.1
34
---
45
{% extends 'component.njk' %}
56
{% block content %}

‎docs/components/box/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Box
3+
minver: 0.2.0
34
also:
45
components/grid: Grid
56
components/layouts: Layouts

‎docs/components/breadcrumbs/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Breadcrumbs
3+
minver: 0.1.0
34
---
45
{% extends 'component.njk' %}
56
{% block content %}

0 commit comments

Comments
 (0)