Function usePrompt

A function that creates and displays a prompt modal.

  • usePrompt(
        usePrompt?: IParams,
    ): (
        __namedParameters?: Partial<IParams>,
    ) => { then: (onData: Fn) => void; toPromise: () => Promise<null | string> }

    Parameters

    • OptionalusePrompt: IParams

      The configuration options for the prompt.

      • title

        The title of the prompt modal.

      • value

        The default value of the prompt input.

      • placeholder

        The placeholder text for the prompt input.

      • canCancel

        Whether the prompt can be cancelled.

      • large

        Whether to display a large prompt modal.

    Returns (
        __namedParameters?: Partial<IParams>,
    ) => { then: (onData: Fn) => void; toPromise: () => Promise<null | string> }

    A function that creates and displays the prompt modal when called.

Settings

Member Visibility