• Query for a number from current user.

    Parameters

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

      Additional options

      • classes: undefined | string[]

        CSS classes to add.

      • dialog: undefined | object

        Additional dialog options. Merged with the other DialogV2 options.

      • hint: undefined | string

        A hint displayed under the input.

      • initial: undefined | number

        Initial value

      • label: undefined | string

        A label preceding the number input.

      • max: undefined | number

        Maximum value

      • min: undefined | number

        Minimum value

      • placeholder: undefined | string

        Placeholder value or description.

      • render: undefined | Function

        Render callback. Passed onto DialogV2.

      • step: undefined | number

        Value stepping

      • title: undefined | string

        Dialog title

    Returns Promise<number>

    Provided value

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