dbcAlert.Rd

% Auto-generated: do not edit by hand
\name{dbcAlert}

\alias{dbcAlert}

\title{Alert component}

\description{
Alert allows you to create contextual feedback messages on user actions.  Control the visibility using callbacks with the `is_open` prop, or set it to auto-dismiss with the `duration` prop.
}

\usage{
dbcAlert(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, color=NULL, is_open=NULL,
fade=NULL, dismissable=NULL, duration=NULL,
loading_state=NULL)
}

\arguments{
\item{children}{A list of or a singular dash component, string or number. The children of this component.}

\item{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.}

\item{style}{Named list. Defines CSS styles which will override styles previously set.}

\item{class_name}{Character. Often used with CSS to style elements with common properties.}

\item{className}{Character. **DEPRECATED** Use `class_name` instead.

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

\item{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}

\item{color}{Character. Alert 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.}

\item{is_open}{Logical. Whether alert is open. Default: True.}

\item{fade}{Logical. If True, a fade animation will be applied when `is_open` is toggled. If
False the Alert will simply appear and disappear.}

\item{dismissable}{Logical. If true, add a close button that allows Alert to be dismissed.}

\item{duration}{Numeric. Duration in milliseconds after which the Alert dismisses itself.}

\item{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}