Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Group

The Group class renders a set of Renderable one after another.

Hierarchy

Constructors

constructor

  • Constructor

    Parameters

    • Rest ...members: (string | Renderable)[]

      A set of one or more members to add to the group.

    Returns Group

Properties

Protected templates

templates: SimpleObject

Accessors

r

  • get r(): string
  • Getting for the HTML returned by the render function.

    Returns string

Methods

addMember

  • Appends a member.

    Parameters

    • member: Renderable | string

      either a string or renderable

    Returns void

append

  • Appends templates to the existing templates object.

    Parameters

    • templates: SimpleObject

      Key-value pairs that map to a template rendered in StringLiteral's

    • Default value prioritize: boolean = false

      Whether or not to allow appended templates to override existing template properties

    Returns Renderable

getMembers

  • Gets the members.

    Returns Renderable[]

Protected internalRender

render

  • Renders the internalRender function.

    Parameters

    Returns string

setMembers

  • setMembers(...members: (string | Renderable)[]): void
  • Sets the members.

    Parameters

    • Rest ...members: (string | Renderable)[]

      one or more members

    Returns void

toString

  • toString(): string
  • Overrides the toString method called by JavaScript when string concatenate occurs

    Returns string

when

  • Turn on and off the ability for this element to render

    Parameters

    • condition: boolean

      The condition that determines whether or not the element can render.

    Returns Renderable

with

  • Sets the templates.

    Parameters

    • templates: SimpleObject

      Key-value pairs that map to a template rendered in StringLiteral's

    Returns Renderable

Generated using TypeDoc