dbcAccordion: Accordion component

Description Usage Arguments Value

View source: R/dashBootstrapComponents.R

Description

A self contained Accordion component. Build up the children using the AccordionItem component.

Usage

1
2
3
4
dbcAccordion(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, flush=NULL, active_item=NULL,
start_collapsed=NULL, loading_state=NULL, persistence=NULL,
persisted_props=NULL, persistence_type=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

flush

Logical. Renders accordion edge-to-edge with its parent container

active_item

Character. The item_id of the currently active item. If item_id has not been specified for the active item, this will default to item-i, where i is the index (starting from 0) of the item.

start_collapsed

Logical. Set to True for all items to be collapsed initially.

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: 'active_item'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.

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.