@gospore/checkbox 1.0.45 → 1.0.47
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 +14 -7
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -7,7 +7,14 @@ an array value.
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
|
|
10
|
+
npm install @gospore/checkbox
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Load the shared tokens and this package's styles once in your app entry point:
|
|
14
|
+
|
|
15
|
+
```js
|
|
16
|
+
import "@gospore/theme/theme.css";
|
|
17
|
+
import "@gospore/checkbox/checkbox.css";
|
|
11
18
|
```
|
|
12
19
|
|
|
13
20
|
Include the global theme styles from `@gospore/theme` so the CSS variables that
|
|
@@ -44,12 +51,12 @@ const topics = ref(["design"]);
|
|
|
44
51
|
|
|
45
52
|
## Props
|
|
46
53
|
|
|
47
|
-
| Prop
|
|
48
|
-
|
|
|
49
|
-
| `checked`
|
|
50
|
-
| `value`
|
|
51
|
-
| `label`
|
|
52
|
-
| `disabled` | `Boolean`
|
|
54
|
+
| Prop | Type | Default | Description |
|
|
55
|
+
| ---------- | ------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
56
|
+
| `checked` | `Boolean \| Array` | `false` | Controlled state. Pass a boolean for single checkboxes or an array for checkbox groups (the component will push/pop `value`). Supports `v-model:checked`. |
|
|
57
|
+
| `value` | `String \| Object` | `""` | The value inserted or removed from the bound array when used in group mode. Ignored for boolean usage. |
|
|
58
|
+
| `label` | `String` | `""` | Fallback label text when no default slot is provided. |
|
|
59
|
+
| `disabled` | `Boolean` | `false` | Greys out the checkbox and prevents user interaction. |
|
|
53
60
|
|
|
54
61
|
Any additional attributes (e.g., `name`, `aria-describedby`, `required`) are
|
|
55
62
|
forwarded to the hidden input element.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gospore/checkbox",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.47",
|
|
4
4
|
"description": "",
|
|
5
5
|
"author": "Gospore",
|
|
6
6
|
"type": "module",
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
"require": "./dist/checkbox.cjs.js",
|
|
16
16
|
"types": "./dist/index.d.ts"
|
|
17
17
|
},
|
|
18
|
+
"./checkbox.css": "./dist/checkbox.css",
|
|
18
19
|
"./umd": {
|
|
19
20
|
"import": "./dist/checkbox.umd.js",
|
|
20
21
|
"require": "./dist/checkbox.umd.js"
|
|
@@ -37,6 +38,6 @@
|
|
|
37
38
|
"unplugin-vue-macros": "^2.14.5",
|
|
38
39
|
"vite": "^7.1.12"
|
|
39
40
|
},
|
|
40
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "52ae3a10ae28da88ed7bfb64c3929a22ffc4d03f",
|
|
41
42
|
"types": "./dist/index.d.ts"
|
|
42
43
|
}
|