<hx-toast> v0.8.0+ HelixUI v0.8.0 or later required

The custom <hx-toast> element provides a user with information for action outside of the user's current context.

Permitted Parents
any
Permitted Children
phrasing content
Events
Any of the following:
  • dismiss (cancelable) - User clicks "X" to dismiss the toast.
  • submit - User clicks CTA

Methods

dismiss()
Dismiss the toast (removes element from the DOM).
submit()
Simulate a mouse click on the CTA button.

Attributes

Attributes enable declarative configuration of an element, via HTML markup.

cta {String} (optional)
Set the text of the CTA button. If absent or blank, the CTA button will not be displayed.
type {Enum<String>} (optional)
Identifies the type of toast. Valid values are as follows:
  • info
  • error
  • success

Properties

JavaScript properties enable programmatic access to an element's configuration and state.

cta{String}
Manipulates the cta attribute.
type{String}
Manipulates the type attribute.

See Also