polaris-vue-elements 0.2.0 → 0.3.0
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/CHANGELOG.md +20 -1
- package/README.md +4 -2
- package/dist/generated/metadata.d.ts.map +1 -1
- package/dist/generated/types.d.ts +41 -40
- package/dist/generated/types.d.ts.map +1 -1
- package/dist/index.js +45 -40
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -11,6 +11,24 @@ major your app loads (`polaris-1.js`, `polaris-2.js`, …).
|
|
|
11
11
|
|
|
12
12
|
## [Unreleased]
|
|
13
13
|
|
|
14
|
+
## [0.3.0] - 2026-10-27
|
|
15
|
+
|
|
16
|
+
Generated from `@shopify/polaris-types` 2.0.0 (was 1.1.0). No props, slots or icons were
|
|
17
|
+
removed.
|
|
18
|
+
|
|
19
|
+
### Added
|
|
20
|
+
|
|
21
|
+
- `SThumbnail` `loading` prop (`"eager" | "lazy"`).
|
|
22
|
+
- `STextField` `icon` accepts 41 more icon names, mostly `*-filled` variants (such as
|
|
23
|
+
`globe-filled` and `file-filled`) plus `magic`, `text-magic`, `rank-top` and others.
|
|
24
|
+
|
|
25
|
+
### Changed
|
|
26
|
+
|
|
27
|
+
- **Docs and examples now load the stable Polaris 2 runtime**
|
|
28
|
+
(`https://cdn.shopify.com/shopifycloud/polaris-2.js`) instead of `polaris-1.js`. Apps
|
|
29
|
+
that stay on `polaris-1.js` keep working with these wrappers; only the additions above
|
|
30
|
+
need the 2.x runtime.
|
|
31
|
+
|
|
14
32
|
## [0.2.0] - 2026-09-28
|
|
15
33
|
|
|
16
34
|
Generated from `@shopify/polaris-types` 1.1.0 (was 1.0.7).
|
|
@@ -58,6 +76,7 @@ Initial release: typed Vue 3 wrappers for the 59 Shopify Polaris web components
|
|
|
58
76
|
`showOverlay()` / `hideOverlay()` / `toggleOverlay()`).
|
|
59
77
|
- ESM build with bundled type declarations; `vue` ^3.5 as a peer dependency.
|
|
60
78
|
|
|
61
|
-
[Unreleased]: https://github.com/HQCuong/polaris-vue/compare/v0.
|
|
79
|
+
[Unreleased]: https://github.com/HQCuong/polaris-vue/compare/v0.3.0...HEAD
|
|
80
|
+
[0.3.0]: https://github.com/HQCuong/polaris-vue/compare/v0.2.0...v0.3.0
|
|
62
81
|
[0.2.0]: https://github.com/HQCuong/polaris-vue/compare/v0.1.0...v0.2.0
|
|
63
82
|
[0.1.0]: https://github.com/HQCuong/polaris-vue/releases/tag/v0.1.0
|
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ Typed Vue 3 wrapper components for [Shopify Polaris web components](https://shop
|
|
|
4
4
|
|
|
5
5
|
**📖 Documentation: [polaris-vue.vict0r.net](https://polaris-vue.vict0r.net/)** — guides, known quirks, and live examples for all 59 components.
|
|
6
6
|
|
|
7
|
-
The Polaris runtime itself is loaded from Shopify's CDN (the `polaris-
|
|
7
|
+
The Polaris runtime itself is loaded from Shopify's CDN (the `polaris-2.js` stable channel receives compatible updates automatically). This library gives you an idiomatic, fully typed Vue surface on top of it:
|
|
8
8
|
|
|
9
9
|
- **Typed props & events for all 59 components**, generated from Shopify's official Custom Elements Manifest (`@shopify/polaris-types`) — union-typed props like `variant`, autocomplete in templates, typed `@click`/`@aftershow` listeners.
|
|
10
10
|
- **`v-model` on 18 form components** (`STextField`, `SCheckbox`, `SSelect`, `SChoiceList`, …) with the correct property/event pair for each.
|
|
@@ -25,9 +25,11 @@ The wrappers are presentational only — your host app must load the Polaris run
|
|
|
25
25
|
|
|
26
26
|
```html
|
|
27
27
|
<!-- index.html -->
|
|
28
|
-
<script src="https://cdn.shopify.com/shopifycloud/polaris-
|
|
28
|
+
<script src="https://cdn.shopify.com/shopifycloud/polaris-2.js"></script>
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
+
`polaris-2.js` is Shopify's stable channel and brings the admin's new visual design. Apps still on `polaris-1.js` keep working — 2.0's component API is the same as 1.1 apart from a few additions. See [Polaris 2.0 and the new admin design](https://polaris-vue.vict0r.net/guide/getting-started#polaris-2-0-and-the-new-admin-design).
|
|
32
|
+
|
|
31
33
|
```ts
|
|
32
34
|
// vite.config.ts
|
|
33
35
|
vue({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/lib/generated/metadata.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE7D,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,aAAa,CAAA;IACtB,MAAM,EAAE,aAAa,CAAA;IACrB,OAAO,EAAE,aAAa,CAAA;IACtB,IAAI,EAAE,aAAa,CAAA;IACnB,OAAO,EAAE,aAAa,CAAA;IACtB,YAAY,EAAE,aAAa,CAAA;IAC3B,SAAS,EAAE,aAAa,CAAA;IACxB,KAAK,EAAE,aAAa,CAAA;IACpB,OAAO,EAAE,aAAa,CAAA;IACtB,WAAW,EAAE,aAAa,CAAA;IAC1B,UAAU,EAAE,aAAa,CAAA;IACzB,cAAc,EAAE,aAAa,CAAA;IAC7B,WAAW,EAAE,aAAa,CAAA;IAC1B,YAAY,EAAE,aAAa,CAAA;IAC3B,UAAU,EAAE,aAAa,CAAA;IACzB,WAAW,EAAE,aAAa,CAAA;IAC1B,QAAQ,EAAE,aAAa,CAAA;IACvB,SAAS,EAAE,aAAa,CAAA;IACxB,WAAW,EAAE,aAAa,CAAA;IAC1B,WAAW,EAAE,aAAa,CAAA;IAC1B,KAAK,EAAE,aAAa,CAAA;IACpB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,aAAa,CAAA;IACvB,KAAK,EAAE,aAAa,CAAA;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,KAAK,EAAE,aAAa,CAAA;IACpB,SAAS,EAAE,aAAa,CAAA;IACxB,KAAK,EAAE,aAAa,CAAA;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,WAAW,EAAE,aAAa,CAAA;IAC1B,OAAO,EAAE,aAAa,CAAA;IACtB,YAAY,EAAE,aAAa,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,YAAY,EAAE,aAAa,CAAA;IAC3B,YAAY,EAAE,aAAa,CAAA;IAC3B,KAAK,EAAE,aAAa,CAAA;IACpB,UAAU,EAAE,aAAa,CAAA;IACzB,cAAc,EAAE,aAAa,CAAA;IAC7B,QAAQ,EAAE,aAAa,CAAA;IACvB,YAAY,EAAE,aAAa,CAAA;IAC3B,SAAS,EAAE,aAAa,CAAA;IACxB,eAAe,EAAE,aAAa,CAAA;IAC9B,UAAU,EAAE,aAAa,CAAA;IACzB,YAAY,EAAE,aAAa,CAAA;IAC3B,QAAQ,EAAE,aAAa,CAAA;IACvB,OAAO,EAAE,aAAa,CAAA;IACtB,QAAQ,EAAE,aAAa,CAAA;IACvB,MAAM,EAAE,aAAa,CAAA;IACrB,OAAO,EAAE,aAAa,CAAA;IACtB,MAAM,EAAE,aAAa,CAAA;IACrB,UAAU,EAAE,aAAa,CAAA;IACzB,UAAU,EAAE,aAAa,CAAA;IACzB,YAAY,EAAE,aAAa,CAAA;IAC3B,eAAe,EAAE,aAAa,CAAA;IAC9B,SAAS,EAAE,aAAa,CAAA;IACxB,KAAK,EAAE,aAAa,CAAA;IACpB,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,EAAE,aAAa,CAAA;IACzB,UAAU,EAAE,aAAa,CAAA;IACzB,QAAQ,EAAE,aAAa,CAAA;IACvB,cAAc,EAAE,aAAa,CAAA;IAC7B,SAAS,EAAE,aAAa,CAAA;CACzB;AAED,eAAO,MAAM,QAAQ,EAAE,
|
|
1
|
+
{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/lib/generated/metadata.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE7D,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,aAAa,CAAA;IACtB,MAAM,EAAE,aAAa,CAAA;IACrB,OAAO,EAAE,aAAa,CAAA;IACtB,IAAI,EAAE,aAAa,CAAA;IACnB,OAAO,EAAE,aAAa,CAAA;IACtB,YAAY,EAAE,aAAa,CAAA;IAC3B,SAAS,EAAE,aAAa,CAAA;IACxB,KAAK,EAAE,aAAa,CAAA;IACpB,OAAO,EAAE,aAAa,CAAA;IACtB,WAAW,EAAE,aAAa,CAAA;IAC1B,UAAU,EAAE,aAAa,CAAA;IACzB,cAAc,EAAE,aAAa,CAAA;IAC7B,WAAW,EAAE,aAAa,CAAA;IAC1B,YAAY,EAAE,aAAa,CAAA;IAC3B,UAAU,EAAE,aAAa,CAAA;IACzB,WAAW,EAAE,aAAa,CAAA;IAC1B,QAAQ,EAAE,aAAa,CAAA;IACvB,SAAS,EAAE,aAAa,CAAA;IACxB,WAAW,EAAE,aAAa,CAAA;IAC1B,WAAW,EAAE,aAAa,CAAA;IAC1B,KAAK,EAAE,aAAa,CAAA;IACpB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,aAAa,CAAA;IACvB,KAAK,EAAE,aAAa,CAAA;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,KAAK,EAAE,aAAa,CAAA;IACpB,SAAS,EAAE,aAAa,CAAA;IACxB,KAAK,EAAE,aAAa,CAAA;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,WAAW,EAAE,aAAa,CAAA;IAC1B,OAAO,EAAE,aAAa,CAAA;IACtB,YAAY,EAAE,aAAa,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,YAAY,EAAE,aAAa,CAAA;IAC3B,YAAY,EAAE,aAAa,CAAA;IAC3B,KAAK,EAAE,aAAa,CAAA;IACpB,UAAU,EAAE,aAAa,CAAA;IACzB,cAAc,EAAE,aAAa,CAAA;IAC7B,QAAQ,EAAE,aAAa,CAAA;IACvB,YAAY,EAAE,aAAa,CAAA;IAC3B,SAAS,EAAE,aAAa,CAAA;IACxB,eAAe,EAAE,aAAa,CAAA;IAC9B,UAAU,EAAE,aAAa,CAAA;IACzB,YAAY,EAAE,aAAa,CAAA;IAC3B,QAAQ,EAAE,aAAa,CAAA;IACvB,OAAO,EAAE,aAAa,CAAA;IACtB,QAAQ,EAAE,aAAa,CAAA;IACvB,MAAM,EAAE,aAAa,CAAA;IACrB,OAAO,EAAE,aAAa,CAAA;IACtB,MAAM,EAAE,aAAa,CAAA;IACrB,UAAU,EAAE,aAAa,CAAA;IACzB,UAAU,EAAE,aAAa,CAAA;IACzB,YAAY,EAAE,aAAa,CAAA;IAC3B,eAAe,EAAE,aAAa,CAAA;IAC9B,SAAS,EAAE,aAAa,CAAA;IACxB,KAAK,EAAE,aAAa,CAAA;IACpB,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,EAAE,aAAa,CAAA;IACzB,UAAU,EAAE,aAAa,CAAA;IACzB,QAAQ,EAAE,aAAa,CAAA;IACvB,cAAc,EAAE,aAAa,CAAA;IAC7B,SAAS,EAAE,aAAa,CAAA;CACzB;AAED,eAAO,MAAM,QAAQ,EAAE,QAw/BtB,CAAA"}
|