dbcModal: Modal component

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

Modal component

Description

Create a toggleable dialog using the Modal component. Toggle the visibility with the 'is_open' prop.

Usage

dbcModal(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, tag=NULL, is_open=NULL, centered=NULL,
scrollable=NULL, autofocus=NULL, autoFocus=NULL, size=NULL,
role=NULL, labelledby=NULL, labelledBy=NULL, keyboard=NULL,
backdrop=NULL, modal_class_name=NULL, modalClassName=NULL,
backdrop_class_name=NULL, backdropClassName=NULL,
content_class_name=NULL, contentClassName=NULL, fade=NULL,
fullscreen=NULL, zindex=NULL, zIndex=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.
tag	Character. HTML tag to use for the Modal, default: div
is_open	Logical. Whether modal is currently open.
centered	Logical. If true, vertically center modal on page.
scrollable	Logical. It true, scroll the modal body rather than the entire modal when it is too long to all fit on the screen.
autofocus	Logical. Puts the focus on the modal when initialized.
autoFocus	Logical. **DEPRECATED** Use 'autofocus' instead Puts the focus on the modal when initialized.
size	Character. Set the size of the modal. Options sm, lg, xl for small, large or extra large sized modals, or leave undefined for default size.
role	Character. The ARIA role attribute.
labelledby	Character. The ARIA labelledby attribute
labelledBy	Character. **DEPRECATED** Use 'labelledby' instead The ARIA labelledby attribute
keyboard	Logical. Close the modal when escape key is pressed.
backdrop	Logical | a value equal to: 'static'. Includes a modal-backdrop element. Alternatively, specify 'static' for a backdrop which doesn't close the modal on click.
modal_class_name	Character. CSS class to apply to the modal.
modalClassName	Character. **DEPRECATED** Use 'modal_class_name' instead CSS class to apply to the modal.
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.
content_class_name	Character. CSS class to apply to the modal content.
contentClassName	Character. **DEPRECATED** Use 'content_class_name' instead CSS class to apply to the modal content.
fade	Logical. Set to false for a modal that simply appears rather than fades into view.
fullscreen	A value equal to: proptypes.bool, proptypes.oneof(['sm-down', 'md-down', 'lg-down', 'xl-down', 'xxl-down']). Renders a fullscreen modal. Specifying a breakpoint will render the modal as fullscreen below the breakpoint size.
zindex	Numeric | character. Set the z-index of the modal. Default 1050.
zIndex	Numeric | character. **DEPRECATED** Use 'zindex' instead Set the z-index of the modal. Default 1050.

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.