Money
Collect monetary values from users with built-in currency formatting and validation.
Anchor to propertiesProperties
- Anchor to autocompleteautocompleteautocompletestringstringDefault: 'on' for everything elseDefault: 'on' for everything else
A hint as to the intended content of the field.
When set to
on(the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.When set to
off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.
- Anchor to defaultValuedefaultValuedefaultValuestringstring
The default value for the field.
- Anchor to detailsdetailsdetailsstringstring
Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user.
This will also be exposed to screen reader users.
- Anchor to disableddisableddisabledbooleanbooleanDefault: falseDefault: false
Disables the field, disallowing any interaction.
- Anchor to errorerrorerrorstringstring
Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
- Anchor to idididstringstring
A unique identifier for the element.
- Anchor to labellabellabelstringstring
Content to use as the field label.
- Anchor to labelAccessibilityVisibilitylabelAccessibilityVisibilitylabelAccessibilityVisibility"visible" | "exclusive""visible" | "exclusive"Default: 'visible'Default: 'visible'
Changes the visibility of the component's label.
visible: the label is visible to all users.exclusive: the label is visually hidden but remains in the accessibility tree.
- Anchor to maxmaxmaxnumbernumberDefault: InfinityDefault: Infinity
The highest decimal or integer to be accepted for the field. When used with
stepthe value will round down to the max number.Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation.
- Anchor to minminminnumbernumberDefault: -InfinityDefault: -Infinity
The lowest decimal or integer to be accepted for the field. When used with
stepthe value will round up to the min number.Note: a user will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation.
- Anchor to namenamenamestringstring
An identifier for the field that is unique within the nearest containing form.
- Anchor to placeholderplaceholderplaceholderstringstring
A short hint that describes the expected value of the field.
- Anchor to readOnlyreadOnlyreadOnlybooleanbooleanDefault: falseDefault: false
The field cannot be edited by the user. It is focusable will be announced by screen readers.
- Anchor to requiredrequiredrequiredbooleanbooleanDefault: falseDefault: false
Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the
errorproperty.- Anchor to valuevaluevaluestringstring
The current value for the field. If omitted, the field will be empty.
Anchor to eventsEvents
Learn more about registering events.
- Anchor to blurblurblurCallbackEventListener<'input'>CallbackEventListener<'input'>
- Anchor to changechangechangeCallbackEventListener<'input'>CallbackEventListener<'input'>
- Anchor to focusfocusfocusCallbackEventListener<'input'>CallbackEventListener<'input'>
- Anchor to inputinputinputCallbackEventListener<'input'>CallbackEventListener<'input'>
CallbackEventListener
(EventListener & {
(event: CallbackEvent<T>): void;
}) | nullCallbackEvent
Event & {
currentTarget: HTMLElementTagNameMap[T];
}Preview
Examples
Code
jsx
<s-money-field label="Regional Price" placeholder="99.99" details="Recommended price for the European market" />html
<s-money-field label="Regional Price" placeholder="99.99" details="Recommended price for the European market" ></s-money-field>Basic usage
Description
Demonstrates a simple money field with a label, initial value, and numeric constraints.
jsx
<s-money-field label="Price" value="19.99" min={0} max={1000} />html
<s-money-field label="Price" value="19.99" min="0" max="1000" ></s-money-field>With validation limits
Description
Showcases a money field with explicit minimum and maximum value limits, and a detailed description for user guidance.
jsx
<s-money-field label="Discount amount" value="5.00" min={0} max={100} details="Enter discount amount between $0 and $100" />html
<s-money-field label="Discount amount" value="5.00" min="0" max="100" details="Enter discount amount between $0 and $100" ></s-money-field>Basic field
Description
Illustrates a money field demonstrating basic error handling and validation.
jsx
<s-money-field label="Product cost" value="29.99" min={0.01} error="Product cost is required" />html
<s-money-field label="Product cost" value="29.99" min="0.01" error="Product cost is required" ></s-money-field>Currency formatting with form integration
Description
Displays multiple money fields in a vertical stack, showing how to integrate multiple currency inputs in a form with varied details and constraints.
jsx
<s-stack direction="block" gap="base"> <s-money-field label="Price" value="0.00" min={0.01} max={99999.99} details="Customers will see this price" /> <s-money-field label="Compare at price" value="" min={0} max={99999.99} details="Show customers the original price when on sale" /> <s-money-field label="Cost per item" value="" min={0} max={99999.99} details="Customers won't see this" /> </s-stack>html
<s-stack direction="block" gap="base"> <s-money-field label="Price" value="0.00" min="0.01" max="99999.99" details="Customers will see this price" ></s-money-field> <s-money-field label="Compare at price" value="" min="0" max="99999.99" details="Show customers the original price when on sale" ></s-money-field> <s-money-field label="Cost per item" value="" min="0" max="99999.99" details="Customers won't see this" ></s-money-field> </s-stack>Money field validation
Description
Interactive example showing real-time validation with min/max limits and dynamic error messages.
jsx
const [amount, setAmount] = useState('150'); const [error, setError] = useState('Value must be no more than $100'); return ( <s-section> <s-stack gap="base" justifyContent="start"> <s-text-field label="Product name" /> <s-money-field label="Discount amount" value={amount} min={0} max={100} details="Enter discount amount between $0 and $100" error={error} onInput={(e) => { setAmount(e.currentTarget.value); const val = parseFloat(e.currentTarget.value); setError(val > e.currentTarget.max ? 'Value must be no more than $100' : val < e.currentTarget.min ? 'Value must be at least $0' : ''); }} /> </s-stack> </s-section> )