Class ZetaCheckbox

Checkboxes allow users to select one or more items from a set. Checkboxes can turn an option on or off.

Figma

https://www.figma.com/file/JesXQFLaPJLc1BdBM4sisI/🦓-ZDS---Components?node-id=21510-54003

Storybook

https://zeta-ds.web.app/web/storybook/?path=/docs/checkbox--docs

Hierarchy

BaseToggleFormElement
- ZetaCheckbox

Index

Other

constructor checked? disabled indeterminate input internals name required rounded type value shadowRootOptions styles blur click focus handleChange key

rendering

Other

constructor

new ZetaCheckbox(): ZetaCheckbox
Returns ZetaCheckbox
Overrides BaseToggleFormElement.constructor
- Defined in src/components/checkbox/checkbox.ts:15

`Optional`checked

checked?: boolean

disabled

disabled: boolean

indeterminate

indeterminate: boolean

input

input: HTMLInputElement

internals

internals: ElementInternals

name

name: string

required

required: boolean

rounded

rounded: boolean

type

type: InputType = ...

value

value: string = "on"

`Static`shadowRootOptions

shadowRootOptions: ShadowRootInit = ...

`Static`styles

styles: (CSSResult | CSSResultGroup[])[] = ...

blur

blur(): void
MDN Reference

Returns void
Inherited from BaseToggleFormElement.blur
- Defined in src/components/base-toggle-form-element.ts:22

click

click(): void
MDN Reference

Returns void
Overrides BaseToggleFormElement.click
- Defined in src/components/checkbox/checkbox.ts:23

focus

focus(): void
MDN Reference

Returns void
Inherited from BaseToggleFormElement.focus
- Defined in src/components/base-toggle-form-element.ts:18

handleChange

handleChange(event): void
Parameters
- event: Event
Returns void
Inherited from BaseToggleFormElement.handleChange
- Defined in src/components/base-toggle-form-element.ts:14

key

key(e, type): void
Parameters
- e: KeyboardEvent
- type: "down" | "up"
Returns void
Inherited from BaseToggleFormElement.key
- Defined in src/components/base-toggle-form-element.ts:26

rendering

`Protected`render

render(): TemplateResult<1>
Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns TemplateResult<1>
Inherited from BaseToggleFormElement.render
- Defined in src/components/base-toggle-form-element.ts:34