@smui/checkbox

Svelte Material UI - Checkbox

Checkbox is used to provide the same functionality as <input type="checkbox">.

Installation

npm install --save-dev @smui/checkbox

Examples and Usage Information

https://sveltematerialui.com/demo/checkbox

Exports

(default)

A checkbox.

Props / Defaults

• use: [] - An array of Svelte actions and/or arrays of an action and its options.
• class: '' - A CSS class string.
• disabled: false - Whether the input is disabled.
• touch: false - Increase the touch target.
• indeterminate: (uninitialised) - Whether the state is indeterminate.
• group: (uninitialised) - The selected values of a group of checkboxes as an array.
• checked: (uninitialised) - A boolean, whether the checkbox is checked. This is used instead of group for a single checkbox.
• value : null - The value of a checkbox in a group of checkboxes.
• valueKey : (uninitialised) - If value is not a string, this should be supplied as well, and should be a unique key.

Forwarded Props

• input$ - Props forwarded to the input element.

Functions

• getId - Get the HTML ID of the element.

More Information

See Checkboxes in the Material design spec.

See Checkbox in MDC-Web for information about the upstream library's architecture.

Changelog

7.0.0-beta.0 (2022-10-12)

Bug Fixes

• adjust position of snackbar when a page level bottom app bar is present (e6db9f2)
• default element in common icon (98b1536)
• icon button mini size (9dc65de)
• return correct element type when the component is static (441bb09)
• rework Object.entries into more compatible code (41246d4)
• scroll direction that makes bottom app bar hide (8405e9a)
• turns out, svelte still doesn't report exported module members in typescript (72702aa)
• use separate svg component and fix all type errors (9accd0b)
• workaround for chrome bug with bottom app bar background (c9f0726)

Features

• add standard variant for bottom app bar with scrolling behavior (68deb4b)
• migrate to common element component instead of elemental components (8aaf611)
• new bottom app bar component (8448267)
• new common element component with dynamic element support (bfa69d2)
• new typing method gets rid of separate type files, keeps html prop autocomplete (bf7b2a4)
• redo type system to bring types into their svelte files (61b9395)
• trying to get components with generic types working (9952576)
• update to mdc-web 14, implement new features and fixes (cca1827)