Skip to contents

Create a Checkbox component

Usage

calcite_checkbox(...)

Arguments

...

named attributes passed to htmltools::tag()

Value

an object of class calcite_component which is a subclass of shiny.tag

Details

Properties

The following properties are provided by this component:

NameAttributeDescriptionValuesReflects to Attribute
checkedcheckedWhen true, the component is checked.booleanTRUE
disableddisabledWhen true, interaction is prevented and the component is displayed with lower opacity.booleanTRUE
formformThe id of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any.stringTRUE
indeterminateindeterminateWhen true, the component is initially indeterminate, which is independent from its checked value. The state is visual only, and can look different across browsers.booleanTRUE
labellabelAccessible name for the component.stringFALSE
namenameSpecifies the name of the component. Required to pass the component's value on form submission.stringTRUE
requiredrequiredWhen true and the component resides in a form, the component must have a value in order for the form to submit.booleanTRUE
scalescaleSpecifies the size of the component."l" | "m" | "s"TRUE
statusstatusSpecifies the status of the input field, which determines message and icons."idle" | "invalid" | "valid"TRUE
validityNAThe current validation state of the component.Check API referenceFALSE
valuevalueThe component's value.anyFALSE

Events

The following events are observed by shiny:

EventDescription
calciteCheckboxChangeFires when the component's checked status changes.

Examples

calcite_checkbox()
#> <calcite-checkbox></calcite-checkbox>