Input Mask

There are different input mask types available in this primitives library.

warning

See the @solid-primitives docs for usage. Described below is the binding API/types.

`InputMask`

Type: Erased DU

type InputMask

`Fn of InputMaskFn`

type InputMaskFn = delegate of value: string * selection: Selection -> value: string

type Selection = Selection of start: float * finish: float

`Array of InputMaskArray`

type InputMaskArray = InputMaskArray of U2<string, Regex>[]

`Regex of InputMaskRegex`

type InputMaskRegex = InputMaskRegex of regex: Regex * replacer: (obj -> string)

`String of string`

Bindings

details

[<AutoOpen; Erase>]
type InputMask =
    [<ImportMember(Spec.path)>]
    static member stringMaskToArray(mask: string, ?regexps: Map<string, Regex>): InputMask.InputMaskArray = jsNative
    [<ImportMember(Spec.path)>]
    static member regexMaskToFn(regex: Regex, replacer: obj): InputMask.InputMaskFn = jsNative
    [<ImportMember(Spec.path)>]
    static member maskArrayToFn(maskArray: InputMask.InputMaskArray): InputMask.InputMaskFn = jsNative
    [<ImportMember(Spec.path)>]
    static member anyMaskToFn(mask: InputMask.InputMask, ?regexps: Map<string, Regex>): InputMask.InputMaskFn = jsNative
    [<ImportMember(Spec.path)>]
    static member createInputMask<'MaskEvent>(mask: InputMask.InputMask, ?regexps: Map<string, Regex>): 'MaskEvent -> string = jsNative
    static member inline createKeyboardInputMask(mask: InputMask.InputMask, ?regexps: Map<string, Regex>) =
        InputMask.createInputMask<KeyboardEvent>(mask, ?regexps = regexps)
    static member inline createInputInputMask(mask: InputMask.InputMask, ?regexps: Map<string, Regex>) =
        InputMask.createInputMask<InputEvent>(mask, ?regexps = regexps)
    static member inline createClipboardInputMask(mask: InputMask.InputMask, ?regexps: Map<string, Regex>) =
        InputMask.createInputMask<ClipboardEvent>(mask, ?regexps = regexps)
    [<ImportMember(Spec.path)>]
    static member createMaskPattern<'MaskEvent>(inputMask: 'MaskEvent -> string, pattern: string -> string): 'MaskEvent -> string = jsNative
    static member inline createKeyboardMaskPattern(inputMask: KeyboardEvent -> string, pattern: string -> string) =
        InputMask.createMaskPattern<KeyboardEvent>(inputMask,pattern)
    static member inline createInputMaskPattern(inputMask: InputEvent -> string, pattern: string -> string) =
        InputMask.createMaskPattern<InputEvent>(inputMask,pattern)
    static member inline createClipboardMaskPattern(inputMask: ClipboardEvent -> string, pattern: string -> string) =
        InputMask.createMaskPattern<ClipboardEvent>(inputMask,pattern)

Last updated: 9/19/25, 4:29 PM