Theme

npm_versionnpm Paragon package page

basic usage

Any Paragon component or export may be added to the code example.

success alert

Any Paragon component or export may be added to the code example.

danger alert

Any Paragon component or export may be added to the code example.

informational alert

Any Paragon component or export may be added to the code example.

alert with a custom aria-label on the close button

Any Paragon component or export may be added to the code example.

Non-dismissible alert

Any Paragon component or export may be added to the code example.

alert invoked via a button

Any Paragon component or export may be added to the code example.

Any Paragon component or export may be added to the code example.

Props API#

StatusAlert Props API
  • alertType string

    specifies the type of alert that is being diplayed. It defaults to "warning". See the other available bootstrap options.

    Default'warning'
  • className string

    is a string array that defines the classes to be used within the status alert.

  • dialog string | element Required
  • dismissible bool

    specifies if the status alert will include the dismissible X button to close the alert. It defaults to true.

    Defaulttrue
  • closeButtonAriaLabel string
    Default'Close'
  • onClose isRequiredIf(PropTypes.func, props => props.dismissible)

    is a function that is called on close. It can be used to perform actions upon closing of the status alert, such as restoring focus to the previous logical focusable element. It is only required if dismissible is set to true and not required if the alert is not dismissible.

  • open bool

    specifies whether the status alert renders open or closed on the initial render. It defaults to false.

    Defaultfalse

Usage Insights#

StatusAlert

Project NameParagon VersionInstance Count
edx-platform2.6.410
frontend-component-cookie-policy-banner20.28.41
frontend-learner-portal-base12.2.04
prospectus20.46.23
studio-frontend3.4.83