sparc - v1.0.1
    Preparing search index...

    Class NumberInput

    Abstract base class for rendering structured HTML elements with unique IDs, BEM-based class names, event management, and child support.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _children? _containerSelector _value isHTMD max? min? step? title

    Accessors

    _validationClass [toStringTag] children class containerSelector id instance isAlive isDisabled isLoading isValid modifierClasses name selector topClassBEM value wasTouched

    Methods

    _applyEventListeners _renderChildren _validate clearEventListeners remove render setEventHandler toggleDisabledState toggleLoadingState toString

    Constructors

    Properties

    Protected Optional_children

    _children?: HTMDNode

    Protected_containerSelector

    _containerSelector: string

    should be ...but for the sake of simplicity, when undefined ill assign an empty string Pardon me for the incoherence and read the HTMDElementInterface docs on the same property

    Protected_value

    _value: FormField<number>
    isHTMD: true

    Discriminator to identify classes that implement this interface

    isHTMDComponent

    max?: number
    min?: number
    step?: number
    title: string

    Accessors

    Private_validationClass

    • get _validationClass(): "" | "form-control--valid" | "form-control--invalid"

      Returns "" | "form-control--valid" | "form-control--invalid"

    • get children(): undefined | HTMDNode

      An HTMDNode to be rendered on the DOM When setting the property, If the element is loaded in the DOM, it's automatically refreshed

      Returns undefined | HTMDNode

    • set children(children: HTMDNode): void

      An HTMDNode to be rendered on the DOM When setting the property, If the element is loaded in the DOM, it's automatically refreshed

      Parameters

      Returns void

    • get class(): string

      A string containing all css classes attached to the element. Note that classes added via other methods will not be present here. Internally FormControls use modifierClasses, but external tools can also be used to add remove classes to the DOM. This is NOT the intended use.

      Setter method ensures that element classes are not removed

      Returns string

      MyElement.class ="special-class"
      console.log(MyElement.class) //`${SPARC_PREFIX}__${this.name} special-class`
    • set class(str: string): void

      A string containing all css classes attached to the element. Note that classes added via other methods will not be present here. Internally FormControls use modifierClasses, but external tools can also be used to add remove classes to the DOM. This is NOT the intended use.

      Setter method ensures that element classes are not removed

      Parameters

      • str: string

      Returns void

      MyElement.class ="special-class"
      console.log(MyElement.class) //`${SPARC_PREFIX}__${this.name} special-class`
    • get containerSelector(): string

      A css selector to specify where the element should be rendered When nesting elements, the parent should be responsible for assigning the containerSelector on its children

      Returns string

    • set containerSelector(selector: string): void

      A css selector to specify where the element should be rendered When nesting elements, the parent should be responsible for assigning the containerSelector on its children

      Parameters

      • selector: string

      Returns void

    • get id(): string

      By default an UUID is used. Can be overridden. This id can be used to identify both the object, and the DOM representation.

      Returns string

    • get instance(): null | JQuery<HTMLElement>

      Returns the jQuery DOM instance, if it is present in the DOM.

      Returns null | JQuery<HTMLElement>

    • get name(): string

      Returns the lowercase class name responsible for creating this object. This property is used to define the element's main class too

      Returns string

    • get selector(): string

      Returns the element's CSS selector.

      Returns string

      `${this._containerSelector} #${this.id}.${this.topClassBEM}`;

    Methods

    Protected_applyEventListeners

    Protected_renderChildren

    • _renderChildren(
          children?: undefined | HTMDNode,
          options?: { childContainerSelector?: string },
      ): void

      Handles child rendering, removing existing nodes from the DOM, and rendering them inside this element.

      Parameters

      • children: undefined | HTMDNode = ...
      • Optionaloptions: { childContainerSelector?: string }

      Returns void

      const childContainerSelector = undefined // this.children -> rendered directly on this.instance
      const childContainerSelector = ".child-wrapper" // this.children -> rendered on this.instance.find(".child-wrapper")

    Protected_validate

    • Removes specified event handlers, or all if none are specified.

      Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • OptionaleventsList: K | K[]

        An array of event types to clear (or a single type).

      Returns void

    • Appends the element to the DOM using the configured container selector.

      Parameters

      • shouldRenderChildren: boolean = true

        Whether to render child nodes.

      Returns void

    • Registers an event handler for a given event type on this element. Replaces any previously assigned handler for the same event.

      Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • eventName: K

        The DOM event type to listen for (e.g., 'click').

      • Optionalcallback: (ev: HTMLElementEventMap[K]) => void

        The event handler function.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods