Class HTMDElementAbstract

constructor

• new HTMDElement(children?: HTMDNode, props?: HTMDElementProps): HTMDElement

  Parameters

  • Optionalchildren: HTMDNode
  • props: HTMDElementProps = {}

  Returns HTMDElement

isHTMD

[toStringTag]

• get "[toStringTag]"(): string

  Returns string

children

• 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

  • children: HTMDNode

  Returns void

class

• get class(): string

  Returns string

• set class(classList: 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

  • classList: string

  Returns void

  Example

  MyElement.class ="special-class"
  console.log(MyElement.class) //`${SPARC_PREFIX}__${this.name} special-class`
  Copy

containerSelector

• 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

id

• 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

instance

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

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

  Returns null | JQuery<HTMLElement>

isAlive

• get isAlive(): boolean

  Returns true if the element currently exists in the DOM.

  Returns boolean

name

• 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

selector

• get selector(): string

  Returns the element's CSS selector.

  Returns string

  Example

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

topClassBEM

• get topClassBEM(): string

  Returns the top-level BEM-style class for this element.

  Returns string

clearEventListeners

• clearEventListeners<K extends keyof HTMLElementEventMap>(
      eventsList?: K | K[],
  ): void

  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

remove

• remove(): void

  Removes this element from the DOM.

  Returns void

render

• render(shouldRenderChildren?: boolean): void

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

  Parameters

  • shouldRenderChildren: boolean = true

    Whether to render child nodes.

  Returns void

setEventHandler

• setEventHandler<K extends keyof HTMLElementEventMap>(
      eventName: K,
      callback?: (ev: HTMLElementEventMap[K]) => void,
  ): 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

AbstracttoString

• toString(): string

  Returns string

  the HTML string representing this element.