polaris-vue-elements 0.4.1 → 0.4.2
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 +14 -2
- package/README.md +4 -4
- package/package.json +15 -9
package/CHANGELOG.md
CHANGED
|
@@ -6,11 +6,22 @@ All notable changes to `polaris-vue-elements` are documented here. The format is
|
|
|
6
6
|
minor releases may include breaking changes, which are always called out below.
|
|
7
7
|
|
|
8
8
|
Wrapper and type changes follow `@shopify/polaris-types`, whose major version matches the
|
|
9
|
-
[Polaris CDN](https://polaris-vue.
|
|
9
|
+
[Polaris CDN](https://polaris-vue-elements.dev/guide/quirks)
|
|
10
10
|
major your app loads (`polaris-1.js`, `polaris-2.js`, …).
|
|
11
11
|
|
|
12
12
|
## [Unreleased]
|
|
13
13
|
|
|
14
|
+
## [0.4.2] - 2026-10-30
|
|
15
|
+
|
|
16
|
+
Still generated from `@shopify/polaris-types` 2.0.0. No changes to the components.
|
|
17
|
+
|
|
18
|
+
### Changed
|
|
19
|
+
|
|
20
|
+
- The docs moved to [polaris-vue-elements.dev](https://polaris-vue-elements.dev). The old
|
|
21
|
+
`polaris-vue.vict0r.net` links redirect there. The package `homepage` now points to the new
|
|
22
|
+
domain, and the npm description and keywords mention Shopify apps.
|
|
23
|
+
- New guide: [Build a Shopify embedded app with Vue 3](https://polaris-vue-elements.dev/guide/shopify-embedded-app).
|
|
24
|
+
|
|
14
25
|
## [0.4.1] - 2026-10-29
|
|
15
26
|
|
|
16
27
|
Still generated from `@shopify/polaris-types` 2.0.0.
|
|
@@ -107,7 +118,8 @@ Initial release: typed Vue 3 wrappers for the 59 Shopify Polaris web components
|
|
|
107
118
|
`showOverlay()` / `hideOverlay()` / `toggleOverlay()`).
|
|
108
119
|
- ESM build with bundled type declarations; `vue` ^3.5 as a peer dependency.
|
|
109
120
|
|
|
110
|
-
[Unreleased]: https://github.com/HQCuong/polaris-vue/compare/v0.4.
|
|
121
|
+
[Unreleased]: https://github.com/HQCuong/polaris-vue/compare/v0.4.2...HEAD
|
|
122
|
+
[0.4.2]: https://github.com/HQCuong/polaris-vue/compare/v0.4.1...v0.4.2
|
|
111
123
|
[0.4.1]: https://github.com/HQCuong/polaris-vue/compare/v0.4.0...v0.4.1
|
|
112
124
|
[0.4.0]: https://github.com/HQCuong/polaris-vue/compare/v0.3.0...v0.4.0
|
|
113
125
|
[0.3.0]: https://github.com/HQCuong/polaris-vue/compare/v0.2.0...v0.3.0
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Typed Vue 3 wrapper components for [Shopify Polaris web components](https://shopify.dev/docs/api/app-home/web-components) — the `s-*` custom elements used to build Shopify App Home (embedded admin) apps.
|
|
4
4
|
|
|
5
|
-
**📖 Documentation: [polaris-vue.
|
|
5
|
+
**📖 Documentation: [polaris-vue-elements.dev](https://polaris-vue-elements.dev/)** — guides, known quirks, and live examples for all 62 components.
|
|
6
6
|
|
|
7
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
|
|
|
@@ -28,7 +28,7 @@ The wrappers are presentational only — your host app must load the Polaris run
|
|
|
28
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.
|
|
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-elements.dev/guide/getting-started#polaris-2-0-and-the-new-admin-design).
|
|
32
32
|
|
|
33
33
|
```ts
|
|
34
34
|
// vite.config.ts
|
|
@@ -57,9 +57,9 @@ const name = ref('')
|
|
|
57
57
|
</template>
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Prefer writing Polaris's own `<s-button>` tags? Add `"types": ["polaris-vue-elements/elements"]` to your `tsconfig.json` and Volar / `vue-tsc` type-check raw `<s-*>` tags too (types only; `v-model` stays wrapper-only). See [Typing raw `<s-*>` tags](https://polaris-vue.
|
|
60
|
+
Prefer writing Polaris's own `<s-button>` tags? Add `"types": ["polaris-vue-elements/elements"]` to your `tsconfig.json` and Volar / `vue-tsc` type-check raw `<s-*>` tags too (types only; `v-model` stays wrapper-only). See [Typing raw `<s-*>` tags](https://polaris-vue-elements.dev/guide/getting-started#_7-typing-raw-s-tags-optional).
|
|
61
61
|
|
|
62
|
-
Full documentation — guides, known quirks, and generated reference pages with live examples for all 62 components — is at **[polaris-vue.
|
|
62
|
+
Full documentation — guides, known quirks, and generated reference pages with live examples for all 62 components — is at **[polaris-vue-elements.dev](https://polaris-vue-elements.dev/)** (source in `docs/`, `npm run docs:dev` to run locally). Building a Shopify app? Start with the [embedded app guide](https://polaris-vue-elements.dev/guide/shopify-embedded-app).
|
|
63
63
|
|
|
64
64
|
## Architecture
|
|
65
65
|
|
package/package.json
CHANGED
|
@@ -1,18 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "polaris-vue-elements",
|
|
3
|
-
"version": "0.4.
|
|
4
|
-
"description": "Typed Vue 3
|
|
3
|
+
"version": "0.4.2",
|
|
4
|
+
"description": "Typed Vue 3 components for Shopify Polaris web components — build Shopify app UIs (App Home) in Vue with props, events and v-model.",
|
|
5
5
|
"license": "MIT",
|
|
6
|
-
"homepage": "https://polaris-vue.
|
|
6
|
+
"homepage": "https://polaris-vue-elements.dev",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
9
|
"url": "git+https://github.com/HQCuong/polaris-vue.git"
|
|
10
10
|
},
|
|
11
11
|
"keywords": [
|
|
12
12
|
"shopify",
|
|
13
|
+
"shopify-app",
|
|
14
|
+
"shopify-polaris",
|
|
13
15
|
"polaris",
|
|
16
|
+
"app-home",
|
|
14
17
|
"web-components",
|
|
18
|
+
"custom-elements",
|
|
15
19
|
"vue",
|
|
20
|
+
"vue3",
|
|
21
|
+
"typescript",
|
|
16
22
|
"wrapper"
|
|
17
23
|
],
|
|
18
24
|
"type": "module",
|
|
@@ -63,7 +69,7 @@
|
|
|
63
69
|
"devDependencies": {
|
|
64
70
|
"@shopify/polaris-types": "^2.0.0",
|
|
65
71
|
"@tsconfig/node24": "^24.0.4",
|
|
66
|
-
"@types/jsdom": "^
|
|
72
|
+
"@types/jsdom": "^30.0.0",
|
|
67
73
|
"@types/node": "^24.13.3",
|
|
68
74
|
"@vitejs/plugin-vue": "^6.0.8",
|
|
69
75
|
"@vitest/eslint-plugin": "^1.6.23",
|
|
@@ -72,19 +78,19 @@
|
|
|
72
78
|
"@vue/tsconfig": "^0.9.1",
|
|
73
79
|
"eslint": "^10.7.0",
|
|
74
80
|
"eslint-config-prettier": "^10.1.8",
|
|
75
|
-
"eslint-plugin-oxlint": "~1.
|
|
76
|
-
"eslint-plugin-vue": "~10.
|
|
81
|
+
"eslint-plugin-oxlint": "~1.89.0",
|
|
82
|
+
"eslint-plugin-vue": "~10.12.0",
|
|
77
83
|
"jiti": "^2.7.0",
|
|
78
|
-
"jsdom": "^
|
|
84
|
+
"jsdom": "^30.1.3",
|
|
79
85
|
"npm-run-all2": "^9.0.2",
|
|
80
86
|
"oxfmt": "^0.75.0",
|
|
81
|
-
"oxlint": "~1.
|
|
87
|
+
"oxlint": "~1.89.0",
|
|
82
88
|
"simple-git-hooks": "^2.13.1",
|
|
83
89
|
"typescript": "~6.0.0",
|
|
84
90
|
"vite": "^8.1.5",
|
|
85
91
|
"vite-plugin-vue-devtools": "^8.1.5",
|
|
86
92
|
"vitepress": "^1.6.4",
|
|
87
|
-
"vitest": "^
|
|
93
|
+
"vitest": "^5.0.5",
|
|
88
94
|
"vue": "^3.5.40",
|
|
89
95
|
"vue-eslint-parser": "^10.4.1",
|
|
90
96
|
"vue-tsc": "^3.3.7"
|