Class GroupBadge<CustomAttrs>

The Badge component represents a user/discussion badge, indicating some status (e.g. a discussion is stickied, a user is an admin).

A badge may have the following special attrs:

  • type The type of badge this is. This will be used to give the badge a class name of Badge--{type}.
  • icon The name of an icon to show inside the badge.
  • label

All other attrs will be assigned as attributes on the badge element.

Type Parameters

Hierarchy

  • Badge<CustomAttrs>
    • GroupBadge

Constructors

Properties

attrs: CustomAttrs

The attributes passed into the component.

element: Element

The root DOM element for the component.

state: undefined

Class component state that is persisted between redraws.

Updating this will not automatically trigger a redraw, unlike other frameworks.

This is different to Vnode state, which is always an instance of your class component.

This is undefined by default.

Methods

  • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

    For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

    Parameters

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

    Final

Generated using TypeDoc v0.24.8