Skip to Main Content

 

Modern visual theme Learn about visual thememore

Autonumeric

The autonumeric directive automatically formats currency and other numbers that users enter in form inputs. This directive wraps the third-party autoNumeric library. For in-depth information about autoNumeric and its capabilities, see the autoNumeric documentation.

Development

Examples

Development

Link for section titled InstallationInstallation

NPM package

@skyux/autonumericView in NPM | View in GitHub None found.

Install with NPM

npm install --save-exact @skyux/autonumeric

Copy None found.

Link for section titled SkyAutonumericModuleSkyAutonumericModule

Type: Module

import { SkyAutonumericModule } from '@skyux/autonumeric';

Link for section titled SkyAutonumericDirectiveSkyAutonumericDirective

Type: Directive

Selector: input[skyAutonumeric]

Wraps the autoNumeric utility to format any type of number, including currency.

Inputs

skyAutonumeric: SkyAutonumericOptions | undefined

Assigns the name of a property from SkyAutonumericOptionsProvider.

Link for section titled SkyAutonumericOptionsSkyAutonumericOptions

Type: Type alias

Custom options to provide to the underlying AutoNumeric library. The value can be set to string, which is an alias that represents a set of predefined set of options for a currency or language, or Options, which is a custom set of options that override any default options that the skyAutonumeric attribute specifies.

type SkyAutonumericOptions = string | keyof AutoNumeric.PredefinedOptions | AutoNumeric.Options

Link for section titled SkyAutonumericOptionsProviderSkyAutonumericOptionsProvider

Type: Service

Provides options to the underlying AutoNumeric library. This can set global options on multiple input fields.

Methods

getConfig(): SkyAutonumericOptions

The value for a settings object to pass to the AutoNumeric library. This overrides any default options specified by the skyAutonumeric attribute.

Returns

SkyAutonumericOptions