@scalar/use-hooks 0.2.4 → 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/dist/useBindCx/index.d.ts +1 -1
- package/dist/useBindCx/index.d.ts.map +1 -1
- package/dist/useBindCx/index.js +1 -1
- package/dist/useBindCx/index.js.map +2 -2
- package/dist/useBindCx/useBindCx.d.ts +51 -5
- package/dist/useBindCx/useBindCx.d.ts.map +1 -1
- package/dist/useBindCx/useBindCx.js +53 -8
- package/dist/useBindCx/useBindCx.js.map +2 -2
- package/dist/useBreakpoints/useBreakpoints.d.ts.map +1 -1
- package/dist/useBreakpoints/useBreakpoints.js +9 -4
- package/dist/useBreakpoints/useBreakpoints.js.map +2 -2
- package/dist/useColorMode/index.d.ts +1 -2
- package/dist/useColorMode/index.d.ts.map +1 -1
- package/dist/useColorMode/index.js +4 -2
- package/dist/useColorMode/index.js.map +2 -2
- package/dist/useColorMode/useColorMode.d.ts +11 -2
- package/dist/useColorMode/useColorMode.d.ts.map +1 -1
- package/dist/useColorMode/useColorMode.js +7 -6
- package/dist/useColorMode/useColorMode.js.map +2 -2
- package/package.json +9 -10
- package/dist/useColorMode/types.d.ts +0 -12
- package/dist/useColorMode/types.d.ts.map +0 -1
- package/dist/useColorMode/types.js +0 -1
- package/dist/useColorMode/types.js.map +0 -7
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useBindCx/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useBindCx/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,OAAO,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA"}
|
package/dist/useBindCx/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/useBindCx/index.ts"],
|
|
4
|
-
"sourcesContent": ["export {
|
|
5
|
-
"mappings": "AAAA,SAAS,
|
|
4
|
+
"sourcesContent": ["export { compose, cva, cx, tw } from './cva'\nexport { useBindCx } from './useBindCx'\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,SAAS,KAAK,IAAI,UAAU;AACrC,SAAS,iBAAiB;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { CXOptions } from 'cva';
|
|
2
|
+
import { type StyleValue } from 'vue';
|
|
2
3
|
/**
|
|
3
4
|
* Provides a wrapper around the `cx` function that merges the
|
|
4
5
|
* component's class attribute with the provided classes and binds the
|
|
@@ -33,6 +34,7 @@ export declare function useBindCx(): {
|
|
|
33
34
|
* remaining attributes
|
|
34
35
|
*
|
|
35
36
|
* @example
|
|
37
|
+
* ```html
|
|
36
38
|
* <script setup>
|
|
37
39
|
* ...
|
|
38
40
|
* const { cx } = useBindCx()
|
|
@@ -40,6 +42,7 @@ export declare function useBindCx(): {
|
|
|
40
42
|
* <template>
|
|
41
43
|
* <div v-bind="cx(...)">...</div>
|
|
42
44
|
* </template>
|
|
45
|
+
* ```
|
|
43
46
|
*/
|
|
44
47
|
cx: (...args: CXOptions) => {
|
|
45
48
|
/** The merged class attribute */
|
|
@@ -49,16 +52,59 @@ export declare function useBindCx(): {
|
|
|
49
52
|
};
|
|
50
53
|
/**
|
|
51
54
|
* Provides a wrapper around the `cx` function that merges the
|
|
52
|
-
* component's class attribute with the provided classes and
|
|
53
|
-
* not** bind
|
|
55
|
+
* component's class attribute with the provided classes and binds the
|
|
56
|
+
* style attribute but **does not** bind any other attributes.
|
|
57
|
+
*
|
|
58
|
+
* Typically used in conjunction with `otherAttrs` to apply the stylistic
|
|
59
|
+
* attributes to a styled wrapper element, but apply the remaining
|
|
60
|
+
* attributes to an internal semantic element like an `<input>`.
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```html
|
|
64
|
+
* <script setup>
|
|
65
|
+
* ...
|
|
66
|
+
* const { stylingAttrsCx, otherAttrs } = useBindCx()
|
|
67
|
+
* </script>
|
|
68
|
+
* <template>
|
|
69
|
+
* <!-- Bind the class and style attributes to a wrapper element -->
|
|
70
|
+
* <div v-bind="stylingAttrsCx(...)">
|
|
71
|
+
* ...
|
|
72
|
+
* <!-- Bind the other attributes to a semantic internal element -->
|
|
73
|
+
* <input v-bind="otherAttrs" />
|
|
74
|
+
* </div>
|
|
75
|
+
* </template>
|
|
76
|
+
* ```
|
|
54
77
|
*/
|
|
55
|
-
|
|
78
|
+
stylingAttrsCx: (...args: CXOptions) => {
|
|
56
79
|
/** The merged class attribute */
|
|
57
80
|
class: string;
|
|
81
|
+
style: StyleValue;
|
|
58
82
|
};
|
|
59
|
-
/**
|
|
83
|
+
/**
|
|
84
|
+
* The remaining attributes that **are not** the class or style attributes
|
|
85
|
+
* of the component.
|
|
86
|
+
*
|
|
87
|
+
* Typically used in conjunction with `stylingAttrsCx` to apply the stylistic
|
|
88
|
+
* attributes to a styled wrapper element, but apply the remaining
|
|
89
|
+
* attributes to an internal semantic element like an `<input>`.
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```html
|
|
93
|
+
* <script setup>
|
|
94
|
+
* ...
|
|
95
|
+
* const { stylingAttrsCx, otherAttrs } = useBindCx()
|
|
96
|
+
* </script>
|
|
97
|
+
* <template>
|
|
98
|
+
* <!-- Bind the class and style attributes to a wrapper element -->
|
|
99
|
+
* <div v-bind="stylingAttrsCx(...)">
|
|
100
|
+
* ...
|
|
101
|
+
* <!-- Bind the other attributes to a semantic internal element -->
|
|
102
|
+
* <input v-bind="otherAttrs" />
|
|
103
|
+
* </div>
|
|
104
|
+
* </template>
|
|
105
|
+
*/
|
|
60
106
|
otherAttrs: import("vue").ComputedRef<{
|
|
61
|
-
[
|
|
107
|
+
[key: string]: unknown;
|
|
62
108
|
}>;
|
|
63
109
|
};
|
|
64
110
|
//# sourceMappingURL=useBindCx.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useBindCx.d.ts","sourceRoot":"","sources":["../../src/useBindCx/useBindCx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;
|
|
1
|
+
{"version":3,"file":"useBindCx.d.ts","sourceRoot":"","sources":["../../src/useBindCx/useBindCx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AACpC,OAAO,EAAE,KAAK,UAAU,EAAsB,MAAM,KAAK,CAAA;AAOzD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,SAAS;IAkCrB;;;;;;;;;;;;;;;OAeG;kBArCoB,SAAS,KAAG;QACnC,iCAAiC;QACjC,KAAK,EAAE,MAAM,CAAA;QACb,+BAA+B;QAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB;IAkCC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;8BAlD+B,SAAS,KAAG;QAC9C,iCAAiC;QACjC,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,UAAU,CAAA;KAClB;IAgDC;;;;;;;;;;;;;;;;;;;;;;OAsBG;;;;EAGN"}
|
|
@@ -3,17 +3,18 @@ import { cx } from "./cva.js";
|
|
|
3
3
|
function useBindCx() {
|
|
4
4
|
const attrs = useAttrs();
|
|
5
5
|
const destructured = computed(() => {
|
|
6
|
-
const { class: className, ...rest } = attrs;
|
|
7
|
-
return { class: className || "", rest };
|
|
6
|
+
const { class: className, style, ...rest } = attrs;
|
|
7
|
+
return { class: className || "", style, rest };
|
|
8
8
|
});
|
|
9
9
|
function bindCx(...args) {
|
|
10
10
|
return {
|
|
11
11
|
class: cx(...args, destructured.value.class),
|
|
12
|
+
style: destructured.value.style,
|
|
12
13
|
...destructured.value.rest
|
|
13
14
|
};
|
|
14
15
|
}
|
|
15
|
-
function
|
|
16
|
-
return { class: cx(...args, destructured.value.class) };
|
|
16
|
+
function bindClassAndStyle(...args) {
|
|
17
|
+
return { class: cx(...args, destructured.value.class), style: destructured.value.style };
|
|
17
18
|
}
|
|
18
19
|
return {
|
|
19
20
|
/**
|
|
@@ -22,6 +23,7 @@ function useBindCx() {
|
|
|
22
23
|
* remaining attributes
|
|
23
24
|
*
|
|
24
25
|
* @example
|
|
26
|
+
* ```html
|
|
25
27
|
* <script setup>
|
|
26
28
|
* ...
|
|
27
29
|
* const { cx } = useBindCx()
|
|
@@ -29,15 +31,58 @@ function useBindCx() {
|
|
|
29
31
|
* <template>
|
|
30
32
|
* <div v-bind="cx(...)">...</div>
|
|
31
33
|
* </template>
|
|
34
|
+
* ```
|
|
32
35
|
*/
|
|
33
36
|
cx: bindCx,
|
|
34
37
|
/**
|
|
35
38
|
* Provides a wrapper around the `cx` function that merges the
|
|
36
|
-
* component's class attribute with the provided classes and
|
|
37
|
-
* not** bind
|
|
39
|
+
* component's class attribute with the provided classes and binds the
|
|
40
|
+
* style attribute but **does not** bind any other attributes.
|
|
41
|
+
*
|
|
42
|
+
* Typically used in conjunction with `otherAttrs` to apply the stylistic
|
|
43
|
+
* attributes to a styled wrapper element, but apply the remaining
|
|
44
|
+
* attributes to an internal semantic element like an `<input>`.
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```html
|
|
48
|
+
* <script setup>
|
|
49
|
+
* ...
|
|
50
|
+
* const { stylingAttrsCx, otherAttrs } = useBindCx()
|
|
51
|
+
* <\/script>
|
|
52
|
+
* <template>
|
|
53
|
+
* <!-- Bind the class and style attributes to a wrapper element -->
|
|
54
|
+
* <div v-bind="stylingAttrsCx(...)">
|
|
55
|
+
* ...
|
|
56
|
+
* <!-- Bind the other attributes to a semantic internal element -->
|
|
57
|
+
* <input v-bind="otherAttrs" />
|
|
58
|
+
* </div>
|
|
59
|
+
* </template>
|
|
60
|
+
* ```
|
|
61
|
+
*/
|
|
62
|
+
stylingAttrsCx: bindClassAndStyle,
|
|
63
|
+
/**
|
|
64
|
+
* The remaining attributes that **are not** the class or style attributes
|
|
65
|
+
* of the component.
|
|
66
|
+
*
|
|
67
|
+
* Typically used in conjunction with `stylingAttrsCx` to apply the stylistic
|
|
68
|
+
* attributes to a styled wrapper element, but apply the remaining
|
|
69
|
+
* attributes to an internal semantic element like an `<input>`.
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```html
|
|
73
|
+
* <script setup>
|
|
74
|
+
* ...
|
|
75
|
+
* const { stylingAttrsCx, otherAttrs } = useBindCx()
|
|
76
|
+
* <\/script>
|
|
77
|
+
* <template>
|
|
78
|
+
* <!-- Bind the class and style attributes to a wrapper element -->
|
|
79
|
+
* <div v-bind="stylingAttrsCx(...)">
|
|
80
|
+
* ...
|
|
81
|
+
* <!-- Bind the other attributes to a semantic internal element -->
|
|
82
|
+
* <input v-bind="otherAttrs" />
|
|
83
|
+
* </div>
|
|
84
|
+
* </template>
|
|
38
85
|
*/
|
|
39
|
-
classCx: bindClass,
|
|
40
|
-
/** The remaining attributes that are not class attributes */
|
|
41
86
|
otherAttrs: computed(() => destructured.value.rest)
|
|
42
87
|
};
|
|
43
88
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/useBindCx/useBindCx.ts"],
|
|
4
|
-
"sourcesContent": ["import type { CXOptions } from 'cva'\nimport { computed, useAttrs } from 'vue'\n\nimport { cx } from './cva'\n\n/**\n * Provides a wrapper around the `cx` function that merges the\n * component's class attribute with the provided classes and binds the\n * remaining attributes\n *\n * @see https://beta.cva.style/api-reference#cx\n *\n * @example\n * <script setup>\n * import { useBindCx, cva } from '@scalar/components'\n *\n * defineProps<{ active?: boolean }>()\n *\n * // Important: disable inheritance of attributes\n * defineOptions({ inheritAttrs: false })\n *\n * const { cx } = useBindCx()\n *\n * const variants = cva({\n * base: 'border rounded p-2 bg-b-1',\n * variants: { active: { true: 'bg-b-2' } },\n * })\n * </script>\n * <template>\n * <div v-bind=\"cx(variants({ active }))\">MockComponent</div>\n * </template>\n */\nexport function useBindCx() {\n const attrs = useAttrs()\n\n const destructured = computed(() => {\n const { class: className, ...rest } = attrs\n return { class: className || '', rest }\n })\n\n function bindCx(...args: CXOptions): {\n /** The merged class attribute */\n class: string\n /** The remaining attributes */\n [key: string]: any\n } {\n return {\n class: cx(...args, destructured.value.class),\n ...destructured.value.rest,\n }\n }\n\n function
|
|
5
|
-
"mappings": "AACA,
|
|
4
|
+
"sourcesContent": ["import type { CXOptions } from 'cva'\nimport { type StyleValue, computed, useAttrs } from 'vue'\n\nimport { cx } from './cva'\n\n/** Utility type for class names */\ntype ClassValue = CXOptions[number]\n\n/**\n * Provides a wrapper around the `cx` function that merges the\n * component's class attribute with the provided classes and binds the\n * remaining attributes\n *\n * @see https://beta.cva.style/api-reference#cx\n *\n * @example\n * <script setup>\n * import { useBindCx, cva } from '@scalar/components'\n *\n * defineProps<{ active?: boolean }>()\n *\n * // Important: disable inheritance of attributes\n * defineOptions({ inheritAttrs: false })\n *\n * const { cx } = useBindCx()\n *\n * const variants = cva({\n * base: 'border rounded p-2 bg-b-1',\n * variants: { active: { true: 'bg-b-2' } },\n * })\n * </script>\n * <template>\n * <div v-bind=\"cx(variants({ active }))\">MockComponent</div>\n * </template>\n */\nexport function useBindCx() {\n const attrs = useAttrs()\n\n const destructured = computed<{\n class: ClassValue\n style: StyleValue\n rest: { [key: string]: unknown }\n }>(() => {\n const { class: className, style, ...rest } = attrs\n return { class: className || '', style: style as StyleValue, rest }\n })\n\n function bindCx(...args: CXOptions): {\n /** The merged class attribute */\n class: string\n /** The remaining attributes */\n [key: string]: any\n } {\n return {\n class: cx(...args, destructured.value.class),\n style: destructured.value.style,\n ...destructured.value.rest,\n }\n }\n\n function bindClassAndStyle(...args: CXOptions): {\n /** The merged class attribute */\n class: string\n style: StyleValue\n } {\n return { class: cx(...args, destructured.value.class), style: destructured.value.style }\n }\n\n return {\n /**\n * Provides a wrapper around the `cx` function that merges the\n * component's class attribute with the provided classes and binds the\n * remaining attributes\n *\n * @example\n * ```html\n * <script setup>\n * ...\n * const { cx } = useBindCx()\n * </script>\n * <template>\n * <div v-bind=\"cx(...)\">...</div>\n * </template>\n * ```\n */\n cx: bindCx,\n /**\n * Provides a wrapper around the `cx` function that merges the\n * component's class attribute with the provided classes and binds the\n * style attribute but **does not** bind any other attributes.\n *\n * Typically used in conjunction with `otherAttrs` to apply the stylistic\n * attributes to a styled wrapper element, but apply the remaining\n * attributes to an internal semantic element like an `<input>`.\n *\n * @example\n * ```html\n * <script setup>\n * ...\n * const { stylingAttrsCx, otherAttrs } = useBindCx()\n * </script>\n * <template>\n * <!-- Bind the class and style attributes to a wrapper element -->\n * <div v-bind=\"stylingAttrsCx(...)\">\n * ...\n * <!-- Bind the other attributes to a semantic internal element -->\n * <input v-bind=\"otherAttrs\" />\n * </div>\n * </template>\n * ```\n */\n stylingAttrsCx: bindClassAndStyle,\n /**\n * The remaining attributes that **are not** the class or style attributes\n * of the component.\n *\n * Typically used in conjunction with `stylingAttrsCx` to apply the stylistic\n * attributes to a styled wrapper element, but apply the remaining\n * attributes to an internal semantic element like an `<input>`.\n *\n * @example\n * ```html\n * <script setup>\n * ...\n * const { stylingAttrsCx, otherAttrs } = useBindCx()\n * </script>\n * <template>\n * <!-- Bind the class and style attributes to a wrapper element -->\n * <div v-bind=\"stylingAttrsCx(...)\">\n * ...\n * <!-- Bind the other attributes to a semantic internal element -->\n * <input v-bind=\"otherAttrs\" />\n * </div>\n * </template>\n */\n otherAttrs: computed(() => destructured.value.rest),\n }\n}\n"],
|
|
5
|
+
"mappings": "AACA,SAA0B,UAAU,gBAAgB;AAEpD,SAAS,UAAU;AAgCZ,SAAS,YAAY;AAC1B,QAAM,QAAQ,SAAS;AAEvB,QAAM,eAAe,SAIlB,MAAM;AACP,UAAM,EAAE,OAAO,WAAW,OAAO,GAAG,KAAK,IAAI;AAC7C,WAAO,EAAE,OAAO,aAAa,IAAI,OAA4B,KAAK;AAAA,EACpE,CAAC;AAED,WAAS,UAAU,MAKjB;AACA,WAAO;AAAA,MACL,OAAO,GAAG,GAAG,MAAM,aAAa,MAAM,KAAK;AAAA,MAC3C,OAAO,aAAa,MAAM;AAAA,MAC1B,GAAG,aAAa,MAAM;AAAA,IACxB;AAAA,EACF;AAEA,WAAS,qBAAqB,MAI5B;AACA,WAAO,EAAE,OAAO,GAAG,GAAG,MAAM,aAAa,MAAM,KAAK,GAAG,OAAO,aAAa,MAAM,MAAM;AAAA,EACzF;AAEA,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAiBL,IAAI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IA0BJ,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAwBhB,YAAY,SAAS,MAAM,aAAa,MAAM,IAAI;AAAA,EACpD;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useBreakpoints.d.ts","sourceRoot":"","sources":["../../src/useBreakpoints/useBreakpoints.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"useBreakpoints.d.ts","sourceRoot":"","sources":["../../src/useBreakpoints/useBreakpoints.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,GAAG,EAAmB,MAAM,KAAK,CAAA;AAM/C;;;;GAIG;AACH,wBAAgB,cAAc;IAmB1B,6CAA6C;;;;;;;;;IAE7C,0DAA0D;;IAE1D,gDAAgD;;EAGnD"}
|
|
@@ -1,10 +1,15 @@
|
|
|
1
|
-
import { screens } from "./constants.js";
|
|
2
1
|
import { useMediaQuery } from "@vueuse/core";
|
|
3
2
|
import { computed, unref } from "vue";
|
|
3
|
+
import { screens } from "./constants.js";
|
|
4
4
|
function useBreakpoints() {
|
|
5
|
-
const mediaQueries =
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
const mediaQueries = {
|
|
6
|
+
xs: useMediaQuery(screens.xs),
|
|
7
|
+
sm: useMediaQuery(screens.sm),
|
|
8
|
+
md: useMediaQuery(screens.md),
|
|
9
|
+
lg: useMediaQuery(screens.lg),
|
|
10
|
+
xl: useMediaQuery(screens.xl),
|
|
11
|
+
zoomed: useMediaQuery(screens.zoomed)
|
|
12
|
+
};
|
|
8
13
|
const breakpoints = computed(
|
|
9
14
|
() => Object.fromEntries(
|
|
10
15
|
Object.entries(mediaQueries).map(([breakpoint, queryRef]) => [breakpoint, unref(queryRef)])
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/useBreakpoints/useBreakpoints.ts"],
|
|
4
|
-
"sourcesContent": ["import {
|
|
5
|
-
"mappings": "AAAA,SAAS,
|
|
4
|
+
"sourcesContent": ["import { useMediaQuery } from '@vueuse/core'\nimport { type Ref, computed, unref } from 'vue'\n\nimport { screens } from './constants'\n\ntype Screen = keyof typeof screens\n\n/**\n * Exposes Tailwind CSS breakpoints as reactive media queries\n *\n * **Warning:** This hook is not a replacement for Tailwind CSS breakpoints. Using breakpoints in Javascript can cause issues with Server Side Rendering (SSR) and the Tailwind CSS breakpoints should be used when possible.\n */\nexport function useBreakpoints() {\n const mediaQueries: Record<Screen, Ref<boolean>> = {\n xs: useMediaQuery(screens.xs),\n sm: useMediaQuery(screens.sm),\n md: useMediaQuery(screens.md),\n lg: useMediaQuery(screens.lg),\n xl: useMediaQuery(screens.xl),\n zoomed: useMediaQuery(screens.zoomed),\n }\n\n // We make the breakpoints a computed object so that we can use them in templates as `breakpoints.x` instead of `breakpoints.x.value`\n const breakpoints = computed(\n () =>\n Object.fromEntries(\n Object.entries(mediaQueries).map(([breakpoint, queryRef]) => [breakpoint, unref(queryRef)]),\n ) as Record<Screen, boolean>,\n )\n\n return {\n /** The screen sizes defined in the preset */\n screens,\n /** Reactive media queries for each of the screen sizes */\n mediaQueries,\n /** The breakpoints as reactive media queries */\n breakpoints,\n }\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,qBAAqB;AAC9B,SAAmB,UAAU,aAAa;AAE1C,SAAS,eAAe;AASjB,SAAS,iBAAiB;AAC/B,QAAM,eAA6C;AAAA,IACjD,IAAI,cAAc,QAAQ,EAAE;AAAA,IAC5B,IAAI,cAAc,QAAQ,EAAE;AAAA,IAC5B,IAAI,cAAc,QAAQ,EAAE;AAAA,IAC5B,IAAI,cAAc,QAAQ,EAAE;AAAA,IAC5B,IAAI,cAAc,QAAQ,EAAE;AAAA,IAC5B,QAAQ,cAAc,QAAQ,MAAM;AAAA,EACtC;AAGA,QAAM,cAAc;AAAA,IAClB,MACE,OAAO;AAAA,MACL,OAAO,QAAQ,YAAY,EAAE,IAAI,CAAC,CAAC,YAAY,QAAQ,MAAM,CAAC,YAAY,MAAM,QAAQ,CAAC,CAAC;AAAA,IAC5F;AAAA,EACJ;AAEA,SAAO;AAAA;AAAA,IAEL;AAAA;AAAA,IAEA;AAAA;AAAA,IAEA;AAAA,EACF;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useColorMode/index.ts"],"names":[],"mappings":"AAAA,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useColorMode/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/useColorMode/index.ts"],
|
|
4
|
-
"sourcesContent": ["export
|
|
5
|
-
"mappings": "AAAA,
|
|
4
|
+
"sourcesContent": ["export { useColorMode } from './useColorMode'\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,oBAAoB;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,8 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
/** Possible color modes */
|
|
2
|
+
type ColorMode = 'light' | 'dark' | 'system';
|
|
3
|
+
/** Specific dark/light mode */
|
|
4
|
+
type DarkLightMode = 'light' | 'dark';
|
|
2
5
|
/**
|
|
3
6
|
* A composable hook that provides color mode (dark/light) functionality.
|
|
4
7
|
*/
|
|
5
|
-
export declare function useColorMode(opts?:
|
|
8
|
+
export declare function useColorMode(opts?: {
|
|
9
|
+
/** The initial color mode to use */
|
|
10
|
+
initialColorMode?: ColorMode;
|
|
11
|
+
/** Override the color mode */
|
|
12
|
+
overrideColorMode?: ColorMode;
|
|
13
|
+
}): {
|
|
6
14
|
/** The current color mode (writable). */
|
|
7
15
|
colorMode: import("vue").WritableComputedRef<ColorMode, ColorMode>;
|
|
8
16
|
/** The computed dark/light mode (writable). */
|
|
@@ -16,4 +24,5 @@ export declare function useColorMode(opts?: UseColorModeOptions): {
|
|
|
16
24
|
/** Gets the system mode preference. */
|
|
17
25
|
getSystemModePreference: () => DarkLightMode;
|
|
18
26
|
};
|
|
27
|
+
export {};
|
|
19
28
|
//# sourceMappingURL=useColorMode.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useColorMode.d.ts","sourceRoot":"","sources":["../../src/useColorMode/useColorMode.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"useColorMode.d.ts","sourceRoot":"","sources":["../../src/useColorMode/useColorMode.ts"],"names":[],"mappings":"AAOA,2BAA2B;AAC3B,KAAK,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAA;AAE5C,+BAA+B;AAC/B,KAAK,aAAa,GAAG,OAAO,GAAG,MAAM,CAAA;AAErC;;GAEG;AACH,wBAAgB,YAAY,CAC1B,IAAI,GAAE;IACJ,oCAAoC;IACpC,gBAAgB,CAAC,EAAE,SAAS,CAAA;IAC5B,8BAA8B;IAC9B,iBAAiB,CAAC,EAAE,SAAS,CAAA;CACzB;IA2FJ,yCAAyC;;IAKzC,+CAA+C;;IAE/C,yDAAyD;;IAEzD,qDAAqD;;IAErD,kDAAkD;0BArFvB,SAAS;IAuFpC,uCAAuC;mCA9EL,aAAa;EAiFlD"}
|
|
@@ -53,16 +53,17 @@ function useColorMode(opts = {}) {
|
|
|
53
53
|
);
|
|
54
54
|
colorMode.value = savedColorMode ?? initialColorMode;
|
|
55
55
|
watch(colorMode, applyColorMode, { immediate: true });
|
|
56
|
+
const handleChange = () => colorMode.value === "system" && applyColorMode("system");
|
|
57
|
+
const mediaQuery = ref(null);
|
|
56
58
|
onMounted(() => {
|
|
57
59
|
if (typeof window !== "undefined" && typeof window?.matchMedia === "function") {
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
mediaQuery.addEventListener("change", handleChange);
|
|
61
|
-
onUnmounted(() => {
|
|
62
|
-
mediaQuery.removeEventListener("change", handleChange);
|
|
63
|
-
});
|
|
60
|
+
mediaQuery.value = window.matchMedia("(prefers-color-scheme: dark)");
|
|
61
|
+
mediaQuery.value?.addEventListener("change", handleChange);
|
|
64
62
|
}
|
|
65
63
|
});
|
|
64
|
+
onUnmounted(() => {
|
|
65
|
+
mediaQuery.value?.removeEventListener("change", handleChange);
|
|
66
|
+
});
|
|
66
67
|
return {
|
|
67
68
|
/** The current color mode (writable). */
|
|
68
69
|
colorMode: computed({
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/useColorMode/useColorMode.ts"],
|
|
4
|
-
"sourcesContent": ["import { computed, onMounted, onUnmounted, ref, watch } from 'vue'\nimport { z } from 'zod'\n\
|
|
5
|
-
"mappings": "AAAA,SAAS,UAAU,WAAW,aAAa,KAAK,aAAa;AAC7D,SAAS,SAAS;
|
|
4
|
+
"sourcesContent": ["import { computed, onMounted, onUnmounted, ref, watch } from 'vue'\nimport { z } from 'zod'\n\nconst colorMode = ref<ColorMode>('dark')\n\nconst colorModeSchema = z.enum(['dark', 'light', 'system']).optional().catch(undefined)\n\n/** Possible color modes */\ntype ColorMode = 'light' | 'dark' | 'system'\n\n/** Specific dark/light mode */\ntype DarkLightMode = 'light' | 'dark'\n\n/**\n * A composable hook that provides color mode (dark/light) functionality.\n */\nexport function useColorMode(\n opts: {\n /** The initial color mode to use */\n initialColorMode?: ColorMode\n /** Override the color mode */\n overrideColorMode?: ColorMode\n } = {},\n) {\n const { initialColorMode = 'system', overrideColorMode } = opts\n\n /** Toggles the color mode between light and dark. */\n function toggleColorMode() {\n // Update state\n colorMode.value = darkLightMode.value === 'dark' ? 'light' : 'dark'\n\n // Store in local storage\n if (typeof window === 'undefined') {\n return\n }\n window?.localStorage?.setItem('colorMode', colorMode.value)\n }\n\n /** Sets the color mode to the specified value. */\n function setColorMode(value: ColorMode) {\n colorMode.value = value\n if (typeof window === 'undefined') {\n return\n }\n window?.localStorage?.setItem('colorMode', colorMode.value)\n }\n\n /** Gets the system mode preference. */\n function getSystemModePreference(): DarkLightMode {\n if (typeof window === 'undefined') {\n return 'light'\n }\n if (typeof window?.matchMedia !== 'function') {\n return 'dark'\n }\n\n return window?.matchMedia('(prefers-color-scheme: dark)')?.matches ? 'dark' : 'light'\n }\n\n /** Writable computed ref for dark/light mode with system preference applied */\n const darkLightMode = computed<DarkLightMode>({\n get: () => (colorMode.value === 'system' ? getSystemModePreference() : colorMode.value),\n set: setColorMode,\n })\n\n /** Writable computed ref for whether the current color mode is dark */\n const isDarkMode = computed<boolean>({\n get: () => darkLightMode.value === 'dark',\n set: (value) => setColorMode(value ? 'dark' : 'light'),\n })\n\n /** Applies the appropriate color mode class to the body. */\n function applyColorMode(mode: ColorMode): void {\n if (typeof document === 'undefined' || typeof window === 'undefined') {\n return\n }\n\n const classMode = overrideColorMode ?? (mode === 'system' ? getSystemModePreference() : mode)\n\n if (classMode === 'dark') {\n document.body.classList.add('dark-mode')\n document.body.classList.remove('light-mode')\n } else {\n document.body.classList.add('light-mode')\n document.body.classList.remove('dark-mode')\n }\n }\n\n // Priority of initial values is: LocalStorage -> App Config -> initial / Fallback\n const savedColorMode = colorModeSchema.parse(\n typeof window !== 'undefined' ? window?.localStorage?.getItem('colorMode') : 'system',\n )\n colorMode.value = savedColorMode ?? initialColorMode\n\n // Watch for colorMode changes and update the body class\n watch(colorMode, applyColorMode, { immediate: true })\n\n const handleChange = () => colorMode.value === 'system' && applyColorMode('system')\n\n const mediaQuery = ref<MediaQueryList | null>(null)\n // Listen to system preference changes\n onMounted(() => {\n if (typeof window !== 'undefined' && typeof window?.matchMedia === 'function') {\n mediaQuery.value = window.matchMedia('(prefers-color-scheme: dark)')\n mediaQuery.value?.addEventListener('change', handleChange)\n }\n })\n\n onUnmounted(() => {\n mediaQuery.value?.removeEventListener('change', handleChange)\n })\n\n return {\n /** The current color mode (writable). */\n colorMode: computed({\n get: () => colorMode.value,\n set: setColorMode,\n }),\n /** The computed dark/light mode (writable). */\n darkLightMode,\n /** Whether the current color mode is dark (writable). */\n isDarkMode,\n /** Toggles the color mode between light and dark. */\n toggleColorMode,\n /** Sets the color mode to the specified value. */\n setColorMode,\n /** Gets the system mode preference. */\n getSystemModePreference,\n }\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,UAAU,WAAW,aAAa,KAAK,aAAa;AAC7D,SAAS,SAAS;AAElB,MAAM,YAAY,IAAe,MAAM;AAEvC,MAAM,kBAAkB,EAAE,KAAK,CAAC,QAAQ,SAAS,QAAQ,CAAC,EAAE,SAAS,EAAE,MAAM,MAAS;AAW/E,SAAS,aACd,OAKI,CAAC,GACL;AACA,QAAM,EAAE,mBAAmB,UAAU,kBAAkB,IAAI;AAG3D,WAAS,kBAAkB;AAEzB,cAAU,QAAQ,cAAc,UAAU,SAAS,UAAU;AAG7D,QAAI,OAAO,WAAW,aAAa;AACjC;AAAA,IACF;AACA,YAAQ,cAAc,QAAQ,aAAa,UAAU,KAAK;AAAA,EAC5D;AAGA,WAAS,aAAa,OAAkB;AACtC,cAAU,QAAQ;AAClB,QAAI,OAAO,WAAW,aAAa;AACjC;AAAA,IACF;AACA,YAAQ,cAAc,QAAQ,aAAa,UAAU,KAAK;AAAA,EAC5D;AAGA,WAAS,0BAAyC;AAChD,QAAI,OAAO,WAAW,aAAa;AACjC,aAAO;AAAA,IACT;AACA,QAAI,OAAO,QAAQ,eAAe,YAAY;AAC5C,aAAO;AAAA,IACT;AAEA,WAAO,QAAQ,WAAW,8BAA8B,GAAG,UAAU,SAAS;AAAA,EAChF;AAGA,QAAM,gBAAgB,SAAwB;AAAA,IAC5C,KAAK,MAAO,UAAU,UAAU,WAAW,wBAAwB,IAAI,UAAU;AAAA,IACjF,KAAK;AAAA,EACP,CAAC;AAGD,QAAM,aAAa,SAAkB;AAAA,IACnC,KAAK,MAAM,cAAc,UAAU;AAAA,IACnC,KAAK,CAAC,UAAU,aAAa,QAAQ,SAAS,OAAO;AAAA,EACvD,CAAC;AAGD,WAAS,eAAe,MAAuB;AAC7C,QAAI,OAAO,aAAa,eAAe,OAAO,WAAW,aAAa;AACpE;AAAA,IACF;AAEA,UAAM,YAAY,sBAAsB,SAAS,WAAW,wBAAwB,IAAI;AAExF,QAAI,cAAc,QAAQ;AACxB,eAAS,KAAK,UAAU,IAAI,WAAW;AACvC,eAAS,KAAK,UAAU,OAAO,YAAY;AAAA,IAC7C,OAAO;AACL,eAAS,KAAK,UAAU,IAAI,YAAY;AACxC,eAAS,KAAK,UAAU,OAAO,WAAW;AAAA,IAC5C;AAAA,EACF;AAGA,QAAM,iBAAiB,gBAAgB;AAAA,IACrC,OAAO,WAAW,cAAc,QAAQ,cAAc,QAAQ,WAAW,IAAI;AAAA,EAC/E;AACA,YAAU,QAAQ,kBAAkB;AAGpC,QAAM,WAAW,gBAAgB,EAAE,WAAW,KAAK,CAAC;AAEpD,QAAM,eAAe,MAAM,UAAU,UAAU,YAAY,eAAe,QAAQ;AAElF,QAAM,aAAa,IAA2B,IAAI;AAElD,YAAU,MAAM;AACd,QAAI,OAAO,WAAW,eAAe,OAAO,QAAQ,eAAe,YAAY;AAC7E,iBAAW,QAAQ,OAAO,WAAW,8BAA8B;AACnE,iBAAW,OAAO,iBAAiB,UAAU,YAAY;AAAA,IAC3D;AAAA,EACF,CAAC;AAED,cAAY,MAAM;AAChB,eAAW,OAAO,oBAAoB,UAAU,YAAY;AAAA,EAC9D,CAAC;AAED,SAAO;AAAA;AAAA,IAEL,WAAW,SAAS;AAAA,MAClB,KAAK,MAAM,UAAU;AAAA,MACrB,KAAK;AAAA,IACP,CAAC;AAAA;AAAA,IAED;AAAA;AAAA,IAEA;AAAA;AAAA,IAEA;AAAA;AAAA,IAEA;AAAA;AAAA,IAEA;AAAA,EACF;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"url": "git+https://github.com/scalar/scalar.git",
|
|
11
11
|
"directory": "packages/use-hooks"
|
|
12
12
|
},
|
|
13
|
-
"version": "0.
|
|
13
|
+
"version": "0.3.0",
|
|
14
14
|
"engines": {
|
|
15
15
|
"node": ">=20"
|
|
16
16
|
},
|
|
@@ -49,19 +49,18 @@
|
|
|
49
49
|
],
|
|
50
50
|
"module": "./dist/index.js",
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@vueuse/core": "
|
|
52
|
+
"@vueuse/core": "13.9.0",
|
|
53
53
|
"cva": "1.0.0-beta.2",
|
|
54
54
|
"tailwind-merge": "^2.5.5",
|
|
55
|
-
"vue": "^3.5.
|
|
56
|
-
"zod": "
|
|
57
|
-
"@scalar/use-toasts": "0.
|
|
55
|
+
"vue": "^3.5.21",
|
|
56
|
+
"zod": "4.1.11",
|
|
57
|
+
"@scalar/use-toasts": "0.9.0"
|
|
58
58
|
},
|
|
59
59
|
"devDependencies": {
|
|
60
|
-
"@vitejs/plugin-vue": "
|
|
61
|
-
"@vue/test-utils": "
|
|
62
|
-
"vite": "
|
|
63
|
-
"
|
|
64
|
-
"@scalar/build-tooling": "0.2.4"
|
|
60
|
+
"@vitejs/plugin-vue": "6.0.1",
|
|
61
|
+
"@vue/test-utils": "2.4.6",
|
|
62
|
+
"vite": "7.1.11",
|
|
63
|
+
"@scalar/build-tooling": "0.2.8"
|
|
65
64
|
},
|
|
66
65
|
"scripts": {
|
|
67
66
|
"build": "scalar-build-esbuild",
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/** Possible color modes */
|
|
2
|
-
export type ColorMode = 'light' | 'dark' | 'system';
|
|
3
|
-
/** Specific dark/light mode */
|
|
4
|
-
export type DarkLightMode = 'light' | 'dark';
|
|
5
|
-
/** Options for the useColorMode hook */
|
|
6
|
-
export type UseColorModeOptions = {
|
|
7
|
-
/** The initial color mode to use */
|
|
8
|
-
initialColorMode?: ColorMode;
|
|
9
|
-
/** Override the color mode */
|
|
10
|
-
overrideColorMode?: ColorMode;
|
|
11
|
-
};
|
|
12
|
-
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/useColorMode/types.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEnD,+BAA+B;AAC/B,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,CAAA;AAE5C,wCAAwC;AACxC,MAAM,MAAM,mBAAmB,GAAG;IAChC,oCAAoC;IACpC,gBAAgB,CAAC,EAAE,SAAS,CAAA;IAC5B,8BAA8B;IAC9B,iBAAiB,CAAC,EAAE,SAAS,CAAA;CAC9B,CAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
//# sourceMappingURL=types.js.map
|