From 015429e05d25d9e687dca785490acacee305c60a Mon Sep 17 00:00:00 2001 From: Cory LaViska Date: Fri, 8 Sep 2023 13:45:49 -0400 Subject: [PATCH] sl => wa --- .github/SECURITY.md | 4 +- CONTRIBUTING.md | 2 +- README.md | 20 +- cspell.json | 1 + custom-elements-manifest.config.js | 10 +- docs/_includes/component.njk | 44 +- docs/_includes/default.njk | 26 +- docs/_includes/sidebar.njk | 2 +- docs/_utilities/code-previews.cjs | 2 +- docs/_utilities/copy-code-buttons.cjs | 2 +- docs/_utilities/markdown.cjs | 6 +- docs/assets/scripts/code-previews.js | 24 +- docs/assets/scripts/search.js | 8 +- docs/assets/styles/docs.css | 6 +- docs/assets/styles/search.css | 6 +- docs/eleventy.config.cjs | 18 +- docs/pages/components/alert.md | 250 +- docs/pages/components/animated-image.md | 32 +- docs/pages/components/animation.md | 104 +- docs/pages/components/avatar.md | 118 +- docs/pages/components/badge.md | 182 +- docs/pages/components/breadcrumb-item.md | 34 +- docs/pages/components/breadcrumb.md | 280 +- docs/pages/components/button-group.md | 608 +-- docs/pages/components/button.md | 378 +- docs/pages/components/card.md | 88 +- docs/pages/components/carousel-item.md | 52 +- docs/pages/components/carousel.md | 646 +-- docs/pages/components/checkbox.md | 62 +- docs/pages/components/color-picker.md | 64 +- docs/pages/components/copy-button.md | 98 +- docs/pages/components/details.md | 64 +- docs/pages/components/dialog.md | 164 +- docs/pages/components/divider.md | 76 +- docs/pages/components/drawer.md | 262 +- docs/pages/components/dropdown.md | 546 +- docs/pages/components/format-bytes.md | 76 +- docs/pages/components/format-date.md | 58 +- docs/pages/components/format-number.md | 78 +- docs/pages/components/icon-button.md | 80 +- docs/pages/components/icon.md | 490 +- docs/pages/components/image-comparer.md | 20 +- docs/pages/components/include.md | 20 +- docs/pages/components/input.md | 152 +- docs/pages/components/menu-item.md | 220 +- docs/pages/components/menu-label.md | 52 +- docs/pages/components/menu.md | 182 +- docs/pages/components/mutation-observer.md | 62 +- docs/pages/components/option.md | 78 +- docs/pages/components/popup.md | 620 +-- docs/pages/components/progress-bar.md | 50 +- docs/pages/components/progress-ring.md | 60 +- docs/pages/components/qr-code.md | 60 +- docs/pages/components/radio-button.md | 330 +- docs/pages/components/radio-group.md | 206 +- docs/pages/components/radio.md | 136 +- docs/pages/components/range.md | 64 +- docs/pages/components/rating.md | 76 +- docs/pages/components/relative-time.md | 52 +- docs/pages/components/resize-observer.md | 16 +- docs/pages/components/select.md | 510 +- docs/pages/components/skeleton.md | 166 +- docs/pages/components/spinner.md | 32 +- docs/pages/components/split-panel.md | 176 +- docs/pages/components/switch.md | 38 +- docs/pages/components/tab-group.md | 544 +- docs/pages/components/tab-panel.md | 54 +- docs/pages/components/tab.md | 18 +- docs/pages/components/tag.md | 82 +- docs/pages/components/textarea.md | 68 +- docs/pages/components/tooltip.md | 312 +- docs/pages/components/tree-item.md | 192 +- docs/pages/components/tree.md | 504 +- docs/pages/components/visually-hidden.md | 18 +- docs/pages/frameworks/angular.md | 22 +- docs/pages/frameworks/react.md | 50 +- docs/pages/frameworks/vue-2.md | 28 +- docs/pages/frameworks/vue.md | 32 +- docs/pages/getting-started/customizing.md | 20 +- docs/pages/getting-started/form-controls.md | 278 +- docs/pages/getting-started/installation.md | 86 +- docs/pages/getting-started/localization.md | 18 +- docs/pages/getting-started/themes.md | 36 +- docs/pages/getting-started/usage.md | 64 +- docs/pages/index.md | 31 +- docs/pages/resources/accessibility.md | 12 +- docs/pages/resources/changelog.md | 1522 +++--- docs/pages/resources/community.md | 37 +- docs/pages/resources/contributing.md | 54 +- docs/pages/tokens/color.md | 2 +- .../tutorials/integrating-with-laravel.md | 24 +- .../tutorials/integrating-with-nextjs.md | 24 +- .../pages/tutorials/integrating-with-rails.md | 20 +- package.json | 14 +- scripts/build.js | 8 +- scripts/make-react.js | 2 +- scripts/plop/plopfile.js | 14 +- .../plop/templates/component/component.hbs | 8 +- scripts/plop/templates/component/tests.hbs | 2 +- src/{shoelace-autoloader.ts => autoloader.ts} | 4 +- src/components/alert/alert.component.ts | 44 +- src/components/alert/alert.test.ts | 100 +- src/components/alert/alert.ts | 8 +- .../animated-image.component.ts | 26 +- .../animated-image/animated-image.test.ts | 26 +- .../animated-image/animated-image.ts | 8 +- .../animation/animation.component.ts | 22 +- src/components/animation/animation.test.ts | 40 +- src/components/animation/animation.ts | 8 +- src/components/avatar/avatar.component.ts | 14 +- src/components/avatar/avatar.test.ts | 30 +- src/components/avatar/avatar.ts | 8 +- src/components/badge/badge.component.ts | 4 +- src/components/badge/badge.test.ts | 16 +- src/components/badge/badge.ts | 8 +- .../breadcrumb-item.component.ts | 6 +- .../breadcrumb-item/breadcrumb-item.test.ts | 36 +- .../breadcrumb-item/breadcrumb-item.ts | 8 +- .../breadcrumb/breadcrumb.component.ts | 20 +- src/components/breadcrumb/breadcrumb.test.ts | 76 +- src/components/breadcrumb/breadcrumb.ts | 8 +- .../button-group/button-group.component.ts | 26 +- .../button-group/button-group.test.ts | 88 +- src/components/button-group/button-group.ts | 8 +- src/components/button/button.component.ts | 34 +- src/components/button/button.styles.ts | 24 +- src/components/button/button.test.ts | 92 +- src/components/button/button.ts | 8 +- src/components/card/card.component.ts | 4 +- src/components/card/card.test.ts | 30 +- src/components/card/card.ts | 8 +- .../carousel-item/carousel-item.component.ts | 4 +- .../carousel-item/carousel-item.test.ts | 8 +- src/components/carousel-item/carousel-item.ts | 8 +- src/components/carousel/carousel.component.ts | 32 +- src/components/carousel/carousel.styles.ts | 2 +- src/components/carousel/carousel.test.ts | 286 +- src/components/carousel/carousel.ts | 8 +- src/components/checkbox/checkbox.component.ts | 46 +- src/components/checkbox/checkbox.test.ts | 156 +- src/components/checkbox/checkbox.ts | 8 +- .../color-picker/color-picker.component.ts | 170 +- .../color-picker/color-picker.styles.ts | 6 +- .../color-picker/color-picker.test.ts | 194 +- src/components/color-picker/color-picker.ts | 8 +- .../copy-button/copy-button.component.ts | 46 +- .../copy-button/copy-button.test.ts | 10 +- src/components/copy-button/copy-button.ts | 8 +- src/components/details/details.component.ts | 38 +- src/components/details/details.test.ts | 112 +- src/components/details/details.ts | 8 +- src/components/dialog/dialog.component.ts | 48 +- src/components/dialog/dialog.styles.ts | 6 +- src/components/dialog/dialog.test.ts | 88 +- src/components/dialog/dialog.ts | 8 +- src/components/divider/divider.component.ts | 4 +- src/components/divider/divider.test.ts | 12 +- src/components/divider/divider.ts | 8 +- src/components/drawer/drawer.component.ts | 48 +- src/components/drawer/drawer.styles.ts | 6 +- src/components/drawer/drawer.test.ts | 70 +- src/components/drawer/drawer.ts | 8 +- src/components/dropdown/dropdown.component.ts | 70 +- src/components/dropdown/dropdown.styles.ts | 2 +- src/components/dropdown/dropdown.test.ts | 336 +- src/components/dropdown/dropdown.ts | 8 +- .../format-bytes/format-bytes.component.ts | 4 +- .../format-bytes/format-bytes.test.ts | 12 +- src/components/format-bytes/format-bytes.ts | 8 +- .../format-date/format-date.component.ts | 4 +- .../format-date/format-date.test.ts | 68 +- src/components/format-date/format-date.ts | 8 +- .../format-number/format-number.component.ts | 4 +- .../format-number/format-number.test.ts | 48 +- src/components/format-number/format-number.ts | 8 +- .../icon-button/icon-button.component.ts | 22 +- .../icon-button/icon-button.test.ts | 74 +- src/components/icon-button/icon-button.ts | 8 +- src/components/icon/icon.component.ts | 12 +- src/components/icon/icon.test.ts | 58 +- src/components/icon/icon.ts | 8 +- src/components/icon/library.system.ts | 2 +- src/components/icon/library.ts | 8 +- .../image-comparer.component.ts | 16 +- .../image-comparer/image-comparer.test.ts | 80 +- .../image-comparer/image-comparer.ts | 8 +- src/components/include/include.component.ts | 14 +- src/components/include/include.test.ts | 18 +- src/components/include/include.ts | 8 +- src/components/input/input.component.ts | 46 +- src/components/input/input.styles.ts | 4 +- src/components/input/input.test.ts | 150 +- src/components/input/input.ts | 8 +- .../menu-item/menu-item.component.ts | 20 +- src/components/menu-item/menu-item.styles.ts | 4 +- src/components/menu-item/menu-item.test.ts | 154 +- src/components/menu-item/menu-item.ts | 8 +- .../menu-item/submenu-controller.ts | 20 +- .../menu-label/menu-label.component.ts | 6 +- src/components/menu-label/menu-label.test.ts | 8 +- src/components/menu-label/menu-label.ts | 8 +- src/components/menu/menu.component.ts | 24 +- src/components/menu/menu.styles.ts | 2 +- src/components/menu/menu.test.ts | 88 +- src/components/menu/menu.ts | 8 +- .../mutation-observer.component.ts | 8 +- .../mutation-observer.test.ts | 6 +- .../mutation-observer/mutation-observer.ts | 8 +- src/components/option/option.component.ts | 14 +- src/components/option/option.test.ts | 28 +- src/components/option/option.ts | 8 +- src/components/popup/popup.component.ts | 8 +- src/components/popup/popup.test.ts | 6 +- src/components/popup/popup.ts | 8 +- .../progress-bar/progress-bar.component.ts | 4 +- .../progress-bar/progress-bar.test.ts | 26 +- src/components/progress-bar/progress-bar.ts | 8 +- .../progress-ring/progress-ring.component.ts | 4 +- .../progress-ring/progress-ring.test.ts | 22 +- src/components/progress-ring/progress-ring.ts | 8 +- src/components/qr-code/qr-code.component.ts | 4 +- src/components/qr-code/qr-code.test.ts | 30 +- src/components/qr-code/qr-code.ts | 8 +- .../radio-button/radio-button.component.ts | 12 +- .../radio-button/radio-button.test.ts | 54 +- src/components/radio-button/radio-button.ts | 8 +- .../radio-group/radio-group.component.ts | 56 +- .../radio-group/radio-group.test.ts | 300 +- src/components/radio-group/radio-group.ts | 8 +- src/components/radio/radio.component.ts | 24 +- src/components/radio/radio.test.ts | 22 +- src/components/radio/radio.ts | 8 +- src/components/range/range.component.ts | 24 +- src/components/range/range.test.ts | 90 +- src/components/range/range.ts | 8 +- src/components/rating/rating.component.ts | 28 +- src/components/rating/rating.test.ts | 44 +- src/components/rating/rating.ts | 8 +- .../relative-time/relative-time.component.ts | 4 +- .../relative-time/relative-time.test.ts | 50 +- src/components/relative-time/relative-time.ts | 8 +- .../resize-observer.component.ts | 10 +- .../resize-observer/resize-observer.ts | 8 +- src/components/select/select.component.ts | 142 +- src/components/select/select.styles.ts | 6 +- src/components/select/select.test.ts | 444 +- src/components/select/select.ts | 8 +- src/components/skeleton/skeleton.component.ts | 4 +- src/components/skeleton/skeleton.test.ts | 12 +- src/components/skeleton/skeleton.ts | 8 +- src/components/spinner/spinner.component.ts | 4 +- src/components/spinner/spinner.test.ts | 12 +- src/components/spinner/spinner.ts | 8 +- .../split-panel/split-panel.component.ts | 10 +- .../split-panel/split-panel.test.ts | 88 +- src/components/split-panel/split-panel.ts | 8 +- src/components/switch/switch.component.ts | 40 +- src/components/switch/switch.test.ts | 184 +- src/components/switch/switch.ts | 8 +- .../tab-group/tab-group.component.ts | 68 +- src/components/tab-group/tab-group.styles.ts | 8 +- src/components/tab-group/tab-group.test.ts | 270 +- src/components/tab-group/tab-group.ts | 8 +- .../tab-panel/tab-panel.component.ts | 6 +- src/components/tab-panel/tab-panel.test.ts | 18 +- src/components/tab-panel/tab-panel.ts | 8 +- src/components/tab/tab.component.ts | 24 +- src/components/tab/tab.test.ts | 54 +- src/components/tab/tab.ts | 8 +- src/components/tag/tag.component.ts | 20 +- src/components/tag/tag.styles.ts | 10 +- src/components/tag/tag.test.ts | 20 +- src/components/tag/tag.ts | 8 +- src/components/textarea/textarea.component.ts | 26 +- src/components/textarea/textarea.test.ts | 84 +- src/components/textarea/textarea.ts | 8 +- src/components/tooltip/tooltip.component.ts | 40 +- src/components/tooltip/tooltip.test.ts | 110 +- src/components/tooltip/tooltip.ts | 8 +- .../tree-item/tree-item.component.ts | 66 +- src/components/tree-item/tree-item.styles.ts | 2 +- src/components/tree-item/tree-item.test.ts | 38 +- src/components/tree-item/tree-item.ts | 8 +- src/components/tree/tree.component.ts | 64 +- src/components/tree/tree.test.ts | 188 +- src/components/tree/tree.ts | 8 +- .../visually-hidden.component.ts | 4 +- .../visually-hidden/visually-hidden.test.ts | 12 +- .../visually-hidden/visually-hidden.ts | 8 +- src/events/events.ts | 70 +- src/events/sl-after-collapse.ts | 7 - src/events/sl-after-expand.ts | 7 - src/events/sl-after-hide.ts | 7 - src/events/sl-after-show.ts | 7 - src/events/sl-blur.ts | 7 - src/events/sl-cancel.ts | 7 - src/events/sl-change.ts | 7 - src/events/sl-clear.ts | 7 - src/events/sl-close.ts | 7 - src/events/sl-collapse.ts | 7 - src/events/sl-copy.ts | 7 - src/events/sl-error.ts | 7 - src/events/sl-expand.ts | 7 - src/events/sl-finish.ts | 7 - src/events/sl-focus.ts | 7 - src/events/sl-hide.ts | 7 - src/events/sl-initial-focus.ts | 7 - src/events/sl-input.ts | 7 - src/events/sl-invalid.ts | 7 - src/events/sl-lazy-change.ts | 7 - src/events/sl-lazy-load.ts | 7 - src/events/sl-load.ts | 7 - src/events/sl-mutation.ts | 7 - src/events/sl-remove.ts | 7 - src/events/sl-reposition.ts | 7 - src/events/sl-request-close.ts | 7 - src/events/sl-resize.ts | 7 - src/events/sl-select.ts | 9 - src/events/sl-selection-change.ts | 9 - src/events/sl-show.ts | 7 - src/events/sl-slide-change.ts | 9 - src/events/sl-start.ts | 7 - src/events/sl-tab-hide.ts | 7 - src/events/sl-tab-show.ts | 7 - src/events/wa-after-collapse.ts | 7 + src/events/wa-after-expand.ts | 7 + src/events/wa-after-hide.ts | 7 + src/events/wa-after-show.ts | 7 + src/events/wa-blur.ts | 7 + src/events/wa-cancel.ts | 7 + src/events/wa-change.ts | 7 + src/events/wa-clear.ts | 7 + src/events/wa-close.ts | 7 + src/events/wa-collapse.ts | 7 + src/events/wa-copy.ts | 7 + src/events/wa-error.ts | 7 + src/events/wa-expand.ts | 7 + src/events/wa-finish.ts | 7 + src/events/wa-focus.ts | 7 + src/events/wa-hide.ts | 7 + src/events/{sl-hover.ts => wa-hover.ts} | 4 +- src/events/wa-initial-focus.ts | 7 + src/events/wa-input.ts | 7 + src/events/wa-invalid.ts | 7 + src/events/wa-lazy-change.ts | 7 + src/events/wa-lazy-load.ts | 7 + src/events/wa-load.ts | 7 + src/events/wa-mutation.ts | 7 + src/events/wa-remove.ts | 7 + src/events/wa-reposition.ts | 7 + src/events/wa-request-close.ts | 7 + src/events/wa-resize.ts | 7 + src/events/wa-select.ts | 9 + src/events/wa-selection-change.ts | 9 + src/events/wa-show.ts | 7 + src/events/wa-slide-change.ts | 9 + src/events/wa-start.ts | 7 + src/events/wa-tab-hide.ts | 7 + src/events/wa-tab-show.ts | 7 + src/internal/form.ts | 58 +- src/internal/scroll.ts | 8 +- src/internal/slot.ts | 2 +- src/internal/tabbable.test.ts | 20 +- src/internal/test/form-control-base-tests.ts | 78 +- ...ent.test.ts => webawesome-element.test.ts} | 42 +- ...elace-element.ts => webawesome-element.ts} | 14 +- src/shoelace.ts | 69 - src/themes/_utility.css | 10 +- src/themes/default.css | 2 +- src/utilities/base-path.ts | 16 +- src/utilities/form.ts | 8 +- src/webawesome.ts | 69 + web-test-runner.config.js | 2 +- web-types.json | 4705 +++++++++++++++++ 374 files changed, 14976 insertions(+), 10290 deletions(-) rename src/{shoelace-autoloader.ts => autoloader.ts} (94%) delete mode 100644 src/events/sl-after-collapse.ts delete mode 100644 src/events/sl-after-expand.ts delete mode 100644 src/events/sl-after-hide.ts delete mode 100644 src/events/sl-after-show.ts delete mode 100644 src/events/sl-blur.ts delete mode 100644 src/events/sl-cancel.ts delete mode 100644 src/events/sl-change.ts delete mode 100644 src/events/sl-clear.ts delete mode 100644 src/events/sl-close.ts delete mode 100644 src/events/sl-collapse.ts delete mode 100644 src/events/sl-copy.ts delete mode 100644 src/events/sl-error.ts delete mode 100644 src/events/sl-expand.ts delete mode 100644 src/events/sl-finish.ts delete mode 100644 src/events/sl-focus.ts delete mode 100644 src/events/sl-hide.ts delete mode 100644 src/events/sl-initial-focus.ts delete mode 100644 src/events/sl-input.ts delete mode 100644 src/events/sl-invalid.ts delete mode 100644 src/events/sl-lazy-change.ts delete mode 100644 src/events/sl-lazy-load.ts delete mode 100644 src/events/sl-load.ts delete mode 100644 src/events/sl-mutation.ts delete mode 100644 src/events/sl-remove.ts delete mode 100644 src/events/sl-reposition.ts delete mode 100644 src/events/sl-request-close.ts delete mode 100644 src/events/sl-resize.ts delete mode 100644 src/events/sl-select.ts delete mode 100644 src/events/sl-selection-change.ts delete mode 100644 src/events/sl-show.ts delete mode 100644 src/events/sl-slide-change.ts delete mode 100644 src/events/sl-start.ts delete mode 100644 src/events/sl-tab-hide.ts delete mode 100644 src/events/sl-tab-show.ts create mode 100644 src/events/wa-after-collapse.ts create mode 100644 src/events/wa-after-expand.ts create mode 100644 src/events/wa-after-hide.ts create mode 100644 src/events/wa-after-show.ts create mode 100644 src/events/wa-blur.ts create mode 100644 src/events/wa-cancel.ts create mode 100644 src/events/wa-change.ts create mode 100644 src/events/wa-clear.ts create mode 100644 src/events/wa-close.ts create mode 100644 src/events/wa-collapse.ts create mode 100644 src/events/wa-copy.ts create mode 100644 src/events/wa-error.ts create mode 100644 src/events/wa-expand.ts create mode 100644 src/events/wa-finish.ts create mode 100644 src/events/wa-focus.ts create mode 100644 src/events/wa-hide.ts rename src/events/{sl-hover.ts => wa-hover.ts} (63%) create mode 100644 src/events/wa-initial-focus.ts create mode 100644 src/events/wa-input.ts create mode 100644 src/events/wa-invalid.ts create mode 100644 src/events/wa-lazy-change.ts create mode 100644 src/events/wa-lazy-load.ts create mode 100644 src/events/wa-load.ts create mode 100644 src/events/wa-mutation.ts create mode 100644 src/events/wa-remove.ts create mode 100644 src/events/wa-reposition.ts create mode 100644 src/events/wa-request-close.ts create mode 100644 src/events/wa-resize.ts create mode 100644 src/events/wa-select.ts create mode 100644 src/events/wa-selection-change.ts create mode 100644 src/events/wa-show.ts create mode 100644 src/events/wa-slide-change.ts create mode 100644 src/events/wa-start.ts create mode 100644 src/events/wa-tab-hide.ts create mode 100644 src/events/wa-tab-show.ts rename src/internal/{shoelace-element.test.ts => webawesome-element.test.ts} (75%) rename src/internal/{shoelace-element.ts => webawesome-element.ts} (92%) delete mode 100644 src/shoelace.ts create mode 100644 src/webawesome.ts create mode 100644 web-types.json diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 564538742..3e8f91ebb 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -1,7 +1,7 @@ # Reporting Security Issues -We take security issues in Shoelace very seriously and appreciate your efforts to disclose your findings responsibly. +We take security issues in Web Awesome very seriously and appreciate your efforts to disclose your findings responsibly. -To report a security issue, email [cory@abeautifulsite.net](mailto:cory@abeautifulsite.net) and include "SHOELACE SECURITY" in the subject line. +To report a security issue, email [cory@fontawesome.com](mailto:cory@abeautifulsite.net) and include "WEB AWESOME SECURITY" in the subject line. We'll respond as soon as possible and keep you updated throughout the process. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1c554ca6..eb0332d1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Shoelace +# Contributing to Web Awesome Before contributing, please review the contributions guidelines at: diff --git a/README.md b/README.md index ef7dcf34f..6d142e026 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Shoelace +# Web Awesome A forward-thinking library of web components. @@ -23,13 +23,13 @@ Twitter: [@shoelace_style](https://twitter.com/shoelace_style) ## Shoemakers 🥾 -Shoemakers, or "Shoelace developers," can use this documentation to learn how to build Shoelace from source. You will need Node >= 14.17 to build and run the project locally. +Shoemakers, or "Web Awesome developers," can use this documentation to learn how to build Web Awesome from source. You will need Node >= 14.17 to build and run the project locally. -**You don't need to do any of this to use Shoelace!** This page is for people who want to contribute to the project, tinker with the source, or create a custom build of Shoelace. +**You don't need to do any of this to use Web Awesome!** This page is for people who want to contribute to the project, tinker with the source, or create a custom build of Web Awesome. If that's not what you're trying to do, the [documentation website](https://shoelace.style) is where you want to be. -### What are you using to build Shoelace? +### What are you using to build Web Awesome? Components are built with [LitElement](https://lit-element.polymer-project.org/), a custom elements base class that provides an intuitive API and reactive data binding. The build is a custom script with bundling powered by [esbuild](https://esbuild.github.io/). @@ -38,8 +38,8 @@ Components are built with [LitElement](https://lit-element.polymer-project.org/) Start by [forking the repo](https://github.com/shoelace-style/shoelace/fork) on GitHub, then clone it locally and install dependencies. ```bash -git clone https://github.com/YOUR_GITHUB_USERNAME/shoelace -cd shoelace +git clone https://github.com/YOUR_GITHUB_USERNAME/webawesome +cd webawesome npm install ``` @@ -63,18 +63,18 @@ npm run build ### Creating New Components -To scaffold a new component, run the following command, replacing `sl-tag-name` with the desired tag name. +To scaffold a new component, run the following command, replacing `wa-tag-name` with the desired tag name. ```bash -npm run create sl-tag-name +npm run create wa-tag-name ``` This will generate a source file, a stylesheet, and a docs page for you. When you start the dev server, you'll find the new component in the "Components" section of the sidebar. ### Contributing -Shoelace is an open source project and contributions are encouraged! If you're interesting in contributing, please review the [contribution guidelines](CONTRIBUTING.md) first. +Web Awesome is an open source project and contributions are encouraged! If you're interesting in contributing, please review the [contribution guidelines](CONTRIBUTING.md) first. ## License -Shoelace is available under the terms of the MIT license. +Web Awesome is available under the terms of the MIT license. diff --git a/cspell.json b/cspell.json index 5604aab40..2172b208f 100644 --- a/cspell.json +++ b/cspell.json @@ -166,6 +166,7 @@ "valpha", "valuenow", "valuetext", + "webawesome", "WEBP", "Webpacker", "wordmark" diff --git a/custom-elements-manifest.config.js b/custom-elements-manifest.config.js index 453627028..a9282a5ef 100644 --- a/custom-elements-manifest.config.js +++ b/custom-elements-manifest.config.js @@ -33,14 +33,14 @@ export default { plugins: [ // Append package data { - name: 'shoelace-package-data', + name: 'wa-package-data', packageLinkPhase({ customElementsManifest }) { customElementsManifest.package = { name, description, version, author, homepage, license }; } }, // Infer tag names because we no longer use @customElement decorators. { - name: 'shoelace-infer-tag-names', + name: 'wa-infer-tag-names', analyzePhase({ ts, node, moduleDoc }) { switch (node.kind) { case ts.SyntaxKind.ClassDeclaration: { @@ -68,7 +68,7 @@ export default { }, // Parse custom jsDoc tags { - name: 'shoelace-custom-tags', + name: 'wa-custom-tags', analyzePhase({ ts, node, moduleDoc }) { switch (node.kind) { case ts.SyntaxKind.ClassDeclaration: { @@ -138,7 +138,7 @@ export default { } }, { - name: 'shoelace-react-event-names', + name: 'wa-react-event-names', analyzePhase({ ts, node, moduleDoc }) { switch (node.kind) { case ts.SyntaxKind.ClassDeclaration: { @@ -156,7 +156,7 @@ export default { } }, { - name: 'shoelace-translate-module-paths', + name: 'wa-translate-module-paths', packageLinkPhase({ customElementsManifest }) { customElementsManifest?.modules?.forEach(mod => { // diff --git a/docs/_includes/component.njk b/docs/_includes/component.njk index 249f9b77e..d2153d54a 100644 --- a/docs/_includes/component.njk +++ b/docs/_includes/component.njk @@ -1,7 +1,7 @@ {% extends "default.njk" %} {# Find the component based on the `tag` front matter #} -{% set component = getComponent('sl-' + page.fileSlug) %} +{% set component = getComponent('wa-' + page.fileSlug) %} {% block content %} {# Determine the badge variant #} @@ -26,12 +26,12 @@
- + Since {{component.since or '?' }} - - + + {{ component.status }} - +
@@ -51,42 +51,42 @@ any of the following snippets to cherry pick this component.

