React-AutoNumeric: AutoNumeric-Powered React Components

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

<AutoNumericInput />

creates an input component that is automatically formatted by AutoNumeric.

Customize the input

<AutoNumericInput
  inputProps={{ defaultValue: "99.99" }}
  autoNumericOptions={{ suffixText: "%" }}
/>

Use predefined AutoNumeric options

<AutoNumericInput
  inputProps={{ defaultValue: "10000" }}
  autoNumericOptions={
    AutoNumeric.getPredefinedOptions().commaDecimalCharDotSeparator
  }
/>

Interact with AutoNumericInput via a React state

const [controlledInputState, setControlledInputState] = useState("100000");

<AutoNumericInput
  valueState={{
    state: controlledInputState,
    stateSetter: setControlledInputState,
  }}
/>
<button
  onClick={() => {
    setControlledInputState(
      (
        Number(AutoNumeric.unformat(controlledInputState)) + 1
      ).toString(),
    );
  }}
>
  Add one
</button>

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.

Related Project

If you use Material UI, check out material-ui-autonumeric.

License

Copyright 2024 8 Hobbies, LLC <[email protected]>

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.