Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISnackbarBuilder

A class to build a snackbar.

api-version

1

user

Hierarchy

  • ISnackbarBuilder

Index

Methods

  • Set an action button.

    api-version

    1

    user

    Parameters

    • text: string

      A text to display in the button.

    • enabled: boolean

      True if this view is enabled, false otherwise.

    • listener: OnActionClickListener

      This method will be invoked when an action button in the snackbar is clicked.

    Returns ISnackbarBuilder

  • Set a close button in the snackbar. The button is shown at top right corner in the snackbar.

    api-version

    1

    user

    Parameters

    • enabled: boolean

      Set whether the close button is enabled or not.

    Returns ISnackbarBuilder

  • Set a message. The message is mandatory, so it couldn't be empty.

    api-version

    1

    user

    Parameters

    • text: string

      A text to display in the content.

    Returns ISnackbarBuilder

  • Set whether to persistently display snackbar. The Snackbar by default stays on for 3 seconds and then disappears.

    api-version

    1

    user

    Parameters

    • persistent: boolean

      Set whether to persistently display snackbar.

    Returns ISnackbarBuilder

  • Set whether to prevent duplicated snackbar.

    api-version

    1

    user

    Parameters

    • preventDuplicated: boolean

      Ignores displaying multiple snackbars with the same 'type', 'title' and 'message'.

    Returns ISnackbarBuilder

  • Set a progressbar. If this is set, then {@link @mui/material/LinearProgress} will be shown in the snackbar.

    api-version

    1

    user

    Parameters

    • determinate: boolean

      Whether allows to enable the indeterminate mode or determinate.

    • progress: number

      Default progress value. Value between 0 and 100. It is work on only determinate mode.

    Returns ISnackbarBuilder

Generated using TypeDoc