dbcBadge: Badge component

In plotly/dashR: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications

Badge component

Description

Badges can be used to add counts or labels to other components.

Usage

dbcBadge(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, color=NULL, text_color=NULL,
pill=NULL, href=NULL, tag=NULL, loading_state=NULL,
external_link=NULL, n_clicks=NULL, n_clicks_timestamp=NULL,
target=NULL, title=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
color	Character. Badge color, options: primary, secondary, success, info, warning, danger, link or any valid CSS color of your choice (e.g. a hex code, a decimal code or a CSS color name) Default: secondary.
text_color	Character. Badge color, options: primary, secondary, success, info, warning, danger, link or any valid CSS color of your choice (e.g. a hex code, a decimal code or a CSS color name) Default: secondary.
pill	Logical. Make badge "pill" shaped (rounded ends, like a pill). Default: False.
href	Character. Attach link to badge.
tag	Character. HTML tag to use for the Badge. Default: span.
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
external_link	Logical. If true, the browser will treat this as an external link, forcing a page refresh at the new location. If false, this just changes the location without triggering a page refresh. Use this if you are observing dcc.Location, for instance. Defaults to true for absolute URLs and false otherwise.
n_clicks	Numeric. An integer that represents the number of times that this element has been clicked on.
n_clicks_timestamp	Numeric. An integer that represents the time (in ms since 1970) at which n_clicks changed. This can be used to tell which button was changed most recently.
target	Character. Target attribute to pass on to the link. Only applies to external links.
title	Character. Sets the title attribute of the underlying HTML button.

Value

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

plotly/dashR documentation built on June 12, 2022, 9:08 a.m.