Skip to content
dbx tools

Interface: ResourceStatusIndicatorProps

Options shared by ResourceStatusIndicator and useResourceStatusToaster.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

className?

Section titled “className?”

optional className?: string

Class name applied to the Toaster wrapper.

closeButton?

Section titled “closeButton?”

optional closeButton?: boolean

Inherited from

Section titled “Inherited from”

Omit.closeButton

containerAriaLabel?

Section titled “containerAriaLabel?”

optional containerAriaLabel?: string

Inherited from

Section titled “Inherited from”

Omit.containerAriaLabel

dir?

Section titled “dir?”

optional dir?: "auto" | "ltr" | "rtl"

Inherited from

Section titled “Inherited from”

Omit.dir

duration?

Section titled “duration?”

optional duration?: number

Inherited from

Section titled “Inherited from”

Omit.duration

expand?

Section titled “expand?”

optional expand?: boolean

Inherited from

Section titled “Inherited from”

Omit.expand

gap?

Section titled “gap?”

optional gap?: number

Inherited from

Section titled “Inherited from”

Omit.gap

hotkey?

Section titled “hotkey?”

optional hotkey?: string[]

Inherited from

Section titled “Inherited from”

Omit.hotkey

icons?

Section titled “icons?”

optional icons?: ToastIcons

Inherited from

Section titled “Inherited from”

Omit.icons

id?

Section titled “id?”

optional id?: string

Inherited from

Section titled “Inherited from”

Omit.id

invert?

Section titled “invert?”

optional invert?: boolean

Inherited from

Section titled “Inherited from”

Omit.invert

kind?

Section titled “kind?”

optional kind?: string

Restrict to a single resource kind. Otherwise shows the worst across all kinds.

Inherited from

Section titled “Inherited from”

ResourceStatusToasterOptions.kind

mobileOffset?

Section titled “mobileOffset?”

optional mobileOffset?: Offset

Inherited from

Section titled “Inherited from”

Omit.mobileOffset

offset?

Section titled “offset?”

optional offset?: Offset

Inherited from

Section titled “Inherited from”

Omit.offset

position?

Section titled “position?”

optional position?: Position

Inherited from

Section titled “Inherited from”

Omit.position

render?

Section titled “render?”

optional render?: (aggregate) => ReactNode

Full custom render override, rendered inside toast.custom.

Parameters

Section titled “Parameters”
aggregate
Section titled “aggregate”

AggregatedResourceStatus

Returns

Section titled “Returns”

ReactNode

Inherited from

Section titled “Inherited from”

ResourceStatusToasterOptions.render

renderers?

Section titled “renderers?”

optional renderers?: Record<string, ResourceKindRenderer>

Per-kind copy + icon overrides.

Inherited from

Section titled “Inherited from”

ResourceStatusToasterOptions.renderers

richColors?

Section titled “richColors?”

optional richColors?: boolean

Inherited from

Section titled “Inherited from”

Omit.richColors

style?

Section titled “style?”

optional style?: CSSProperties

Inherited from

Section titled “Inherited from”

Omit.style

swipeDirections?

Section titled “swipeDirections?”

optional swipeDirections?: SwipeDirection[]

Inherited from

Section titled “Inherited from”

Omit.swipeDirections

theme?

Section titled “theme?”

optional theme?: "light" | "dark" | "system"

Inherited from

Section titled “Inherited from”

Omit.theme

toastClassName?

Section titled “toastClassName?”

optional toastClassName?: string

Class name applied to the toast (not the Toaster wrapper).

Inherited from

Section titled “Inherited from”

ResourceStatusToasterOptions.toastClassName

toastOptions?

Section titled “toastOptions?”

optional toastOptions?: ToastOptions

Inherited from

Section titled “Inherited from”

Omit.toastOptions

visibleToasts?

Section titled “visibleToasts?”

optional visibleToasts?: number

Inherited from

Section titled “Inherited from”

Omit.visibleToasts