From 4e3415a4e91edbbb3bf761ae6c493614774834fb Mon Sep 17 00:00:00 2001 From: metonym Date: Thu, 27 Jan 2022 07:27:10 -0800 Subject: [PATCH] docs: Checkbox, Tabs, NumberInput (#1045) * add `Checkbox` reactive example for `bind:checked` (#967) * update `Checkbox` reactive example for `bind:group` to demo two-way binding * simplify `Tabs` reactive example * add `NumberInput` "No value" example --- docs/src/pages/components/Checkbox.svx | 18 +++++++++++++--- docs/src/pages/components/NumberInput.svx | 8 +++++++ .../framed/Checkbox/CheckboxReactive.svelte | 14 +++++++++++++ .../framed/Checkbox/MultipleCheckboxes.svelte | 16 +++++++------- .../NumberInput/NumberInputEmpty.svelte | 15 +++++++++++++ .../src/pages/framed/Tabs/TabsReactive.svelte | 21 ++++--------------- 6 files changed, 65 insertions(+), 27 deletions(-) create mode 100644 docs/src/pages/framed/Checkbox/CheckboxReactive.svelte create mode 100644 docs/src/pages/framed/NumberInput/NumberInputEmpty.svelte diff --git a/docs/src/pages/components/Checkbox.svx b/docs/src/pages/components/Checkbox.svx index 70b163a9..a389340e 100644 --- a/docs/src/pages/components/Checkbox.svx +++ b/docs/src/pages/components/Checkbox.svx @@ -1,5 +1,5 @@ @@ -23,9 +23,21 @@ -### Multiple +### Reactive example (bind:checked) -Bind a selection [group](https://svelte.dev/tutorial/group-inputs) to multiple checkboxes. +The `checked` prop supports two-way binding. + + + +### Reactive example (bind:group) + +An alternative to `checked` is binding an array of values using `group`. This API in inspired by Svelte [group inputs]([group](https://svelte.dev/tutorial/group-inputs)). + + +
+ If using bind:group, bind:checked will only support one-way binding. +
+
diff --git a/docs/src/pages/components/NumberInput.svx b/docs/src/pages/components/NumberInput.svx index 923fab25..ea017fe3 100644 --- a/docs/src/pages/components/NumberInput.svx +++ b/docs/src/pages/components/NumberInput.svx @@ -19,6 +19,14 @@ components: ["NumberInput", "NumberInputSkeleton"] +### No value + +Set `allowEmpty` to `true` to allow for no value. + +Set `value` to `null` to denote "no value." + + + ### Hidden label diff --git a/docs/src/pages/framed/Checkbox/CheckboxReactive.svelte b/docs/src/pages/framed/Checkbox/CheckboxReactive.svelte new file mode 100644 index 00000000..a58be9eb --- /dev/null +++ b/docs/src/pages/framed/Checkbox/CheckboxReactive.svelte @@ -0,0 +1,14 @@ + + + + +
+ +
+ +checked: +{checked} diff --git a/docs/src/pages/framed/Checkbox/MultipleCheckboxes.svelte b/docs/src/pages/framed/Checkbox/MultipleCheckboxes.svelte index 5d784c0e..d66c444b 100644 --- a/docs/src/pages/framed/Checkbox/MultipleCheckboxes.svelte +++ b/docs/src/pages/framed/Checkbox/MultipleCheckboxes.svelte @@ -1,15 +1,17 @@ -{#each options as option} - +{#each values as value} + {/each}
- Selected options: - {selection.join(", ")} +
+ +Selected: +{JSON.stringify(group)} diff --git a/docs/src/pages/framed/NumberInput/NumberInputEmpty.svelte b/docs/src/pages/framed/NumberInput/NumberInputEmpty.svelte new file mode 100644 index 00000000..cc76a330 --- /dev/null +++ b/docs/src/pages/framed/NumberInput/NumberInputEmpty.svelte @@ -0,0 +1,15 @@ + + + + +
+ + +
+ +Value: +{value} diff --git a/docs/src/pages/framed/Tabs/TabsReactive.svelte b/docs/src/pages/framed/Tabs/TabsReactive.svelte index f85e5c07..c6e5070a 100644 --- a/docs/src/pages/framed/Tabs/TabsReactive.svelte +++ b/docs/src/pages/framed/Tabs/TabsReactive.svelte @@ -15,22 +15,9 @@ -
-

Selected index: {selected}

+
+
-
- -
- - +Selected index: +{selected}