«number» Component Type

📖 Table of Contents

Introduction

The number component type extends the Input component type, providing additional sanitation (when importing) and formatting (when exporting).

  • Imports and Exports: Number
  • Singleton Pattern: Implements the Singleton Pattern
  • Data Conversion: Converts inappropriate types (like String) to Number on the fly.

Usage

To use the number component type, ensure that the target field is an INPUT element of type number. If the type attribute is not specified, it will be set to number automatically.

Example:

<!-- Example of number input field -->
<input type="number" data-smark='{"name":"age"}' placeholder="Enter your age">

Validations

The number component will throw an error if the target field is not an INPUT element of type number.

API Reference

Actions

Actions are special component methods that can be triggered both programmatically (by directly calling the function) or by user interaction with a trigger component. Each action is associated with a specific behavior that can be performed on the component.

👉 Actions receive an options object as an argument, which contains the necessary information to perform the action.

👉 When called from triggers, the properties defined in their data-smark object, are passed as options to the action. Those expecting a path(★ ) to other components are resolved to the actual component.

The number component type supports the following actions:

(Async) export (Action)

Exports the value of the number input field. If the value is not a valid number, it returns null.

Options (export)
  • action: (= “export”)
  • origin: Origin is automatically set to the trigger component that called the action (and cannot be overridden). In case of a manual call, it is set to Null.
  • context: Path★ (absolute or relative to its natural context) to the component that is the context of the action. If not provided, the context is set to its natural context.
  • target: Path★ (absolute or relative to its context). Pipes the exported data to the import action of the target component.
  • data:

(Async) import (Action)

Imports a value into the number input field. If the value is not a valid number or string that can be converted to a number, it sets the field to null.

Options (import)
  • action: (= “import”)
  • origin: Origin is automatically set to the trigger component that called the action (and cannot be overridden). In case of a manual call, it is set to Null.
  • context: Path★ (absolute or relative to its natural context) to the component that is the context of the action. If not provided, the context is set to its natural context.
  • target: Path★ (absolute or relative to its context). Pipes the imported data from the export action of the target component, overridding the “data” option if specified.
  • data: (number or string)
  • focus: (boolean, default true)

(Async) clear (Action)

Clears the value of the number input field (sets it to null).

Options (clear)
  • action: (= “clear”)
  • origin: Origin is automatically set to the trigger component that called the action (and cannot be overridden). In case of a manual call, it is set to Null.
  • context: Path★ (absolute or relative to its natural context) to the component that is the context of the action. If not provided, the context is set to its natural context.
Component Types
«input» Component Type
Component Types
«color» Component Type