Checkbox Svelte Component
Checkbox Svelte component represents Checkbox component.
Checkbox Components
There are following components included:
Checkbox
Checkbox Properties
Prop | Type | Default | Description |
---|---|---|---|
<Checkbox> properties | |||
checked | boolean | Defines whether the checkbox input is checked or not | |
indeterminate | boolean | Defines whether the checkbox input is in indeterminate state or not | |
name | string number | Checkbox input name | |
value | string number boolean | Checkbox input value | |
disabled | boolean | Defines whether the checkbox input is disabled | |
readonly | boolean | Defines whether the checkbox input is readonly |
Checkbox Events
Event | Description |
---|---|
<Checkbox> events | |
change | Event will be triggered when checkbox state changed |
Checkboxes List
Checkboxes List is not a separate component, but just a particular case of using <List>
, <ListItem>
.
<List>
<!-- Additional "checkbox" prop to enable checkbox list item -->
<ListItem checkbox value="check_1" checked title="Checkbox 1" />
<ListItem checkbox value="check_2" title="Checkbox 2" />
</List>
Examples
<Page>
<Navbar title="Checkbox" />
<BlockTitle>Inline</BlockTitle>
<Block strong>
<p>Lorem <Checkbox name="checkbox-1"></Checkbox> ipsum dolor sit amet, consectetur adipisicing elit. Alias beatae illo nihil aut eius commodi sint eveniet aliquid eligendi <Checkbox name="checkbox-2" checked></Checkbox> ad delectus impedit tempore nemo, enim vel praesentium consequatur nulla mollitia!</p>
</Block>
<BlockTitle>Checkbox Group</BlockTitle>
<List>
<ListItem checkbox title="Books" name="demo-checkbox" checked></ListItem>
<ListItem checkbox title="Movies" name="demo-checkbox"></ListItem>
<ListItem checkbox title="Food" name="demo-checkbox"></ListItem>
<ListItem checkbox title="Drinks" name="demo-checkbox"></ListItem>
</List>
<BlockTitle>Indeterminate State</BlockTitle>
<List>
<ListItem
checkbox
title="Movies"
name="demo-checkbox"
checked={movies.length === 2}
indeterminate={movies.length === 1}
onChange={onMoviesChange}
>
<ul slot="root">
<ListItem
checkbox
title="Movie 1"
name="demo-checkbox"
value="Movie 1"
checked={movies.indexOf('Movie 1') >= 0}
onChange={onMovieChange}
/>
<ListItem
checkbox
title="Movie 2"
name="demo-checkbox"
value="Movie 2"
checked={movies.indexOf('Movie 2') >= 0}
onChange={onMovieChange}
/>
</ul>
</ListItem>
</List>
<BlockTitle>With Media Lists</BlockTitle>
<List mediaList>
<ListItem
checkbox
checked
name="demo-media-checkbox"
title="Facebook"
after="17:14"
subtitle="New messages from John Doe"
text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
/>
<ListItem
checkbox
name="demo-media-checkbox"
title="John Doe (via Twitter)"
after="17:11"
subtitle="John Doe (@_johndoe) mentioned you on Twitter!"
text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
/>
<ListItem
checkbox
name="demo-media-checkbox"
title="Facebook"
after="16:48"
subtitle="New messages from John Doe"
text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
/>
<ListItem
checkbox
name="demo-media-checkbox"
title="John Doe (via Twitter)"
after="15:32"
subtitle="John Doe (@_johndoe) mentioned you on Twitter!"
text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus."
/>
</List>
</Page>
<script>
import {Page, Navbar, BlockTitle, Block, Checkbox, List, ListItem} from 'framework7-svelte';
let movies = ['Movie 1'];
function onMovieChange(e) {
var value = e.target.value;
if (e.target.checked) {
movies.push(value);
} else {
movies.splice(movies.indexOf(value), 1);
}
movies = movies;
}
function onMoviesChange() {
if (movies.length === 1 || movies.length === 0) {
movies = ['Movie 1', 'Movie 2'];
} else if (movies.length === 2) {
movies = [];
}
}
</script>