polaris-vue-elements 0.2.0 → 0.4.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 +41 -1
- package/README.md +12 -8
- package/dist/generated/elements.d.ts +71 -0
- package/dist/generated/elements.d.ts.map +1 -0
- package/dist/generated/metadata.d.ts.map +1 -1
- package/dist/generated/types.d.ts +112 -111
- package/dist/generated/types.d.ts.map +1 -1
- package/dist/index.js +48 -46
- package/dist/index.js.map +1 -1
- package/dist/runtime/createWrapper.d.ts +14 -1
- package/dist/runtime/createWrapper.d.ts.map +1 -1
- package/package.json +18 -3
|
@@ -22,7 +22,7 @@ export interface ComponentMeta {
|
|
|
22
22
|
type UnknownRecord = Record<string, unknown>;
|
|
23
23
|
/**
|
|
24
24
|
* Derives `onX` event-listener props from an events shape `E` (e.g.
|
|
25
|
-
* `{ click:
|
|
25
|
+
* `{ click: MouseEvent }` -> `{ onClick?: (event: MouseEvent) => void }`), the way Vue's
|
|
26
26
|
* template compiler maps `@click` to an `onClick` prop.
|
|
27
27
|
*/
|
|
28
28
|
export type EventListenerProps<E> = {
|
|
@@ -50,6 +50,19 @@ export type WrapperComponent<P, E = UnknownRecord, El extends HTMLElement = HTML
|
|
|
50
50
|
$el: El;
|
|
51
51
|
};
|
|
52
52
|
};
|
|
53
|
+
/**
|
|
54
|
+
* The type of a raw `<s-*>` tag in a Vue template, used by the opt-in
|
|
55
|
+
* `polaris-vue-elements/elements` augmentation of Vue's `GlobalComponents`. Same props
|
|
56
|
+
* and event listeners as the wrapper, but no `modelValue`: `v-model` on a raw custom
|
|
57
|
+
* element doesn't go through the wrapper's property/event mapping, so only the wrapper
|
|
58
|
+
* components support it.
|
|
59
|
+
*/
|
|
60
|
+
export type PolarisElementTag<P, E = UnknownRecord, El extends HTMLElement = HTMLElement> = {
|
|
61
|
+
new (): {
|
|
62
|
+
$props: Partial<P> & EventListenerProps<E>;
|
|
63
|
+
$el: El;
|
|
64
|
+
};
|
|
65
|
+
};
|
|
53
66
|
/**
|
|
54
67
|
* Creates a Vue component that wraps a single Polaris custom element.
|
|
55
68
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createWrapper.d.ts","sourceRoot":"","sources":["../../src/lib/runtime/createWrapper.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAA;IACZ,+EAA+E;IAC/E,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,iBAAiB,EAAE,CAAA;IAC1B,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,KAAK,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE5C;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;KACjC,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;CACxE,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,EAAE,SAAS,WAAW,GAAG,WAAW,IAAI;IACzF,QAAQ;QACN,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG;YAAE,UAAU,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QACrE;;;;;WAKG;QACH,GAAG,EAAE,EAAE,CAAA;KACR,CAAA;CACF,CAAA;AASD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,CAAC,SAAS,MAAM,GAAG,aAAa,EAChC,CAAC,SAAS,MAAM,GAAG,aAAa,EAChC,EAAE,SAAS,WAAW,GAAG,WAAW,EACpC,IAAI,EAAE,aAAa,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CA8FjD"}
|
|
1
|
+
{"version":3,"file":"createWrapper.d.ts","sourceRoot":"","sources":["../../src/lib/runtime/createWrapper.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAA;IACZ,+EAA+E;IAC/E,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,iBAAiB,EAAE,CAAA;IAC1B,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,KAAK,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE5C;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;KACjC,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;CACxE,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,EAAE,SAAS,WAAW,GAAG,WAAW,IAAI;IACzF,QAAQ;QACN,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG;YAAE,UAAU,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QACrE;;;;;WAKG;QACH,GAAG,EAAE,EAAE,CAAA;KACR,CAAA;CACF,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,EAAE,SAAS,WAAW,GAAG,WAAW,IAAI;IAC1F,QAAQ;QACN,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;QAC1C,GAAG,EAAE,EAAE,CAAA;KACR,CAAA;CACF,CAAA;AASD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,CAAC,SAAS,MAAM,GAAG,aAAa,EAChC,CAAC,SAAS,MAAM,GAAG,aAAa,EAChC,EAAE,SAAS,WAAW,GAAG,WAAW,EACpC,IAAI,EAAE,aAAa,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CA8FjD"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "polaris-vue-elements",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Typed Vue 3 wrapper components for Shopify Polaris web components.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://polaris-vue.vict0r.net",
|
|
@@ -23,6 +23,9 @@
|
|
|
23
23
|
".": {
|
|
24
24
|
"types": "./dist/index.d.ts",
|
|
25
25
|
"import": "./dist/index.js"
|
|
26
|
+
},
|
|
27
|
+
"./elements": {
|
|
28
|
+
"types": "./dist/generated/elements.d.ts"
|
|
26
29
|
}
|
|
27
30
|
},
|
|
28
31
|
"files": [
|
|
@@ -58,7 +61,7 @@
|
|
|
58
61
|
"vue": "^3.5.0"
|
|
59
62
|
},
|
|
60
63
|
"devDependencies": {
|
|
61
|
-
"@shopify/polaris-types": "^
|
|
64
|
+
"@shopify/polaris-types": "^2.0.0",
|
|
62
65
|
"@tsconfig/node24": "^24.0.4",
|
|
63
66
|
"@types/jsdom": "^28.0.3",
|
|
64
67
|
"@types/node": "^24.13.3",
|
|
@@ -74,7 +77,7 @@
|
|
|
74
77
|
"jiti": "^2.7.0",
|
|
75
78
|
"jsdom": "^29.1.1",
|
|
76
79
|
"npm-run-all2": "^9.0.2",
|
|
77
|
-
"oxfmt": "^0.
|
|
80
|
+
"oxfmt": "^0.75.0",
|
|
78
81
|
"oxlint": "~1.79.0",
|
|
79
82
|
"simple-git-hooks": "^2.13.1",
|
|
80
83
|
"typescript": "~6.0.0",
|
|
@@ -88,5 +91,17 @@
|
|
|
88
91
|
},
|
|
89
92
|
"engines": {
|
|
90
93
|
"node": "^22.18.0 || >=24.12.0"
|
|
94
|
+
},
|
|
95
|
+
"devEngines": {
|
|
96
|
+
"runtime": {
|
|
97
|
+
"name": "node",
|
|
98
|
+
"version": "^22.23.4 || ^24.22.1 || >=26.12.1",
|
|
99
|
+
"onFail": "error"
|
|
100
|
+
}
|
|
101
|
+
},
|
|
102
|
+
"overrides": {
|
|
103
|
+
"vitepress": {
|
|
104
|
+
"vite": "^6.4.5"
|
|
105
|
+
}
|
|
91
106
|
}
|
|
92
107
|
}
|