Liking cljdoc? Tell your friends :D

mantine.notifications

Mantine @mantine/notifications 9.5.0 wrappers (generated, supplement hoisted from codegen/supplements/).

Mantine @mantine/notifications 9.5.0 wrappers (generated, supplement hoisted from codegen/supplements/).
raw docstring

cleanclj/s

(clean)

Remove all notifications — active and queued.

Remove all notifications — active and queued.
sourceraw docstring

clean-queueclj/s

(clean-queue)

Remove only queued notifications (not yet shown).

Remove only queued notifications (not yet shown).
sourceraw docstring

hideclj/s

(hide id)

Hide the notification with the given id (raw string in and out).

Hide the notification with the given id (raw string in and out).
sourceraw docstring

notificationsclj/s

Notifications — Mantine notifications system

https://mantine.dev/x/notifications

Props (docgen 9.5.0):

  • allowDragDismiss boolean (default true) — Determines whether notifications can be dismissed by dragging left or right
  • allowScrollDismiss boolean (default true) — Determines whether notifications can be dismissed with horizontal scroll gesture while hovered
  • autoClose number | false (default 4000) — Auto close timeout for all notifications in ms, false to disable auto close, can be overwritten for individual notifications in notifications.show function
  • containerWidth string | number (default 440) — Notification width, cannot exceed 100%
  • limit number (default 5) — Maximum number of notifications displayed at a time, other new notifications will be added to queue
  • notificationMaxHeight string | number (default 200) — Notification max-height, used for transitions
  • pauseResetOnHover "all" | "notification" (default 'all') — Determines which notifications should pause auto close on hover, 'all' – pauses auto close for all notifications when any notification is hovered, 'notification' – pauses auto close only for the hovered notification
  • portalProps BasePortalProps — Props passed down to the Portal component
  • position NotificationPosition (default 'bottom-right') — Notifications default position
  • store NotificationsStore — Store for notifications state, can be used to create multiple instances of notifications system in your application
  • transitionDuration number (default 250) — Notification transition duration in ms
  • withinPortal boolean (default true) — Determines whether notifications container should be rendered inside Portal
  • zIndex string | number (default 400) — Notifications container z-index

Optional leading props map; remaining args are children.

Notifications — Mantine notifications system

https://mantine.dev/x/notifications

Props (docgen 9.5.0):

- **allowDragDismiss** `boolean` _(default `true`)_ — Determines whether notifications can be dismissed by dragging left or right
- **allowScrollDismiss** `boolean` _(default `true`)_ — Determines whether notifications can be dismissed with horizontal scroll gesture while hovered
- **autoClose** `number | false` _(default `4000`)_ — Auto close timeout for all notifications in ms, `false` to disable auto close, can be overwritten for individual notifications in `notifications.show` function
- **containerWidth** `string | number` _(default `440`)_ — Notification width, cannot exceed 100%
- **limit** `number` _(default `5`)_ — Maximum number of notifications displayed at a time, other new notifications will be added to queue
- **notificationMaxHeight** `string | number` _(default `200`)_ — Notification `max-height`, used for transitions
- **pauseResetOnHover** `"all" | "notification"` _(default `'all'`)_ — Determines which notifications should pause auto close on hover, `'all'` – pauses auto close for all notifications when any notification is hovered, `'notification'` – pauses auto close only for the hovered notification
- **portalProps** `BasePortalProps` — Props passed down to the `Portal` component
- **position** `NotificationPosition` _(default `'bottom-right'`)_ — Notifications default position
- **store** `NotificationsStore` — Store for notifications state, can be used to create multiple instances of notifications system in your application
- **transitionDuration** `number` _(default `250`)_ — Notification transition duration in ms
- **withinPortal** `boolean` _(default `true`)_ — Determines whether notifications container should be rendered inside `Portal`
- **zIndex** `string | number` _(default `400`)_ — Notifications container z-index

Optional leading props map; remaining args are children.
sourceraw docstring

providerclj/s

Alias for notifications — the renderer component that must be mounted once (inside MantineProvider) for the imperative notification fns to display anything.

Alias for `notifications` — the renderer component that must be mounted once
(inside MantineProvider) for the imperative notification fns to display anything.
sourceraw docstring

showclj/s

(show data)

Show a notification. The options map goes through the standard props converter: :message (required), :title, :color, :icon, :loading, :radius, :auto-close, :position, :priority, :id, :on-close, :on-open, ... Returns the notification id.

Show a notification. The options map goes through the standard props converter:
:message (required), :title, :color, :icon, :loading, :radius, :auto-close,
:position, :priority, :id, :on-close, :on-open, ... Returns the notification id.
sourceraw docstring

updateclj/s

(update data)

Update a shown notification; matched by :id in the options map (converted like show). Returns the id.

Update a shown notification; matched by :id in the options map (converted like
`show`). Returns the id.
sourceraw docstring

use-notificationsclj/s

Reactive hook over the default notifications store. Raw passthrough: returns the raw JS NotificationsState (read via interop: .-notifications, .-queue, ...).

Reactive hook over the default notifications store. Raw passthrough: returns the
raw JS NotificationsState (read via interop: .-notifications, .-queue, ...).
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close