EnInputCurrency
Preview
Props
| Name | Description | Default | Control |
|---|---|---|---|
| wholeNumber | Rounds the return value to a whole number. boolean | false | |
| showDollarSymbol | Whether or not to show the dollar symbol as an input-group addon. boolean | true | |
| decimalLimit | Sets a limit on how many decimal places should be allowed. Use null for no limit number | 2 | |
| formatDisplay | Formats what is displayed in the input as a currency with commas and decimals; still returns a number for the value boolean | true | |
| showCents | Adds 2 decimal places of cents to whole numbers on mount. boolean | true | |
| 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 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 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 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' 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 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 boolean | Function | true | |
| renderInTable | Prevents a field from generating a column/heading in the 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
| Name | Type | Description |
|---|---|---|
display-value | unknown | — |
value | unknown | — |
Events
No events defined.
Methods
| Name | Description |
|---|---|
| focus | Focuses the input element. |