Tipler
Dışa aktarılan TypeScript tipleri.
Pakette any yoktur. Alan adları, from, name ve rules form tipinden (ya da Zod resolver'ın girdi tipinden) çıkarılır.
PresetName
type PresetName =
| "phone" | "iban" // + country: "TR"
| "card" | "cvv" | "expiry"
| "tckn" | "vkn" | "plate"
| "fullName"
| "currency" | "number" // + country: "TR"
| "date"
type ErrorKey = `${string}.${string}` // "tckn.invalid"MaskOptions
// mask, number, currency ve date birbirini dışlar
type MaskOptions =
| { mask: string | string[] | ((value: string, ctx: MaskContext) => string)
tokens?: Record<string, RegExp | { pattern: RegExp; transform?: (char: string) => string }>
transform?: "uppercase" | "lowercase"
normalize?: (value: string) => string
eager?: boolean }
| { number: { locale?: string; min?: number; max?: number; scale?: number; signed?: boolean } }
| { currency: string | { code?: string; locale?: string; min?: number; max?: number; scale?: number } }
| { date: { format?: DateFormat; min?: DateLimit; max?: DateLimit; minAge?: number } }
// hepsinde:
// validate?: (value: string, ctx: MaskContext) => boolean | ErrorKey
// inputMode?, autoComplete?, type?: "text" | "tel"Schema ve alanlar
type ViraFieldConfig<T> =
| PresetName
| Preset
| ({ name?: Path<T>; from?: Path<T>; rules?: RegisterOptions<T>
output?: "raw" | "masked"; onComplete?: (value: string) => void }
& ({ preset: PresetName | Preset } | MaskOptions))
// anahtar form yolu değilse name zorunludur
function useViraMask<T, K extends string>(
form: UseFormReturn<T>,
schema: { [P in K]: P extends Path<T> ? ViraFieldConfig<T> : ViraFieldConfig<T> & { name: Path<T> } },
): { readonly [P in K]: MaskField }
interface MaskField {
name: string
ref: RefCallback<HTMLInputElement>
defaultValue: string
onChange, onBlur, onCompositionEnd
type: "text" | "tel"
inputMode: InputMode
autoComplete?: string
disabled?: boolean
"aria-invalid"?: true
}
interface Mask {
format(value: unknown, ctx?: MaskContext): string
parse(input: string, ctx?: MaskContext): string
validate(value: unknown, ctx?: MaskContext): ErrorKey | undefined
isComplete(value: string, ctx?: MaskContext): boolean
}