@awc-ui/core 1.0.0-beta.8 → 1.0.0-beta.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -23
- package/custom-elements.json +32593 -0
- package/dist/cjs/md-navigation-tab.cjs.entry.js +1 -1
- package/dist/cjs/md-navigation-tab.cjs.entry.js.map +1 -1
- package/dist/collection/components/md-navigation-tab/md-navigation-tab.css +19 -6
- package/dist/components/md-navigation-tab.js +1 -1
- package/dist/components/md-navigation-tab.js.map +1 -1
- package/dist/components-csr/md-navigation-tab.js +1 -1
- package/dist/components-csr/md-navigation-tab.js.map +1 -1
- package/dist/esm/md-navigation-tab.entry.js +1 -1
- package/dist/esm/md-navigation-tab.entry.js.map +1 -1
- package/dist/md3/md3.esm.js +1 -1
- package/dist/md3/{p-afa21d99.entry.js → p-6fdbbfef.entry.js} +2 -2
- package/dist/md3/p-6fdbbfef.entry.js.map +1 -0
- package/hydrate/index.js +1 -1
- package/hydrate/index.mjs +1 -1
- package/package.json +33 -5
- package/dist/md3/p-afa21d99.entry.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,13 +1,26 @@
|
|
|
1
1
|
# @awc-ui/core
|
|
2
2
|
|
|
3
|
-
](https://www.npmjs.com/package/@awc-ui/core)
|
|
4
|
+
[](https://www.npmjs.com/package/@awc-ui/core)
|
|
5
|
+
[](https://m3.material.io/)
|
|
6
|
+
[](https://awc-ui.dev/frameworks/web-components/)
|
|
7
|
+
[](https://stenciljs.com/)
|
|
8
|
+
[](https://www.typescriptlang.org/)
|
|
9
|
+
[](https://awc-ui.dev/guides/accessibility/)
|
|
10
|
+
[](https://www.npmjs.com/package/@awc-ui/core?activeTab=dependencies)
|
|
11
|
+
|
|
12
|
+
[](https://awc-ui.dev/frameworks/react/)
|
|
13
|
+
[](https://awc-ui.dev/frameworks/angular/)
|
|
14
|
+
[](https://awc-ui.dev/frameworks/vue/)
|
|
15
|
+
[](https://awc-ui.dev/frameworks/svelte/)
|
|
16
|
+
[](https://awc-ui.dev/frameworks/ssr/)
|
|
17
|
+
[](./LICENSE)
|
|
6
18
|
|
|
7
19
|
|
|
8
|
-
**Material Design 3
|
|
20
|
+
**Material Design 3 Web Components, built with [Stencil](https://stenciljs.com/).**
|
|
9
21
|
56 components that ship as standard custom elements, so they work in React,
|
|
10
|
-
Angular, Vue, Svelte or
|
|
22
|
+
Angular, Vue, Svelte, or plain HTML, with SSR for Next.js, Nuxt, SvelteKit,
|
|
23
|
+
Astro, and Angular.
|
|
11
24
|
|
|
12
25
|
> **Beta.** The API is stable enough to build with, but it is not frozen —
|
|
13
26
|
> expect occasional breaking changes before 1.0.
|
|
@@ -27,10 +40,10 @@ own instructions in them untouched. Nothing is fetched from the network.
|
|
|
27
40
|
|
|
28
41
|
The documentation itself:
|
|
29
42
|
|
|
30
|
-
| File
|
|
31
|
-
|
|
32
|
-
| [`main-llm.md`](./main-llm.md)
|
|
33
|
-
| `src/components/<tag>/readme.md` | Full manual for one component — API, accessibility contract, anti-patterns
|
|
43
|
+
| File | What it gives you |
|
|
44
|
+
| -------------------------------- | ----------------------------------------------------------------------------------------- |
|
|
45
|
+
| [`main-llm.md`](./main-llm.md) | **Start here.** Interview, decision matrix, token reference, page recipes, ship checklist |
|
|
46
|
+
| `src/components/<tag>/readme.md` | Full manual for one component — API, accessibility contract, anti-patterns |
|
|
34
47
|
|
|
35
48
|
Each component's manual has a **When NOT to use** and an **Anti-patterns**
|
|
36
49
|
section. Read them: they describe the mistakes assistants actually make with
|
|
@@ -47,7 +60,7 @@ npm install @awc-ui/core
|
|
|
47
60
|
One import registers every element **and** loads the design tokens:
|
|
48
61
|
|
|
49
62
|
```js
|
|
50
|
-
import
|
|
63
|
+
import "@awc-ui/core/define";
|
|
51
64
|
```
|
|
52
65
|
|
|
53
66
|
```html
|
|
@@ -57,11 +70,11 @@ import '@awc-ui/core/define';
|
|
|
57
70
|
`define` imports `tokens.css`, so it is a **bundler-only** entry. Two cases need
|
|
58
71
|
something else:
|
|
59
72
|
|
|
60
|
-
| Situation
|
|
61
|
-
|
|
62
|
-
| Bundler (Vite, webpack, Next, Nuxt…) | `import '@awc-ui/core/define'`
|
|
63
|
-
| CDN / no bundler
|
|
64
|
-
| Server-side rendering
|
|
73
|
+
| Situation | Entry |
|
|
74
|
+
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
|
|
75
|
+
| Bundler (Vite, webpack, Next, Nuxt…) | `import '@awc-ui/core/define'` |
|
|
76
|
+
| CDN / no bundler | load the loader, plus `<link rel="stylesheet" href="…/@awc-ui/tokens/src/tokens.css">` |
|
|
77
|
+
| Server-side rendering | `@awc-ui/core/hydrate` — reference apps for Next.js, Nuxt, SvelteKit, Astro, and Angular SSR live under `apps/` in the repo |
|
|
65
78
|
|
|
66
79
|
### Smallest bundles: per-component imports
|
|
67
80
|
|
|
@@ -69,8 +82,8 @@ something else:
|
|
|
69
82
|
import per component instead (the tokens then need one explicit CSS import):
|
|
70
83
|
|
|
71
84
|
```js
|
|
72
|
-
import
|
|
73
|
-
import { defineCustomElement } from
|
|
85
|
+
import "@awc-ui/core/css/tokens.css";
|
|
86
|
+
import { defineCustomElement } from "@awc-ui/core/components/md-button";
|
|
74
87
|
defineCustomElement();
|
|
75
88
|
```
|
|
76
89
|
|
|
@@ -86,12 +99,12 @@ bundler to switch a whole app (framework wrappers included) in one line.
|
|
|
86
99
|
The elements work untouched anywhere, but typed wrappers give you props, events
|
|
87
100
|
and JSX types:
|
|
88
101
|
|
|
89
|
-
| Framework | Package
|
|
90
|
-
|
|
91
|
-
| React
|
|
92
|
-
| Angular
|
|
93
|
-
| Vue
|
|
94
|
-
| Svelte
|
|
102
|
+
| Framework | Package |
|
|
103
|
+
| --------- | ------------------------------------------------------------------ |
|
|
104
|
+
| React | [`@awc-ui/react`](https://www.npmjs.com/package/@awc-ui/react) |
|
|
105
|
+
| Angular | [`@awc-ui/angular`](https://www.npmjs.com/package/@awc-ui/angular) |
|
|
106
|
+
| Vue | [`@awc-ui/vue`](https://www.npmjs.com/package/@awc-ui/vue) |
|
|
107
|
+
| Svelte | [`@awc-ui/svelte`](https://www.npmjs.com/package/@awc-ui/svelte) |
|
|
95
108
|
|
|
96
109
|
## What's in the box
|
|
97
110
|
|