checkbarInput: Checkbar input

In nteetor/dull: A Reactive Web Framework Built on 'shiny'

Checkbar input

Description

A stylized checkbox input. The checkbar input appears similar to a group of buttons, but with a checked or highlighted state.

Usage

checkbarInput(..., id, choices = NULL, values = choices, selected = NULL)

updateCheckbarInput(
  id,
  choices = NULL,
  values = choices,
  selected = NULL,
  enable = NULL,
  disable = NULL,
  session = getDefaultReactiveDomain()
)

Arguments

...	Additional named arguments passed as HTML attributes to the parent element or tag elements passed as child elements to the parent element.
id	A character string specifying the id of the reactive input.
choices	A character vector or list of tag element specifying the input's choices, defaults to NULL.
values	A vector of values specifying the values of the input's choices, defaults to choices.
selected	One or more of values specifying the input's default selected values, defaults to NULL.
enable	One of values specifying particular choices to enable or TRUE specifying the entire input is enabled, defaults to NULL.
disable	One of values specifying particular choices to disable or TRUE specifying the entire input is disabled, defaults to NULL.
session	A reactive context, defaults to getDefaultReactiveDomain().

Details

Getting started

Checkbars will expand to fill the width of their parent element.

checkbarInput(
  .style %>%
    background("secondary"),
  id = NULL,
  choices = c("Choice 1", "Choice 2", "Choice 3")
)

Choice 1 Choice 2 Choice 3

If you want to adjust the width you can use the width() utility.

checkbarInput(
  .style %>%
    background("secondary") %>%
    width(50),  # <-
  id = NULL,
  choices = c("Choice 1", "Choice 2", "Choice 3")
)

Choice 1 Choice 2 Choice 3

Background color

Like other inputs, checkbar inputs apply modified background styles

checkbarInput(
  .style %>%
    background("info"),
  id = NULL,
  choices = c("Choice 1", "Choice 2")
)

Choice 1 Choice 2

Labelling

Use a formGroup() to add a label or help text to checkbar input.

formGroup(
  label = "Label",  # <-
  checkbarInput(
    .style %>%
      border("dark") %>%
      font("light"),
    id = NULL,
    choices = c("Choice 1", "Choice 2")
  ),
  help = "Help text about the input"
)

Label

Choice 1 Choice 2

Help text about the input

See Also

Other inputs: buttonGroupInput(), buttonInput(), checkboxInput(), chipInput(), fileInput(), formInput(), listGroupInput(), menuInput(), navInput(), radioInput(), radiobarInput(), rangeInput(), selectInput(), textInput()

nteetor/dull documentation built on Nov. 7, 2024, 2:11 p.m.