dbcChecklist: Checklist component

Description Usage Arguments Value

View source: R/dashBootstrapComponents.R

Description

Checklist is a component that encapsulates several checkboxes. The values and labels of the checklist is specified in the 'options' property and the checked items are specified with the 'value' property. Each checkbox is rendered as an input / label pair. 'Checklist' must be given an 'id' to work properly.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
dbcChecklist(id=NULL, options=NULL, value=NULL, class_name=NULL,
className=NULL, style=NULL, key=NULL, input_style=NULL,
inputStyle=NULL, input_checked_style=NULL,
inputCheckedStyle=NULL, input_class_name=NULL,
inputClassName=NULL, input_checked_class_name=NULL,
inputCheckedClassName=NULL, label_style=NULL,
labelStyle=NULL, label_checked_style=NULL,
labelCheckedStyle=NULL, label_class_name=NULL,
labelClassName=NULL, label_checked_class_name=NULL,
labelCheckedClassName=NULL, inline=NULL, switch=NULL,
loading_state=NULL, persistence=NULL, persisted_props=NULL,
persistence_type=NULL, name=NULL)

Arguments

id

Character. The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app.

options

List of lists containing elements 'label', 'value', 'disabled', 'input_id', 'label_id'. those elements have the following types: - label (character | numeric; required): the checkbox's label - value (character | numeric; required): the value of the checkbox. this value corresponds to the items specified in the 'value' property. - disabled (logical; optional): if true, this checkbox is disabled and can't be clicked on. - input_id (character; optional): id for this option's input, can be used to attach tooltips or apply css styles - label_id (character; optional): id for this option's label, can be used to attach tooltips or apply css styless. An array of options

value

List of character | numerics. The currently selected value

class_name

Character. The class of the container (div)

className

Character. **DEPRECATED** Use 'class_name' instead.

The class of the container (div)

style

Named list. The style of the container (div)

key

Character. A unique identifier for the component, used to improve performance by React.js while rendering components See https://reactjs.org/docs/lists-and-keys.html for more info

input_style

Named list. The style of the <input> checkbox element.

inputStyle

Named list. **DEPRECATED** Use 'input_style' instead.

The style of the <input> checkbox element.

input_checked_style

Named list. Additional inline style arguments to apply to <input> elements on checked items.

inputCheckedStyle

Named list. **DEPRECATED** Use 'input_checked_style' instead.

Additional inline style arguments to apply to <input> elements on checked items.

input_class_name

Character. The class of the <input> checkbox element

inputClassName

Character. **DEPRECATED** Use 'input_class_name' instead.

The class of the <input> checkbox element

input_checked_class_name

Character. Additional CSS classes to apply to the <input> element when the corresponding checkbox is checked.

inputCheckedClassName

Character. **DEPRECATED** Use 'input_checked_class_name' instead.

Additional CSS classes to apply to the <input> element when the corresponding checkbox is checked.

label_style

Named list. Inline style arguments to apply to the <label> element for each item.

labelStyle

Named list. **DEPRECATED** Use 'label_style' instead.

Inline style arguments to apply to the <label> element for each item.

label_checked_style

Named list. Additional inline style arguments to apply to <label> elements on checked items.

labelCheckedStyle

Named list. **DEPRECATED** Use 'label_checked_style' instead.

Additional inline style arguments to apply to <label> elements on checked items.

label_class_name

Character. CSS classes to apply to the <label> element for each item.

labelClassName

Character. **DEPRECATED** Use 'label_class_name' instead.

CSS classes to apply to the <label> element for each item.

label_checked_class_name

Character. Additional CSS classes to apply to the <label> element when the corresponding checkbox is checked.

labelCheckedClassName

Character. **DEPRECATED** Use 'label_checked_class_name' instead.

Additional CSS classes to apply to the <label> element when the corresponding checkbox is checked.

inline

Logical. Arrange Checklist inline

switch

Logical. Set to True to render toggle-like switches instead of checkboxes.

loading_state

Lists containing elements 'is_loading', 'prop_name', 'component_name'. those elements have the following types: - is_loading (logical; optional): determines if the component is loading or not - prop_name (character; optional): holds which property is loading - component_name (character; optional): holds the name of the component that is loading. Object that holds the loading state object coming from dash-renderer

persistence

Logical | character | numeric. Used to allow user interactions in this component to be persisted when the component - or the page - is refreshed. If 'persisted' is truthy and hasn't changed from its previous value, a 'value' that the user has changed while using the app will keep that change, as long as the new 'value' also matches what was given originally. Used in conjunction with 'persistence_type'.

persisted_props

List of a value equal to: 'value's. Properties whose user interactions will persist after refreshing the component or the page. Since only 'value' is allowed this prop can normally be ignored.

persistence_type

A value equal to: 'local', 'session', 'memory'. Where persisted user changes will be stored: memory: only kept in memory, reset on page refresh. local: window.localStorage, data is kept after the browser quit. session: window.sessionStorage, data is cleared once the browser quit.

name

Character. The name of the control, which is submitted with the form data.

Value

named list of JSON elements corresponding to React.js properties and their values


dash documentation built on Nov. 7, 2021, 9:06 a.m.