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 | |
| 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 | |
| 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. |