Installs various helpers. It is a singleton.

Use UFHtmlHelpers.instance to access the singleton.

Call init to initialize the Ultra Force html helpers. Extra custom helpers can be added by passing them as an argument.

When the DOM changes, call scan to let each helper rescan.

The helpers scan the dom for 'data-uf-' attributes and perform the necessary actions. The helpers do not generate HTML or use their own css classes. They only use * the 'data-uf-' attributes; if a helper applies class changes the classes are also supplied by the 'data-uf-*' attributes.

Hierarchy (View Summary)

Accessors

Methods

  • Adds elements that have a specific attribute which value is a selector pointing to one or several elements; the target element(s). The elements are grouped per target element pointed to.

    A separate target list is used, so that multiple aTargetToSourceMap instances can be used that use the same target but point to different type of sources.

    The allows for a single event handler. The event handlers should handle all the different types of sources pointing to the same target.

    Type Parameters

    • TTarget extends HTMLElement
    • TSource extends HTMLElement

    Parameters

    • aSelectorAttribute: string

      The attribute that contains the selector. The sources are the elements containing this attribute. The targets are the elements pointed to by the selector value of the attribute.

    • aTargetList: TTarget[]

      Target elements are added to this list. If the target is already in the list, it will not be added again.

    • aTargetToSourceMap: UFMapOfSet<TTarget, TSource>

      A map that contains the source elements grouped per target element.

    • anEvent: null | string = null

      Optional event to listen for at the target element(s). It will be set only once at each target.

    • anHandler: null | (target: TTarget) => void = null

      A handler that is called with the target element that triggered the event.

    • aGroupName: string = ''

      Event group to use. If empty, the event listener just gets added to the target.

    Returns void

  • Gets the target element(s).

    Parameters

    • element: HTMLElement

      Element to get the target element(s) from.

    • target: string

      Either one of the predefined values or a selector.

    Returns HTMLElement[]

    list of elements (can be empty)

  • Resorts a grid using current selected control and sort direction. If the grid is not sorted or the grid sorting helper is not active nothing happens.

    Parameters

    • grid: HTMLElement

    Returns void