Learn R Programming

dash (version 0.9.4)

dbcOffcanvas: Offcanvas component

Description

Create a toggleable hidden sidebar using the Offcanvas component. Toggle the visibility with the `is_open` prop.

Usage

dbcOffcanvas(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, labelledby=NULL, labelledBy=NULL,
backdrop=NULL, backdrop_class_name=NULL,
backdropClassName=NULL, keyboard=NULL, is_open=NULL,
placement=NULL, scrollable=NULL, autofocus=NULL,
autoFocus=NULL, title=NULL, close_button=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.

labelledby

Character. The ARIA labelledby attribute

labelledBy

Character. **DEPRECATED** Use `labelledby` instead

The ARIA labelledby attribute

backdrop

Logical | a value equal to: 'static'. Includes an offcanvas-backdrop element. Alternatively, specify 'static' for a backdrop which doesn't close the modal on click.

backdrop_class_name

Character. CSS class to apply to the backdrop.

backdropClassName

Character. **DEPRECATED** - Use backdrop_class_name instead.

CSS class to apply to the backdrop.

keyboard

Logical. Close the offcanvas when escape key is pressed.

is_open

Logical. Whether offcanvas is currently open.

placement

A value equal to: 'start', 'end', 'top', 'bottom'. Which side of the viewport the offcanvas will appear from.

scrollable

Logical. Allow body scrolling while offcanvas is open.

autofocus

Logical. Puts the focus on the offcanvas when initialized.

autoFocus

Logical. **DEPRECATED** Use `autofocus` instead

Puts the focus on the modal when initialized.

title

Character. The header title

close_button

Logical. Specify whether the Component should contain a close button in the header

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