Skip to content

Commit dfedc23

Browse files
author
Cathy Siller
committed
docs(component): refactor plural to singular in codebase
1 parent 748dd17 commit dfedc23

File tree

113 files changed

+312
-402
lines changed

Some content is hidden

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

113 files changed

+312
-402
lines changed

docs/_data/nav.json5

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,47 +14,47 @@
1414
label: 'Components',
1515
path: 'components',
1616
children: [
17-
{ label: 'Accordions', path: 'accordions' },
18-
{ label: 'Alerts', path: 'alerts' },
19-
{ label: 'Badges', path: 'badges' },
17+
{ label: 'Accordion', path: 'accordion' },
18+
{ label: 'Alert', path: 'alert' },
19+
{ label: 'Badge', path: 'badge' },
2020
{ label: 'Box', path: 'box' },
21-
{ label: 'Breadcrumbs', path: 'breadcrumbs' },
22-
{ label: 'Buttons', path: 'buttons' },
23-
{ label: 'Checkboxes', path: 'checkboxes' },
24-
{ label: 'Choice Tiles', path: 'choice-tiles' },
21+
{ label: 'Breadcrumb', path: 'breadcrumb' },
22+
{ label: 'Button', path: 'button' },
23+
{ label: 'Checkbox', path: 'checkbox' },
24+
{ label: 'Choice Tile', path: 'choice-tile' },
2525
{ label: 'Dropdown Select', path: 'dropdown-select' },
26-
{ label: 'Files', path: 'files' },
26+
{ label: 'File', path: 'file' },
2727
{ label: 'Grid', path: 'grid' },
28-
{ label: 'Icons', path: 'icons' },
28+
{ label: 'Icon', path: 'icon' },
2929
{
30-
label: 'Layouts',
31-
path: 'layouts',
30+
label: 'Layout',
31+
path: 'layout',
3232
/* TODO: on hold until nav is updated to allow for link title + section toggle
3333
children: [
3434
{ label: 'Horizontal', path: 'horizontal-layout-template.html' },
3535
{ label: 'Vertical', path: 'vertical-layout-template.html' },
3636
],
3737
*/
3838
},
39-
{ label: 'Lists', path: 'lists' },
40-
{ label: 'Loaders', path: 'loaders' },
41-
{ label: 'Menus', path: 'menus' },
42-
{ label: 'Modals', path: 'modals' },
39+
{ label: 'List', path: 'list' },
40+
{ label: 'Loader', path: 'loader' },
41+
{ label: 'Menu', path: 'menu' },
42+
{ label: 'Modal', path: 'modal' },
4343
{ label: 'Navigation', path: 'navigation' },
4444
{ label: 'Pagination', path: 'pagination' },
45-
{ label: 'Panels', path: 'panels' },
46-
{ label: 'Pills', path: 'pills' },
47-
{ label: 'Popovers', path: 'popovers' },
48-
{ label: 'Radios', path: 'radios' },
49-
{ label: 'Reveals', path: 'reveals' },
45+
{ label: 'Panel', path: 'panel' },
46+
{ label: 'Pill', path: 'pill' },
47+
{ label: 'Popover', path: 'popover' },
48+
{ label: 'Radio', path: 'radio' },
49+
{ label: 'Reveal', path: 'reveal' },
5050
{ label: 'Search', path: 'search' },
51-
{ label: 'Selector Strips', path: 'selector-strips' },
52-
{ label: 'Tables', path: 'tables' },
53-
{ label: 'Tabs', path: 'tabs' },
51+
{ label: 'Selector Strip', path: 'selector-strip' },
52+
{ label: 'Table', path: 'table' },
53+
{ label: 'Tabset', path: 'tabset' },
5454
{ label: 'Text Input', path: 'text-input' },
5555
{ label: 'Textarea', path: 'textarea' },
56-
{ label: 'Toasts', path: 'toasts' },
57-
{ label: 'Tooltips', path: 'tooltips' },
56+
{ label: 'Toast', path: 'toast' },
57+
{ label: 'Tooltip', path: 'tooltip' },
5858
{ label: 'Typography', path: 'typography' },
5959
],
6060
},
@@ -63,12 +63,12 @@
6363
label: 'Custom Elements',
6464
path: 'elements',
6565
children: [
66-
{ label: '<hx-accordion-panel>', path: 'hx-accordion-panel' },
6766
{ label: '<hx-accordion>', path: 'hx-accordion' },
67+
{ label: '<hx-accordion-panel>', path: 'hx-accordion-panel' },
6868
{ label: '<hx-alert>', path: 'hx-alert' },
6969
{ label: '<hx-busy>', path: 'hx-busy' },
70-
{ label: '<hx-checkbox-control>', path: 'hx-checkbox-control' },
7170
{ label: '<hx-checkbox>', path: 'hx-checkbox' },
71+
{ label: '<hx-checkbox-control>', path: 'hx-checkbox-control' },
7272
{ label: '<hx-disclosure>', path: 'hx-disclosure' },
7373
{ label: '<hx-div>', path: 'hx-div' },
7474
{ label: '<hx-drop-fence>', path: 'hx-drop-fence' },
@@ -84,14 +84,14 @@
8484
{ label: '<hx-pill>', path: 'hx-pill' },
8585
{ label: '<hx-popover>', path: 'hx-popover' },
8686
{ label: '<hx-progress>', path: 'hx-progress' },
87+
{ label: '<hx-radio>', path: 'hx-radio' },
8788
{ label: '<hx-radio-control>', path: 'hx-radio-control' },
8889
{ label: '<hx-radio-set>', path: 'hx-radio-set' },
89-
{ label: '<hx-radio>', path: 'hx-radio' },
9090
{ label: '<hx-reveal>', path: 'hx-reveal' },
91-
{ label: '<hx-search-assistance>', path: 'hx-search-assistance' },
9291
{ label: '<hx-search>', path: 'hx-search' },
93-
{ label: '<hx-select-control>', path: 'hx-select-control' },
92+
{ label: '<hx-search-assistance>', path: 'hx-search-assistance' },
9493
{ label: '<hx-select>', path: 'hx-select' },
94+
{ label: '<hx-select-control>', path: 'hx-select-control' },
9595
{ label: '<hx-status>', path: 'hx-status' },
9696
{ label: '<hx-tab>', path: 'hx-tab' },
9797
{ label: '<hx-tabcontent>', path: 'hx-tabcontent' },

docs/_templates/application.njk

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,15 @@
7373
<main role="main" id="content" class="{{mainClass}} {{contentClasses}}">
7474
{% block main %}
7575
<header>
76-
{# TODO: use frontmatter to define breadcrumbs #}
77-
{% block breadcrumbs %}
78-
{# breadcrumbs go here (optional) #}
79-
{% endblock %}
76+
{% if page.crumbs %}
77+
<nav class="hxBreadcrumb">
78+
{% for crumb in page.crumbs %}
79+
<a href="{{crumb.path}}">{{crumb.label}}</a>
80+
<hx-icon class="delimiter" type="angle-right"></hx-icon>
81+
{% endfor %}
82+
<a href="#">{{page.title}}</a>
83+
</nav>
84+
{% endif %}
8085

8186
<h1>
8287
{{ page.title }}

docs/components/accordions/index.html renamed to docs/components/accordion/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Accordions
2+
title: Accordion
33
minver: 0.4.0
44
also:
5-
components/accordions/test.html: Testing - Accordions
5+
components/accordion/test.html: Testing - Accordion
66
elements/hx-accordion: <hx-accordion>
77
elements/hx-accordion-panel: <hx-accordion-panel>
88
---

docs/components/accordions/test.html renamed to docs/components/accordion/test.html

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
---
2-
title: Testing - Accordions
2+
title: Testing - Accordion
3+
crumbs:
4+
- path: components/accordion
5+
label: Accordion
36
---
4-
{% set contentClasses = 'accordions-test' %}
57
{% extends 'test.njk' %}
6-
{% block content %}
7-
<section>
8-
<nav class="hxBreadcrumb">
9-
<a href="components/accordions">Accordions</a>
10-
<hx-icon class="delimiter" type="angle-right"></hx-icon>
11-
<a href="#">{{page.title}}</a>
12-
</nav>
13-
</section>
8+
{% set contentClasses = 'accordions-test' %}
149

10+
{% block content %}
1511
<section>
1612
<h2>Open Enabled</h2>
1713
<hx-accordion>
File renamed without changes.

docs/components/alerts/index.html renamed to docs/components/alert/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Alerts
2+
title: Alert
33
minver: 0.1.1
44
also:
5-
components/alerts/test.html: Testing - Alerts
5+
components/alert/test.html: Testing - Alert
66
elements/hx-alert: <hx-alert>
77
---
88
{% extends 'component.njk' %}

docs/components/alerts/test.html renamed to docs/components/alert/test.html

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
---
2-
title: Testing - Alerts
2+
title: Testing - Alert
3+
crumbs:
4+
- path: components/alert
5+
label: Alert
36
---
47
{% extends 'test.njk' %}
5-
{% block content %}
6-
<section>
7-
<nav class="hxBreadcrumb">
8-
<a href="components/alerts">Alerts</a>
9-
<hx-icon class="delimiter" type="angle-right"></hx-icon>
10-
<a href="#">{{page.title}}</a>
11-
</nav>
12-
</section>
138

9+
{% block content %}
1410
<section>
1511
<header>
1612
<h3>Light DOM White Space</h3>
1713
</header>
14+
1815
<div class="hxRow">
1916
<div class="hxCol hxSpan-6-md">
2017
<hx-alert status="STATUS"> Message with leading white space (no trailing)</hx-alert>

docs/components/badges/index.html renamed to docs/components/badge/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Badges
2+
title: Badge
33
minver: 0.10.0
44
also:
55
guides/react-compatibility/#significant-white-space: Significant White Space (React Compatibility)
6-
components/badges/test.html: Testing - Badges
6+
components/badge/test.html: Testing - Badge
77
---
88
{% extends 'component.njk' %}
99
{% set contentClasses = 'docs-badge' %}

docs/components/badges/test.html renamed to docs/components/badge/test.html

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
---
2-
title: Testing - Badges
2+
title: Testing - Badge
3+
crumbs:
4+
- path: components/badge
5+
label: Badge
36
---
47
{% extends 'test.njk' %}
5-
{% block content %}
6-
<section>
7-
<nav class="hxBreadcrumb">
8-
<a href="components/badges">Badges</a>
9-
<hx-icon class="delimiter" type="angle-right"></hx-icon>
10-
<a href="#">{{page.title}}</a>
11-
</nav>
12-
</section>
138

9+
{% block content %}
1410
<section class="hxRow">
1511
<div class="hxCol hxSpan-3-md">
1612
<h3>Light DOM White Space</h3>

0 commit comments

Comments
 (0)