Skip to content

API ReferenceReact componentsVariable

TokenAmountInput

const TokenAmountInput: ForwardRefExoticComponent<
TokenAmountInputProps & RefAttributes<TokenAmountInputElement>
>;

Beta

TokenAmountInput is an input component pre-configured to handle token amount entry. The field is limited to numeric entry, and has a custom change handler to report the fields raw value as well as the parsed bigint based on the provided token decimals (if present).

allowNegative defaults to false since a token amount can never be negative; pass allowNegative explicitly to override.

Renders the headless BaseInput by default, which carries no border, background, or focus ring of its own — it expects an enclosing field-container (or InputGroup) to supply that chrome, matching how loc-form and redeem-loc-form use it. When placing this input standalone (outside a field-container), pass customInput={Input} from @anvil/ui/components/input to get the self-contained styled control.

Param

props

Input component props

Returns

Remarks

Part of the SDK’s experimental React component surface — may change or be removed without notice and is not part of the compatibility contract. The supported React surface is the hooks and the provider.