Skip to content

Commit

Permalink
docs: address all API exampled
Browse files Browse the repository at this point in the history
BREAKING CHANGE: This commit adds all the necessary code examples needed for the API
illustrations.

This commit also removes the code for the unused XL and
XXS variants.

Changes to be committed:
new file:   apiExamples/api_large.html
new file:   apiExamples/api_medium.html
new file:   apiExamples/api_small.html
new file:   apiExamples/api_xs.html
modified:   apiExamples/custom_speed.html
modified:   apiExamples/loaderGallery.html
modified:   apiExamples/loader_sizes.html
new file:   apiExamples/ondark.html
new file:   apiExamples/onlight.html
new file:   apiExamples/property_laser.html
new file:   apiExamples/property_orbit.html
new file:   apiExamples/property_pulse.html
new file:   apiExamples/property_ringworm.html
new file:   apiExamples/white.html
modified:   demo/api.html
modified:   demo/apiExamples.md
modified:   demo/demo.md
modified:   docs/api.md
modified:   docs/partials/apiExamples.md
modified:   scripts/generateDocs.mjs
modified:   src/auro-loader.js
modified:   src/styles/_base.scss
modified:   src/styles/_orbit.scss
  • Loading branch information
blackfalcon authored and jason-capsule42 committed Jan 20, 2024
1 parent fe28a6b commit 1f12759
Show file tree
Hide file tree
Showing 24 changed files with 480 additions and 169 deletions.
2 changes: 1 addition & 1 deletion .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ branches:
# Required. Require branches to be up to date before merging.
strict: true
# Required. The list of status checks to require in order to merge into this branch
contexts: ["test (18.x)","test (20.x)", "license/cla"]
contexts: ["test (18.x)", "test (20.x)", "license/cla"]
# Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
enforce_admins: false
# Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
Expand Down
3 changes: 3 additions & 0 deletions apiExamples/api_large.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<auro-loader ringworm lg></auro-loader>
<auro-loader orbit lg></auro-loader>
<auro-loader pulse lg></auro-loader>
3 changes: 3 additions & 0 deletions apiExamples/api_medium.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<auro-loader ringworm md></auro-loader>
<auro-loader orbit md></auro-loader>
<auro-loader pulse md></auro-loader>
3 changes: 3 additions & 0 deletions apiExamples/api_small.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<auro-loader ringworm sm></auro-loader>
<auro-loader orbit sm></auro-loader>
<auro-loader pulse sm></auro-loader>
3 changes: 3 additions & 0 deletions apiExamples/api_xs.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<auro-loader ringworm xs></auro-loader>
<auro-loader orbit xs></auro-loader>
<auro-loader pulse xs></auro-loader>
4 changes: 2 additions & 2 deletions apiExamples/custom_speed.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
}
</style>

<auro-loader class="slow" orbit lg></auro-loader>
<auro-loader class="fast" orbit xl></auro-loader>
<auro-loader class="slow" orbit md></auro-loader>
<auro-loader class="fast" orbit lg></auro-loader>
6 changes: 3 additions & 3 deletions apiExamples/loaderGallery.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<auro-loader ringworm md></auro-loader>
<auro-loader orbit md></auro-loader>
<auro-loader pulse md></auro-loader>
<auro-loader ringworm></auro-loader>
<auro-loader orbit></auro-loader>
<auro-loader pulse></auro-loader>
<auro-loader laser></auro-loader>
2 changes: 1 addition & 1 deletion apiExamples/loader_sizes.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<auro-loader ringworm xs></auro-loader>
<auro-loader ringworm></auro-loader>
<auro-loader ringworm sm></auro-loader>
<auro-loader ringworm md></auro-loader>
<auro-loader ringworm lg></auro-loader>
<auro-loader ringworm xl></auro-loader>
3 changes: 3 additions & 0 deletions apiExamples/ondark.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<auro-loader ringworm ondark></auro-loader>
<auro-loader orbit ondark></auro-loader>
<auro-loader pulse ondark></auro-loader>
3 changes: 3 additions & 0 deletions apiExamples/onlight.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<auro-loader ringworm onLight></auro-loader>
<auro-loader orbit onLight></auro-loader>
<auro-loader pulse onLight></auro-loader>
1 change: 1 addition & 0 deletions apiExamples/property_laser.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<auro-loader laser></auro-loader>
1 change: 1 addition & 0 deletions apiExamples/property_orbit.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<auro-loader orbit></auro-loader>
1 change: 1 addition & 0 deletions apiExamples/property_pulse.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<auro-loader pulse></auro-loader>
1 change: 1 addition & 0 deletions apiExamples/property_ringworm.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<auro-loader ringworm></auro-loader>
3 changes: 3 additions & 0 deletions apiExamples/white.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<auro-loader ringworm white></auro-loader>
<auro-loader orbit white></auro-loader>
<auro-loader pulse white></auro-loader>
4 changes: 2 additions & 2 deletions demo/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
type="text/css"
href="https://cdn.jsdelivr.net/npm/[email protected]/themes/prism.css"
/>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@alaskaairux/design-tokens@latest/dist/tokens/CSSCustomProperties.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css">
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/demoWrapper.css" />
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/elementDemoStyles.css" />
</head>
Expand All @@ -43,6 +43,6 @@
<script type="module" data-demo-script="true" src="../index.js"></script>

<!-- If additional elements are needed for the demo, add them here. -->
<script src="https://cdn.jsdelivr.net/npm/@alaskaairux/auro-accordion@latest/dist/auro-accordion__bundled.js" type="module"></script>
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-accordion@latest/dist/auro-accordion__bundled.js" type="module"></script>
</body>
</html>
Loading

0 comments on commit 1f12759

Please sign in to comment.