mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-14 18:01:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix: add a value prop to Checkbox (#849)

Browse source
This commit is contained in:
KoichiKiyokawa 2021-10-13 23:38:51 +09:00 • committed by GitHub
commit fed34e40ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 22 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
COMPONENT_INDEX.md
View file

@ -463,6 +463,7 @@ None.
| :------------ | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | ------------------------------------------------- |
| ref | <code>let</code> | Yes | <code>null &#124; HTMLInputElement</code> | <code>null</code> | Obtain a reference to the input HTML element |
| checked | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Specify whether the checkbox is checked |
| value | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the value of the checkbox |
| indeterminate | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Specify whether the checkbox is indeterminate |
| skeleton | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to display the skeleton state |
| readonly | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the checkbox to be read-only |

11
docs/src/COMPONENT_API.json
View file

@ -708,6 +708,17 @@
"moduleName": "Checkbox",
"filePath": "src/Checkbox/Checkbox.svelte",
"props": [
{
"name": "value",
"kind": "let",
"description": "Specify the value of the checkbox",
"type": "string",
"value": "\"\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "checked",
"kind": "let",

4
src/Checkbox/Checkbox.svelte
View file

@ -3,6 +3,9 @@
* @event {boolean} check
*/
/** Specify the value of the checkbox */
export let value = "";
/** Specify whether the checkbox is checked */
export let checked = false;
@ -69,6 +72,7 @@
<input
bind:this="{ref}"
type="checkbox"
value="{value}"
checked="{checked}"
disabled="{disabled}"
id="{id}"

6
types/Checkbox/Checkbox.d.ts vendored
View file

@ -2,6 +2,12 @@
import { SvelteComponentTyped } from "svelte";
export interface CheckboxProps {
/**
* Specify the value of the checkbox
* @default ""
*/
value?: string;
/**
* Specify whether the checkbox is checked
* @default false