dbcLabel: Label component

Description Usage Arguments Value

View source: R/dashBootstrapComponents.R

Description

A component for adding labels to inputs in forms with added sizing controls.

Usage

1
2
3
4
5
dbcLabel(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, hidden=NULL, size=NULL,
html_for=NULL, check=NULL, width=NULL, xs=NULL, sm=NULL,
md=NULL, lg=NULL, xl=NULL, align=NULL, color=NULL,
loading_state=NULL)

Arguments

children

A list of or a singular dash component, string or number. The children of this component

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.

style

Named list. Defines CSS styles which will override styles previously set.

class_name

Character. Often used with CSS to style elements with common properties.

className

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

Often used with CSS to style elements with common properties.

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

hidden

Logical. Hide label from UI, but allow it to be discovered by screen-readers.

size

Character. Set size of label. Options 'sm', 'md' (default) or 'lg'.

html_for

Character. Set the 'for' attribute of the label to bind it to a particular element

check

Logical. Set to True when using to label a Checkbox or RadioButton.

width

Specify width of label for use in grid layouts. Accepts the same values as the Col component.

xs

Specify label width on extra small screen

Valid arguments are boolean, an integer in the range 1-12 inclusive, or a dictionary with keys 'offset', 'order', 'size'. See the documentation for more details.

sm

Specify label width on a small screen

Valid arguments are boolean, an integer in the range 1-12 inclusive, or a dictionary with keys 'offset', 'order', 'size'. See the documentation for more details.

md

Specify label width on a medium screen

Valid arguments are boolean, an integer in the range 1-12 inclusive, or a dictionary with keys 'offset', 'order', 'size'. See the documentation for more details.

lg

Specify label width on a large screen

Valid arguments are boolean, an integer in the range 1-12 inclusive, or a dictionary with keys 'offset', 'order', 'size'. See the documentation for more details.

xl

Specify label width on an extra large screen

Valid arguments are boolean, an integer in the range 1-12 inclusive, or a dictionary with keys 'offset', 'order', 'size'. See the documentation for more details.

align

A value equal to: 'start', 'center', 'end'. Set vertical alignment of the label, options: 'start', 'center', 'end', default: 'center'

color

Character. Text color, options: primary, secondary, success, warning, danger, info, muted, light, dark, body, white, black-50, white-50 or any valid CSS color of your choice (e.g. a hex code, a decimal code or a CSS color name).

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

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.