-
-
Notifications
You must be signed in to change notification settings - Fork 31
/
Copy pathdbcChecklist.Rd
142 lines (97 loc) · 6.14 KB
/
dbcChecklist.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
% Auto-generated: do not edit by hand
\name{dbcChecklist}
\alias{dbcChecklist}
\title{Checklist component}
\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{
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{
\item{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.}
\item{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}
\item{value}{List of character | numerics. The currently selected value}
\item{class_name}{Character. The class of the container (div)}
\item{className}{Character. **DEPRECATED** Use `class_name` instead.
The class of the container (div)}
\item{style}{Named list. The style of the container (div)}
\item{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}
\item{input_style}{Named list. The style of the <input> checkbox element.}
\item{inputStyle}{Named list. **DEPRECATED** Use `input_style` instead.
The style of the <input> checkbox element.}
\item{input_checked_style}{Named list. Additional inline style arguments to apply to <input> elements on checked
items.}
\item{inputCheckedStyle}{Named list. **DEPRECATED** Use `input_checked_style` instead.
Additional inline style arguments to apply to <input> elements on checked
items.}
\item{input_class_name}{Character. The class of the <input> checkbox element}
\item{inputClassName}{Character. **DEPRECATED** Use `input_class_name` instead.
The class of the <input> checkbox element}
\item{input_checked_class_name}{Character. Additional CSS classes to apply to the <input> element when the
corresponding checkbox is checked.}
\item{inputCheckedClassName}{Character. **DEPRECATED** Use `input_checked_class_name` instead.
Additional CSS classes to apply to the <input> element when the
corresponding checkbox is checked.}
\item{label_style}{Named list. Inline style arguments to apply to the <label> element for each item.}
\item{labelStyle}{Named list. **DEPRECATED** Use `label_style` instead.
Inline style arguments to apply to the <label> element for each item.}
\item{label_checked_style}{Named list. Additional inline style arguments to apply to <label> elements on checked
items.}
\item{labelCheckedStyle}{Named list. **DEPRECATED** Use `label_checked_style` instead.
Additional inline style arguments to apply to <label> elements on checked
items.}
\item{label_class_name}{Character. CSS classes to apply to the <label> element for each item.}
\item{labelClassName}{Character. **DEPRECATED** Use `label_class_name` instead.
CSS classes to apply to the <label> element for each item.}
\item{label_checked_class_name}{Character. Additional CSS classes to apply to the <label> element when the
corresponding checkbox is checked.}
\item{labelCheckedClassName}{Character. **DEPRECATED** Use `label_checked_class_name` instead.
Additional CSS classes to apply to the <label> element when the
corresponding checkbox is checked.}
\item{inline}{Logical. Arrange Checklist inline}
\item{switch}{Logical. Set to True to render toggle-like switches instead of checkboxes.}
\item{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}
\item{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`.}
\item{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.}
\item{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.}
\item{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}