Function IMaskInput

  • IMaskInput(props): null | ReactElement<any, string | JSXElementConstructor<any>>

  • Parameters

    • props: (Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & Omit<MaskedDateOptions, "mask"> & {
          mask: DateConstructor;
      } & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof MaskedDate;
      } & Omit<MaskedDateFactoryOptions, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & Partial<Pick<MaskedNumber, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "min" | "max" | "radix" | "thousandsSeparator" | "mapToRadix" | "scale" | "normalizeZeros" | "padFractionalZeros">> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof MaskedNumber;
      } & Omit<Partial<Pick<MaskedNumber, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "min" | "max" | "radix" | "thousandsSeparator" | "mapToRadix" | "scale" | "normalizeZeros" | "padFractionalZeros">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & Partial<Pick<MaskedPattern<string>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "definitions" | "blocks" | "placeholderChar" | "displayChar" | "lazy">> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof MaskedEnum;
      } & Omit<MaskedEnumOptions, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof MaskedRange;
      } & Omit<MaskedRangeOptions, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & Partial<Pick<MaskedRegExp, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix">> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof MaskedRegExp;
      } & Omit<Partial<Pick<MaskedRegExp, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & Partial<Pick<MaskedFunction<any>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix">> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof MaskedFunction;
      } & Omit<Partial<Pick<MaskedFunction<any>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof MaskedPattern;
      } & Omit<Partial<Pick<MaskedPattern<string>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "definitions" | "blocks" | "placeholderChar" | "displayChar" | "lazy">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & Partial<Pick<MaskedDynamic<any>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "dispatch">> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof MaskedDynamic;
      } & Omit<Partial<Pick<MaskedDynamic<any>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "dispatch">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: typeof Masked;
      } & Omit<Partial<Pick<Masked<any>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: MaskedDate;
      } & Omit<MaskedDateFactoryOptions, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: MaskedNumber;
      } & Omit<Partial<Pick<MaskedNumber, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "min" | "max" | "radix" | "thousandsSeparator" | "mapToRadix" | "scale" | "normalizeZeros" | "padFractionalZeros">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: MaskedEnum;
      } & Omit<MaskedEnumOptions, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: MaskedRange;
      } & Omit<MaskedRangeOptions, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: MaskedRegExp;
      } & Omit<Partial<Pick<MaskedRegExp, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: MaskedFunction<any>;
      } & Omit<Partial<Pick<MaskedFunction<any>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: MaskedPattern<string>;
      } & Omit<Partial<Pick<MaskedPattern<string>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "definitions" | "blocks" | "placeholderChar" | "displayChar" | "lazy">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: MaskedDynamic<any>;
      } & Omit<Partial<Pick<MaskedDynamic<any>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix" | "dispatch">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref"> | Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & {
          mask: Masked<any>;
      } & Omit<Partial<Pick<Masked<any>, "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "eager" | "skipInvalid" | "autofix">>, "mask"> & {
          ref?: Ref<ComponentType<IMaskInputProps<HTMLInputElement>>> | undefined;
      }, "ref">) & RefAttributes<unknown>

    Returns null | ReactElement<any, string | JSXElementConstructor<any>>

Properties

Readonly $$typeof

$$typeof: symbol

Optional defaultProps

defaultProps?: Partial<((Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & Omit<...> & { ...; } & { ...; }, "ref"> | ... 22 more ... | Omit<...>) & RefAttributes<...>)>

Deprecated

Use values for destructuring assignments instead.

Optional displayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Optional propTypes

propTypes?: WeakValidationMap<((Omit<ReactElementProps<HTMLInputElement> & Omit<ReactMaskProps<HTMLInputElement, AnyProps>, "ref"> & Omit<...> & { ...; } & { ...; }, "ref"> | ... 22 more ... | Omit<...>) & RefAttributes<...>)>

Settings

Member Visibility

Theme

On This Page

$$typeofdefaultPropsdisplayNamepropTypes