Function getNumber

  • getNumber(
        options?: {
            classes?: string[];
            dialog?: object;
            hint?: string;
            initial?: number;
            label?: string;
            max?: number;
            min?: number;
            placeholder?: string;
            render?: Function;
            step?: number;
            title?: string;
        },
    ): Promise<number>

  • Query for a number from current user.

    Parameters

    • Optionaloptions: {
          classes?: string[];
          dialog?: object;
          hint?: string;
          initial?: number;
          label?: string;
          max?: number;
          min?: number;
          placeholder?: string;
          render?: Function;
          step?: number;
          title?: string;
      } = {}

      Additional options

      • Optionalclasses?: string[]

        CSS classes to add.

      • Optionaldialog?: object

        Additional dialog options. Merged with the other DialogV2 options.

      • Optionalhint?: string

        A hint displayed under the input.

      • Optionalinitial?: number

        Initial value

      • Optionallabel?: string

        A label preceding the number input.

      • Optionalmax?: number

        Maximum value

      • Optionalmin?: number

        Minimum value

      • Optionalplaceholder?: string

        Placeholder value or description.

      • Optionalrender?: Function

        Render callback. Passed onto DialogV2.

      • Optionalstep?: number

        Value stepping

      • Optionaltitle?: string

        Dialog title

    Returns Promise<number>

    Provided value

    Example

    const num = await pf1.utils.dialog.getNumber({
      placeholder: "NaN",
      hint: "Amazing",
      label: "Gimme a number",
    });

Settings

Member Visibility