Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SnackbarInterface

Interface used to handle a snackbar.

api-version

1

user

Hierarchy

  • SnackbarInterface

Index

Methods

Methods

dismiss

  • dismiss(): void

getProgress

  • getProgress(): number

  • Get current progress. If progress is not set as 'determinate' then it will be return 0 always.

    api-version

    1

    user

    Returns number

    A value of the current progress.

setMessage

  • setMessage(text: string): void

  • 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 void

setProgress

  • setProgress(progress: number): void

  • Set a value of the progress indicator for the determinate. Value between 0 and 100. It is applied when only the snackbar has been set a progressbar as 'determinate' through ISnackbarBuilder.setProgress.

    api-version

    1

    user

    Parameters

    • progress: number

      A value of the progress indicator for the determinate. Value between 0 and 100.

    Returns void

setTitle

  • setTitle(text: null | string): void

  • Set a title text. If user set a text as null or empty then the title view's area will be gone.

    api-version

    1

    user

    Parameters

    • text: null | string

      A text to display in the title.

    Returns void

Generated using TypeDoc