Methane@methane-ui/*
CSS LayoutsComponentsSkillsTheme BuilderGitHub
← All Components

<mth-masked-input>

@methane-ui/ui~11.2 KB brotli (cold + Lit)~3.8 KB marginal

Form-associated pattern-masked input powered by MaskAndFormatEngine with cursor-preserving editing and completeness validation.

When NOT to use: Use a lightweight @methane-ui/css layout class instead of a custom element when static CSS suffices.

Live Interactive Preview

Interactive StageLive Custom Element · <mth-masked-input> (@methane-ui/ui)
Ready · interact with <mth-masked-input>, or toggle Theme, Direction (LTR/RTL), or props above.

Multi-Framework Playground & Snippets

<script type="module" src="@methane-ui/ui/masked-input"></script>
<mth-masked-input mask="0000-0000"></mth-masked-input>

Properties & Attributes

PropertyAttributeTypeDefaultDescription
valuevaluestring""Formatted (or unmasked if unmaskOnSubmit) input string.
namenamestring""Form submission field name.
labellabelstring""Accessible label rendered inside shadow root.
hinthintstring""Helper text displayed below control.
errorerrorstring""Explicit custom error message.
placeholderplaceholderstring""Placeholder displayed when empty.
autocompleteautocompletestring""HTML autocomplete attribute forwarded to the control.
maskmaskstring"0000-0000"Mask template (0/9/# digit, A letter, * alphanumeric).
unmaskOnSubmitunmask-on-submitbooleanfalseSubmits raw unmasked value in FormData while displaying formatted value.
disableddisabledbooleanfalseDisables user interaction.
requiredrequiredbooleanfalseMarks field required.
readonlyreadonlybooleanfalsePrevents edits while remaining focusable.

Events

EventDetail TypeDescription
mth-input{ value: string; unmasked: string; complete: boolean }Fired synchronously when masked input updates.
mth-change{ value: string; unmasked: string; complete: boolean }Fired when edited value commits.

APG Keyboard Matrix

KeyDirectionWhenExpected Behavior
Enterbothinside a form and not composing IMErequests submission of owning form

Accessibility Checklist

CategoryRequirementVerified By
ariaAll aria-* IDREFs resolve within the same DOM root (ADR-003).scanSameRootAria
focusdelegatesFocus: true with zero host internals.role (ADR-014).lint-plugin & spec-compiler
contrastRenders legible borders, focus outlines, and selection indicators under forced-colors: active.Playwright forced-colors matrix
keyboardImplements all 1 APG keyboard transitions across LTR/RTL.mth-masked-input.spec.test.ts
statesExposes ElementInternals CustomStateSet flags: :state(dirty), :state(touched), :state(user-invalid), :state(disabled), :state(required), :state(readonly).Conformance suite
i18nRoutes 3 UI/ARIA strings through @methane-ui/core i18n catalog.Locale context test