Skip to content

[docs][NumberField] Document format prop for units and currency #49160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZeeshanTamboli merged 3 commits into from
Sep 22, 2026
+9 −0
Merged

[docs][NumberField] Document format prop for units and currency #49160

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58d7257
[material-ui][NumberField] Document format prop for units and currency
Denimworld12 Sep 17, 2026
04233aa
Apply suggestion from @siriwatknp
siriwatknp Sep 18, 2026
cc72eb1
Merge branch 'master' into docs/number-field-format-units-currency
Denimworld12 Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/data/material/components/number-field/number-field.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,15 @@ This is ideal for touch devices and narrow ranges of values.

{{"demo": "SpinnerDemo.js"}}

## Units and currency

Both fields above use the input's end adornment for the increment and decrement buttons, so that slot is not available for a unit or currency symbol.
Use the [`format`](https://base-ui.com/react/components/number-field#NumberFieldRoot-format) prop instead—it accepts [`Intl.NumberFormatOptions`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) and is forwarded to the Base UI `NumberField.Root`:

```jsx
<NumberField label="Price" format={{ style: 'currency', currency: 'USD' }} />
```

## Base UI API

See the documentation below for a complete reference to all of the props.
Expand Down
Loading