functional

Functional API for Streamlit Notify (For Streamlit Extras).

streamlit_notify.functional.toast_stn(*args, **kwargs)[source]

Display a toast notification.

Parameters:
Return type:

None

streamlit_notify.functional.balloons_stn(*args, **kwargs)[source]

Display a balloons notification.

Parameters:
Return type:

None

streamlit_notify.functional.snow_stn(*args, **kwargs)[source]

Display a snow notification.

Parameters:
Return type:

None

streamlit_notify.functional.success_stn(*args, **kwargs)[source]

Display a success notification.

Parameters:
Return type:

None

streamlit_notify.functional.info_stn(*args, **kwargs)[source]

Display an info notification.

Parameters:
Return type:

None

streamlit_notify.functional.error_stn(*args, **kwargs)[source]

Display an error notification.

Parameters:
Return type:

None

streamlit_notify.functional.warning_stn(*args, **kwargs)[source]

Display a warning notification.

Parameters:
Return type:

None

streamlit_notify.functional.exception_stn(*args, **kwargs)[source]

Display an exception notification.

Parameters:
Return type:

None

streamlit_notify.functional.create_notification(*args, **kwargs)[source]

Create a notification without adding it to the queue.

Parameters:
Return type:

StatusElementNotification

streamlit_notify.functional._resolve_types(notification_type)[source]

Resolve notification types.

Parameters:

notification_type (Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception'] | ~typing.Iterable[~typing.Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception']] | None)

Return type:

List[Literal[‘toast’, ‘balloons’, ‘snow’, ‘success’, ‘info’, ‘error’, ‘warning’, ‘exception’]]

streamlit_notify.functional.notify(notification_type=None, remove=True, priority=None, priority_type='ge')[source]

Display queued notifications.

Parameters:

  • notification_type (Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception'] | ~typing.Iterable[~typing.Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception']] | None)

  • remove (bool)

  • priority (int | None)

  • priority_type (Literal['le', 'ge', 'eq'])

Return type:

None

streamlit_notify.functional.get_notifications(notification_type=None, priority=None, priority_type='ge')[source]

Retrieve all notifications for a specific type(s).

Parameters:

  • notification_type (Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception'] | ~typing.Iterable[~typing.Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception']] | None)

  • priority (int | None)

  • priority_type (Literal['le', 'ge', 'eq'])

Return type:

List[StatusElementNotification]

streamlit_notify.functional.clear_notifications(notification_type=None)[source]

Clear notifications for a specific type(s).

Parameters:

notification_type (Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception'] | ~typing.Iterable[~typing.Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception']] | None)

Return type:

None

streamlit_notify.functional.get_notification_queue(notification_type)[source]

Retrieve notification priority queue.

Parameters:

notification_type (Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception'])

Return type:

NotificationPriorityQueue

streamlit_notify.functional.has_notifications(notification_type=None)[source]

Check if there are any notifications.

Parameters:

notification_type (Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception'] | ~typing.Iterable[~typing.Literal['toast', 'balloons', 'snow', 'success', 'info', 'error', 'warning', 'exception']] | None)

Return type:

bool

streamlit_notify.functional.remove_notifications(notifications)[source]

Remove notification(s) from the queue.

Parameters:

notifications (StatusElementNotification | Iterable[StatusElementNotification])

Return type:

None

streamlit_notify.functional.add_notifications(notifications)[source]

Add notification(s) to the queue.

Parameters:

notifications (StatusElementNotification | Iterable[StatusElementNotification])

Return type:

None