- - Script - Import - Bundler - React + + Script + Import + Bundler + React - +

To import this component from the CDN using a script tag: 

<script type="module" src="https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@{{ meta.version }}/{{ meta.cdndir }}/{{ component.path }}"></script>
- + - +

To import this component from the CDN using a JavaScript import: 

import 'https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@{{ meta.version }}/{{ meta.cdndir }}/{{ component.path }}';
- + - +

To import this component using a bundler: 

import '@shoelace-style/shoelace/{{ meta.npmdir }}/{{ component.path }}';
- + - +

To import this component as a React component: 

import {{ component.name }} from '@shoelace-style/shoelace/{{ meta.npmdir }}/react/{{ component.tagNameWithoutPrefix }}';
- - + + {# Slots #} {% if component.slots.length %} @@ -140,13 +140,13 @@ {% if prop.attribute | length > 0 %} {% if prop.attribute != prop.name %}
- + {{ prop.attribute }} - + {% endif %} {% endif %} @@ -155,7 +155,7 @@ {% if prop.reflects %} - + {% endif %} diff --git a/docs/_includes/default.njk b/docs/_includes/default.njk index d9754194a..c6340b487 100644 --- a/docs/_includes/default.njk +++ b/docs/_includes/default.njk @@ -2,7 +2,7 @@ {# Metadata #} @@ -33,9 +33,9 @@ - {# Shoelace #} + {# Web Awesome #} - + {# Web Fonts #} @@ -74,19 +74,19 @@
- - Code - - - Star - - + + Code + + + Star + +
diff --git a/docs/_includes/sidebar.njk b/docs/_includes/sidebar.njk index b01d398b4..19c3e5724 100644 --- a/docs/_includes/sidebar.njk +++ b/docs/_includes/sidebar.njk @@ -40,7 +40,7 @@