Skip to content

Commit e372c3f

Browse files
author
Ryan A. Johnson
committed
docs: update content
* fix typo in Search component snippet * modified layout templates to reflect updates to instructions * update copyright year to "2017-2019" range
1 parent 5953a54 commit e372c3f

File tree

8 files changed

+594
-267
lines changed

8 files changed

+594
-267
lines changed

‎docs/_templates/application.njk‎

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

141141
<footer id="foot" class="hxRow hxGutterless">
142142
<div class="hxCol">
143-
&copy; 2019 Rackspace US, Inc.
143+
&copy; 2017-2019 Rackspace US, Inc.
144144
<nav>
145145
<a href="https://www.rackspace.com/information/legal/websiteterms">Website Terms</a>
146146
<a href="https://www.rackspace.com/information/legal/privacystatement">Privacy Policy</a>

‎docs/components/layout/index.html‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ <h2 id="prerequisites">Prerequisites</h2>
112112
</header>
113113

114114
<p>
115-
To get the most out of this documentation, developers are
116-
expected to:
115+
To get the most out of {{page.title}} documentation,
116+
developers are expected to:
117117
</p>
118118

119119
<ol class="hxList">
@@ -125,11 +125,6 @@ <h2 id="prerequisites">Prerequisites</h2>
125125
Have a basic understanding of the features and limitations of
126126
each of the pre-defined layouts.
127127
</li>
128-
<li>
129-
Have a basic understanding of how to load the required
130-
<a href="guides/getting-started/#step-1">HelixUI</a> assets and required
131-
<a href="guides/getting-started/#step-2">polyfills</a>.
132-
</li>
133128
</ol>
134129
</section>
135130

‎docs/components/search/search-demo.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ if (document.getElementById('vue-searchDemo')) {
5050
>
5151
<hx-icon type="times"></hx-icon>
5252
</button>
53-
<hx-search</hx-search>
53+
<hx-search></hx-search>
5454
<label
5555
for="demoSearch"
5656
${this.lblClasses}

‎docs/files/horizontal-layout-template.html‎

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@
44
<title>Horizontal - App Title</title>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1" />
7-
<link rel="shortcut icon" href="images/favicon.png" />
7+
<link rel="shortcut icon" href="%ASSET_PATH%/images/favicon.png" />
8+
9+
<link rel="stylesheet" href="%ASSET_PATH%/helix-ui.min.css" />
810

9-
<!-- DO NOT BUNDLE: HelixUI Styles -->
10-
<link rel="stylesheet" href="path/to/helix-ui/dist/styles/helix-ui.min.css" />
11-
<!-- DO NOT COMPILE: Converts ES5 custom element constructor functions to ES6 classes -->
12-
<script src="path/to/@webcomponents/webcomponentsjs/custom-elements-es5-adapter.js"></script>
1311
<!-- DO NOT COMPILE: Appends polyfills to <head> if needed by user's browser. -->
14-
<script src="path/to/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>
12+
<script src="%ASSET_PATH%/webcomponents-loader.js"></script>
1513
</head>
1614
<body class="hxHorizontal" id="top">
1715
<!-- Accessibility: This link should be the first item in tab order. -->
@@ -69,18 +67,27 @@ <h2>Secondary Panel</h2>
6967
</div>
7068

7169
<footer id="foot">
72-
&copy; 2018 Rackspace US, Inc.
70+
&copy; 2017-2019 Rackspace US, Inc.
7371
<nav>
7472
<a href="https://www.rackspace.com/information/legal/websiteterms">Website Terms</a>
7573
<a href="https://www.rackspace.com/information/legal/privacystatement">Privacy Policy</a>
7674
</nav>
7775
</footer>
7876

79-
<!--
80-
DO NOT BUNDLE: ES5-compiled assets specifically for use in the browser.
81-
Provides additional polyfills and automatically initializes HelixUI.
82-
-->
83-
<script src="path/to/helix-ui/scripts/helix-ui.browser.min.js"></script>
77+
<!-- UMD for Legacy Browsers (ES5) -->
78+
<script nomodule src="%ASSET_PATH%/helix-ui.min.js"></script>
79+
<script nomodule>
80+
HelixUI.initialize();
81+
</script>
82+
83+
<!-- ESM for Modern Browsers (ES6+) -->
84+
<script type="module">
85+
import HelixUI from '/%ASSET_PATH%/helix-ui.module.min.js';
86+
87+
HelixUI.initialize();
88+
</script>
89+
90+
<!-- App Scripts Go Here -->
8491

8592
<a id="bottom"></a>
8693
</body>

‎docs/files/vertical-layout-template.html‎

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@
44
<title>Vertical - App Title</title>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1" />
7-
<link rel="shortcut icon" href="images/favicon.png" />
7+
<link rel="shortcut icon" href="%ASSET_PATH%/images/favicon.png" />
8+
9+
<link rel="stylesheet" href="%ASSET_PATH%/helix-ui.min.css" />
810

9-
<!-- DO NOT BUNDLE: HelixUI Styles -->
10-
<link rel="stylesheet" href="path/to/helix-ui/dist/styles/helix-ui.min.css" />
11-
<!-- DO NOT COMPILE: Converts ES5 custom element constructor functions to ES6 classes -->
12-
<script src="path/to/@webcomponents/webcomponentsjs/custom-elements-es5-adapter.js"></script>
1311
<!-- DO NOT COMPILE: Appends polyfills to <head> if needed by user's browser. -->
14-
<script src="path/to/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>
12+
<script src="%ASSET_PATH%/webcomponents-loader.js"></script>
1513
</head>
1614
<body class="hxVertical" id="top">
1715
<!-- Accessibility: This link should be the first item in tab order. -->
@@ -63,18 +61,27 @@ <h1>Page Content</h1>
6361
</div>
6462

6563
<footer id="foot">
66-
&copy; 2018 Rackspace US, Inc.
64+
&copy; 2017-2019 Rackspace US, Inc.
6765
<nav>
6866
<a href="https://www.rackspace.com/information/legal/websiteterms">Website Terms</a>
6967
<a href="https://www.rackspace.com/information/legal/privacystatement">Privacy Policy</a>
7068
</nav>
7169
</footer>
7270

73-
<!--
74-
DO NOT BUNDLE: ES5-compiled assets specifically for use in the browser.
75-
Provides additional polyfills and automatically initializes HelixUI.
76-
-->
77-
<script src="path/to/helix-ui/scripts/helix-ui.browser.min.js"></script>
71+
<!-- UMD for Legacy Browsers (ES5) -->
72+
<script nomodule src="%ASSET_PATH%/helix-ui.min.js"></script>
73+
<script nomodule>
74+
HelixUI.initialize();
75+
</script>
76+
77+
<!-- ESM for Modern Browsers (ES6+) -->
78+
<script type="module">
79+
import HelixUI from '/%ASSET_PATH%/helix-ui.module.min.js';
80+
81+
HelixUI.initialize();
82+
</script>
83+
84+
<!-- App Scripts Go Here -->
7885

7986
<a id="bottom"></a>
8087
</body>

0 commit comments

Comments
 (0)