Client

notify

fjsf.notify(data)

Displays a notification on the screen.

Notifications are stacked automatically and removed after the specified duration.


Parameters

  • data table Notification configuration object.

    Supported fields:

    • text string Main notification title.

    • description string | nil Secondary text displayed under the title.

    • type string | nil Preset visual style.

      Supported values:

      • success

      • error

      • warning

      • info

    • duration number | nil Display duration in milliseconds. Default: 5000

    • position string | nil Screen position where notifications are stacked.

      Supported values:

      • right-up

      • right-middle

      • right-down

      • center-up

      • center-middle

      • center-down

      • left-up

      • left-middle

      • left-down

    • icon string | nil Custom FontAwesome icon class. Overrides the icon provided by type.

    • iconAnim string | nil Optional icon animation class.

    • color string | nil Custom accent color (CSS value).

    • size string | nil Notification size.

      Allowed values:

      • small

      • medium

      • large

    • sounds boolean | nil Enables sound effect when the notification appears.


iconAnim

Optional animation applied to the notification icon.

Type: string | nil

Allowed values

  • spin

  • spinReverse

  • spinSlow

  • spinPulse

  • pulse

  • beat

  • beatFade

  • fade

  • blinkSoft

  • bounce

  • float

  • orbit

  • shake

  • wiggle

  • tick

  • tiltBreath

  • scan

  • polarFloat

Invalid values are ignored.


Returns

This function does not return anything.


Example


clearNotify

Removes all active notifications immediately.


Returns

This function does not return anything.


Example

Last updated