Skip to content

EnInputSsn ​

Preview ​

Props ​

NameDescriptionDefaultControl
allowEinFormat

Allows EIN style formatting (##-#######).

boolean
true
allowDummySsn

Allows dummy SSN values through the validation.

boolean
false
assumeTin

If an unformatted string is passed to the component, the default masking will be set to the TIN format.

boolean
false
resetValidationOnMount

Resets validation on mount.

boolean
false
obscure

Renders the field in "secure" mode: every digit is masked with * while remaining editable (the real, unmasked value is still tracked and emitted via v-model for form submission). A button toggles the mask off to reveal the full value and back on again. SSN vs. EIN/TIN detection works the same as the normal field: a dash typed as the 3rd character selects EIN/TIN format (and the * overlay shows the dash), otherwise SSN. assumeTin / allowEinFormat still force a format when set.

Also applies in displayOnly mode: the static value is rendered with every digit replaced by *. Pair with allowReveal to add an inline button for revealing/hiding it.

boolean
false
allowReveal

In displayOnly + obscure mode, shows an inline button to toggle the masked value between hidden (*) and revealed. Has no effect on the editable field (which always shows its toggle).

boolean
false
value

Used for a raw value passed into the input.

string | number
unknown
name

Sets name attribute for the input. Required for proper form handling.

string
null
id

Sets id attribute for input. If left blank, it will default to the name prop. This should always be matched to a label's "for" attribute for proper accessibility.

string
null
placeholder

Sets the placeholder value.

string
null
label

Used to describe field in error message

string
null
disabled

Sets the disabled attribute.

boolean
null
required

Sets the field to required.

boolean
false
critical

Flags the field as critical. Critical is not required: a required field blocks saving, while a critical field saves fine empty but blocks something later, such as activating or completing a record. Use it for "you will need this before you can finish", not "you must enter this now".

While the field is empty, the control takes the critical-field highlight, the element that carries has-error also carries is-critical, and a surrounding EnFormGroup adds a warning icon beside its label. Both clear once the field holds a value and return if it is cleared again: the yellow means "this important field is empty right now". A real error still wins.

boolean
false
locked

Locks the field: disables the control and marks it with a lock icon. Text-like controls show the lock inside the input, in the spot a select keeps its arrow. Option groups, booleans and file inputs have no box to put it in, so they show it beside the label of a surrounding EnFormGroup.

boolean
false
lockedMessage

Why the field is locked, for example "Locked while payroll is open". Shown as a tooltip when the pointer rests on the locked control, and on the lock icon beside the label, which becomes focusable so keyboard users can reach the text (the disabled control itself cannot take focus). Rendered through en-components' v-tooltip directive, which the consuming app registers.

string
""
typeCast

Used to specifically validate different types.

string
"string"
mode

Sets when and how often validation occurs. TODO: create docs for modes

string
"eager"
displayOnly

Displays the value of the field in a span element, instead of as an input.

boolean
false
emptyValue

What a displayOnly field shows in place of an empty value. Off by default, so an empty field renders nothing. true shows an em dash; a string shows that text instead. The placeholder is drawn in gray-700 so it reads as "nothing here" rather than as a value. EnForm and EnFormGroup take the same prop and hand it to every field they display.

string | boolean
false
rules

A pipe separated string of validation rules for the field. View validation rules

string
""
renderInForm

Prevents a field from being rendered at all when used in the fields prop of the EnForm component. Can be passed a function that returns true or false for conditional validation.

boolean | Function
true
renderInTable

Prevents a field from generating a column/heading in the EnTableBasic component. Can be passed a function that returns true or false for conditional validation.

boolean | Function
true
customMessages

Provide a custom error messages by rule. Should be an object with keys that match the rule name and value being a string of the message to display.

Record<string, any>
null

Slots ​

display

No description

Variables
NameTypeDescription
display-valueunknown—
valueunknown—

Events ​

No events defined.

Methods ​

NameDescription
focus

Focuses the input element.