A shadcn checkbox. input$<inputId> is TRUE, FALSE, or
"indeterminate".
Usage
shad_checkbox(
inputId,
label = NULL,
value = FALSE,
indeterminate = FALSE,
disabled = FALSE,
description = NULL,
class = NULL,
tristate = FALSE,
...
)Arguments
- inputId
Input id.
- label
Optional label shown next to the box.
- value
Initial value:
TRUE,FALSE, or"indeterminate".- indeterminate
If
TRUE, seeds the indeterminate (mixed) state.- disabled
If
TRUE, disables the control.- description
Optional help text below the row.
- class
Extra CSS classes.
- tristate
If
TRUE, clicks cycle unchecked, checked, indeterminate, then back to unchecked. A shadshiny addition; shadcn/ui has no equivalent.- ...
Extra attributes on the checkbox button.
Details
By default clicks follow shadcn/ui (Radix): an indeterminate box becomes
checked, and from then on clicks only toggle checked and unchecked. Only the
server can set it back with update_shad_checkbox(id, "indeterminate"),
which suits a "select all" box whose state comes from other inputs. Set
tristate = TRUE to let the user click through all three states instead.
See also
Other shadshiny tier-2 components:
shad_calendar(),
shad_combobox(),
shad_date_picker(),
shad_date_presets(),
shad_form_field(),
shad_input(),
shad_input_group(),
shad_input_otp(),
shad_native_select(),
shad_radio_group(),
shad_select(),
shad_slider(),
shad_switch(),
shad_textarea(),
shad_toggle(),
shad_toggle_group()
Examples
shad_checkbox("terms", "Accept terms and conditions")
#> <div class="shad-checkbox-row">
#> <button type="button" class="shad-checkbox" data-shad="checkbox" data-state="unchecked" id="terms" aria-labelledby="terms-label"><svg class="shad-checkbox__indicator shad-checkbox__indicator--check" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path pathLength="1" d="M20 6 9 17l-5-5"/></svg><svg class="shad-checkbox__indicator shad-checkbox__indicator--minus" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" aria-hidden="true"><path d="M5 12h14"/></svg></button>
#> <label class="shad-label" id="terms-label" for="terms">Accept terms and conditions</label>
#> </div>
shad_checkbox("all", "Select all", indeterminate = TRUE)
#> <div class="shad-checkbox-row">
#> <button type="button" class="shad-checkbox" data-shad="checkbox" data-state="indeterminate" id="all" aria-labelledby="all-label"><svg class="shad-checkbox__indicator shad-checkbox__indicator--check" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path pathLength="1" d="M20 6 9 17l-5-5"/></svg><svg class="shad-checkbox__indicator shad-checkbox__indicator--minus" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" aria-hidden="true"><path d="M5 12h14"/></svg></button>
#> <label class="shad-label" id="all-label" for="all">Select all</label>
#> </div>
shad_checkbox("filter", "Include archived", tristate = TRUE)
#> <div class="shad-checkbox-row">
#> <button type="button" class="shad-checkbox" data-shad="checkbox" data-state="unchecked" id="filter" aria-labelledby="filter-label" data-tristate><svg class="shad-checkbox__indicator shad-checkbox__indicator--check" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path pathLength="1" d="M20 6 9 17l-5-5"/></svg><svg class="shad-checkbox__indicator shad-checkbox__indicator--minus" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" aria-hidden="true"><path d="M5 12h14"/></svg></button>
#> <label class="shad-label" id="filter-label" for="filter">Include archived</label>
#> </div>