https://github.com/8hobbies/react-autonumeric
Autonumeric-Powered React components.
https://github.com/8hobbies/react-autonumeric
autonumeric react
Last synced: about 2 months ago
JSON representation
Autonumeric-Powered React components.
- Host: GitHub
- URL: https://github.com/8hobbies/react-autonumeric
- Owner: 8hobbies
- License: apache-2.0
- Created: 2024-04-18T05:59:59.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-31T21:19:55.000Z (2 months ago)
- Last Synced: 2025-03-31T22:25:04.702Z (2 months ago)
- Topics: autonumeric, react
- Language: TypeScript
- Homepage: https://react-autonumeric.8hob.io/
- Size: 764 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# React-AutoNumeric: [AutoNumeric][]-Powered React Components
[](https://badge.fury.io/js/react-autonumeric)
[](https://github.com/8hobbies/react-autonumeric/actions/workflows/runtime.yml)
[](https://gitlab.com/8hobbies/react-autonumeric)
[](https://react-autonumeric.8hob.io/demo)
[AutoNumeric][] is a powerful library that automatically format numbers and currencies.
React-AutoNumeric brings that power to React.
## Install
```
npm install --save react-autonumeric
```
## Usage
### Most basic usage
```tsx
```
creates an [input component][] that is automatically formatted by AutoNumeric.
### Customize the input
```tsx
```
### Use predefined AutoNumeric options
```tsx
```
### Interact with `AutoNumericInput` via a React state
```tsx
const [controlledInputState, setControlledInputState] = useState("100000");
{
setControlledInputState(
(
Number(AutoNumeric.unformat(controlledInputState)) + 1
).toString(),
);
}}
>
Add one
```
### API References
For more detailed usage, check out the {@link AutoNumericInput} in the [API References][].
### Non-Input Usage
If you would like a component other than input that is automatically formatted by AutoNumeric,
please consult {@link AutoNumericComponent} in the [API References][].
## Demo
There is a publicly available [live demo](https://react-autonumeric.8hob.io/demo).
## Related Project
If you use [Material UI][], check out [material-ui-autonumeric][].
## License
```text
Copyright 2024 8 Hobbies, LLC
Licensed under the Apache License, Version 2.0(the "License");
you may not use files in this project except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
[AutoNumeric]: https://autonumeric.org/
[input component]: https://react.dev/reference/react-dom/components/input
[API References]: https://react-autonumeric.8hob.io
[Material UI]: https://mui.com/material-ui/
[material-ui-autonumeric]: https://material-ui-autonumeric.8hob.io/