Class TagBuilder

TagBuilder class, used to build tags of course.

Hierarchy

ExFunc
- TagBuilder

Index

Constructors

constructor

new TagBuilder(tagName, ...children): TagBuilder
Parameters
- tagName: TagName
- Rest ...children: ValidTagChild[]
Returns TagBuilder
Overrides ExFunc.constructor
- Defined in src/tag-builder.ts:52

Properties

_meta

_meta: TagMeta = ...

_parent

_parent: Tag

arguments

arguments: any

attr

attr: AttrSet = ...

Do not modify directly, use helper methods in the tag instead.

caller

caller: Function

children

children: ValidTagChild[] = []

`Readonly` length

length: number

`Readonly` name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

prototype

prototype: any

tagName

tagName: TagName

Accessors

a

get a(): TagBuilder
Attach to the currently attached tag in the global hobo context

Returns TagBuilder
- Defined in src/tag-builder.ts:110

attach

get attach(): TagBuilder
Same as .a - Attach to the currently attached tag in the global hobo context

Returns TagBuilder
- Defined in src/tag-builder.ts:116

className

get className(): ClassName
Get the tag className

Returns ClassName
- Defined in src/tag-builder.ts:31

tagId

get tagId(): string
Get the tag id

Returns string
- Defined in src/tag-builder.ts:36

Methods

[hasInstance]

[hasInstance](value): boolean
Determines whether the given value inherits from this function if this function was used as a constructor function.

A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.
Parameters
- value: any
Returns boolean
Inherited from ExFunc.[hasInstance]
- Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:164

call

__call__(...children): Tag
Parameters
- Rest ...children: ValidTagChild[]
Returns Tag
Overrides ExFunc.__call__
- Defined in src/tag-builder.ts:92

aa

aa(key, value): TagBuilder
Shorthand for .addAttr method. Adds attribute, and returns a new TagBuilder
Parameters
- key: string
- value: string
Returns TagBuilder
- Defined in src/tag-builder.ts:289

ac

ac(...classNames): TagBuilder
Shorthand for .addClass method. Adds classNames to this TagBuilder, and returns a new TagBuilder
Parameters
- Rest ...classNames: string[]
Returns TagBuilder
- Defined in src/tag-builder.ts:255

addAttr

addAttr(key, value): TagBuilder
Add one attribute, and return a new TagBuilder
Parameters
- key: string
- value: string
Returns TagBuilder
- Defined in src/tag-builder.ts:294

addClass

addClass(...classNames): TagBuilder
Adds classNames to this TagBuilder, and returns a new TagBuilder
Parameters
- Rest ...classNames: string[]
Returns TagBuilder
- Defined in src/tag-builder.ts:262

addStyle

addStyle<T>(key, value): TagBuilder
Adds a single style, and returns a new TagBuilder
Type Parameters
- T extends CssProperty
Parameters
- key: T
- value: PickPropertyValues<T>
Returns TagBuilder
- Defined in src/tag-builder.ts:346

append

append(...tags): TagBuilder
Adds tags as children if the tag can have children. For example, if tag is img there's no need to add the childre as they will not be generated.
Parameters
- Rest ...tags: ValidTagChild[]
Returns TagBuilder
- Defined in src/tag-builder.ts:148

apply

apply(this, thisArg, argArray?): any
Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
Parameters
- this: Function
- thisArg: any
  
  The object to be used as the this object.
- Optional argArray: any
  
  A set of arguments to be passed to the function.
Returns any
Inherited from ExFunc.apply
- Defined in node_modules/typescript/lib/lib.es5.d.ts:281

as

as<T>(key, value): TagBuilder
Shorthand for .addStyle method Adds a single style, and returns a new TagBuilder
Type Parameters
- T extends CssProperty
Parameters
- key: T
- value: PickPropertyValues<T>
Returns TagBuilder
- Defined in src/tag-builder.ts:339

b

b(...children): Tag
Shorthand for .build method Build the tag with additional children
Parameters
- Rest ...children: ValidTagChild[]
Returns Tag
- Defined in src/tag-builder.ts:81

bind

bind(this, thisArg, ...argArray): any
For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
Parameters
- this: Function
- thisArg: any
  
  An object to which the this keyword can refer inside the new function.
- Rest ...argArray: any[]
  
  A list of arguments to be passed to the new function.
Returns any
Inherited from ExFunc.bind
- Defined in node_modules/typescript/lib/lib.es5.d.ts:296

build

build(...children): Tag
Build the tag with additional children
Parameters
- Rest ...children: ValidTagChild[]
Returns Tag
- Defined in src/tag-builder.ts:88

call

call(this, thisArg, ...argArray): any
Calls a method of an object, substituting another object for the current object.
Parameters
- this: Function
- thisArg: any
  
  The object to be used as the current object.
- Rest ...argArray: any[]
  
  A list of arguments to be passed to the method.
Returns any
Inherited from ExFunc.call
- Defined in node_modules/typescript/lib/lib.es5.d.ts:288

copy

copy(): TagBuilder
Returns TagBuilder
- Defined in src/tag-builder.ts:58

`Private` getMetaForTag

getMetaForTag(tagName): TagMeta
Parameters
- tagName: TagName
Returns TagMeta
- Defined in src/tag-builder.ts:388

id

id<T>(newId): TagBuilder
Set the id of the tag Can't be empty
Type Parameters
- T extends string
Parameters
- newId: T extends ""
  ? never
  : T
Returns TagBuilder
- Defined in src/tag-builder.ts:131

`Private` isSelfClosingTag

isSelfClosingTag(tagName): boolean
Parameters
- tagName: string
Returns boolean
- Defined in src/tag-builder.ts:396

`Private` isStorableTag

isStorableTag(tagName): boolean
Parameters
- tagName: string
Returns boolean
- Defined in src/tag-builder.ts:399

m

m(fn): TagBuilder
cm = modify calls fn with the tag, and returns the tag

usefull to change a tag while maintaing chaning
Parameters
- fn: ((tag) => void)
  - - (tag): void
    - Parameters
      
      tag: TagBuilder
      
      Returns void
Returns TagBuilder
Example
```
div().m(t => t.className.add("Container"))
   .div("I'm a child!"),
```
Example
```
div([
   p("Child1").m(t => t.className.add("child-1")),
   p("Child1").m(t => t.className.add("child-2"))
])
```
- Defined in src/tag-builder.ts:192

mc

mc(arg0): TagBuilder
Shortcut for method .modClass

Modifies the classnames of a tag. Similar to the .mod or .m methods but it passes the className instead of the complete tag.

Retuns a new TagBuilder
Parameters
- arg0: ((c) => void)
  - - (c): void
    - Parameters
      
      c: ClassName
      
      Returns void
Returns TagBuilder
- Defined in src/tag-builder.ts:228

mod

mod(fn): TagBuilder
calls fn with the tag, and returns the tag

usefull to change a tag while maintaing chaning
Parameters
- fn: ((tag) => void)
  - - (tag): void
    - Parameters
      
      tag: TagBuilder
      
      Returns void
Returns TagBuilder
Example
```
div().m(t => t.className.add("Container"))
   .div("I'm a child!"),
```
Example
```
div([
   p("Child1").mod(t => t.className.add("child-1")),
   p("Child1").mod(t => t.className.add("child-2"))
])
```
- Defined in src/tag-builder.ts:214

modClass

modClass(arg0): TagBuilder
Modifies the classnames of a tag. Similar to the .mod or .m methods but it passes the className instead of the complete tag.

Retuns a new TagBuilder
Parameters
- arg0: ((c) => void)
  - - (c): void
    - Parameters
      
      c: ClassName
      
      Returns void
Returns TagBuilder
Example
```
div(
   p("Child1").modClass(c => c.add("child-1")),
   p("Child1").modClass(c => c.add("child-2"))
)
```
- Defined in src/tag-builder.ts:246

p

p(parent): TagBuilder
Set the parent of the tag. If a parent is set, this tag will be added as a child when built
Parameters
- parent: Tag
Returns TagBuilder
- Defined in src/tag-builder.ts:121

ra

ra(...attr): TagBuilder
Shorthand for .removeAttr method. Removes attribute from this TagBuilder, and returns a new TagBuilder
Parameters
- Rest ...attr: string[]
Returns TagBuilder
- Defined in src/tag-builder.ts:322

rc

rc(...classNames): TagBuilder
Shorthand for .rmClass method. Removes classNames from this TagBuilder, and returns a new TagBuilder
Parameters
- Rest ...classNames: string[]
Returns TagBuilder
- Defined in src/tag-builder.ts:272

rmAttr

rmAttr(...attr): TagBuilder
Removes attribute from this TagBuilder, and returns a new TagBuilder
Parameters
- Rest ...attr: string[]
Returns TagBuilder
- Defined in src/tag-builder.ts:329

rmClass

rmClass(...classNames): TagBuilder
Removes classNames from this TagBuilder, and returns a new TagBuilder
Parameters
- Rest ...classNames: string[]
Returns TagBuilder
- Defined in src/tag-builder.ts:279

rmStyle

rmStyle(...styleNames): TagBuilder
Removes styles from this TagBuilder, and returns a new TagBuilder
Parameters
- Rest ...styleNames: string[]
Returns TagBuilder
- Defined in src/tag-builder.ts:381

rs

rs(...styleNames): TagBuilder
Shorthand for .removeStyles method. Removes styles from this TagBuilder, and returns a new TagBuilder
Parameters
- Rest ...styleNames: string[]
Returns TagBuilder
- Defined in src/tag-builder.ts:374

sa

sa(attributes): TagBuilder
Shorthand for .setAttr method. Sets multiple atributes at once, and returns a new TagBuilder
Parameters
- attributes: {
  [key: string]: string;
  }
  - [key: string]: string
Returns TagBuilder
- Defined in src/tag-builder.ts:304

`Private` sanitizeTagName

sanitizeTagName(tagName): string
Parameters
- tagName: TagName
Returns string
- Defined in src/tag-builder.ts:407

setAttr

setAttr(attributes): TagBuilder
Sets multiple atributes at once, and returns a new TagBuilder
Parameters
- attributes: {
  [key: string]: string;
  }
  - [key: string]: string
Returns TagBuilder
- Defined in src/tag-builder.ts:309

setChildren

setChildren(children): TagBuilder
Set the children of this tag. Replaces any current children
Parameters
- children: ValidTagChild[]
Returns TagBuilder
- Defined in src/tag-builder.ts:160

setStyles

setStyles(styles): TagBuilder
Adds style from object, and returns a new TagBuilder
Parameters
- styles: StyleMap
Returns TagBuilder
- Defined in src/tag-builder.ts:361

setTagName

setTagName(name): TagBuilder
Sets and validates the tag name
Parameters
- name: string
Returns TagBuilder
- Defined in src/tag-builder.ts:67

ss

ss(styles): TagBuilder
Shorthand for .setStyles method. Adds style from object, and returns a new TagBuilder
Parameters
- styles: StyleMap
Returns TagBuilder
- Defined in src/tag-builder.ts:356

store

store(o): TagBuilder
Store metadata inside tag. Internal method, you won't need this
Parameters
- o: any
Returns TagBuilder
- Defined in src/tag-builder.ts:167

text

text(content): TagBuilder
replaces the children of this tag with the provided string
Parameters
- content: string
Returns TagBuilder
- Defined in src/tag-builder.ts:138

toString

toString(): string
Returns a string representation of a function.

Returns string
Inherited from ExFunc.toString
- Defined in node_modules/typescript/lib/lib.es5.d.ts:299

`Private` validateTagName

validateTagName(tagName): void
Parameters
- tagName: TagName
Returns void
- Defined in src/tag-builder.ts:402

Class TagBuilder

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

tagName: TagName

Rest ...children: ValidTagChild[]

Returns TagBuilder

Properties

_meta

_parent

arguments

attr

caller

children

Readonly length

Readonly name

prototype

tagName

Accessors

a

Returns TagBuilder

attach

Returns TagBuilder

className

Returns ClassName

tagId

Returns string

Methods

[hasInstance]

Parameters

value: any

Returns boolean

__call__

Parameters

Rest ...children: ValidTagChild[]

Returns Tag

aa

Parameters

key: string

value: string

Returns TagBuilder

ac

Parameters

Rest ...classNames: string[]

Returns TagBuilder

addAttr

Parameters

key: string

value: string

Returns TagBuilder

addClass

Parameters

Rest ...classNames: string[]

Returns TagBuilder

addStyle

Type Parameters

T extends CssProperty

Parameters

key: T

value: PickPropertyValues<T>

Returns TagBuilder

append

Parameters

Rest ...tags: ValidTagChild[]

Returns TagBuilder

apply

Parameters

this: Function

thisArg: any

Optional argArray: any

Returns any

as

Type Parameters

T extends CssProperty

`Rest` ...children: ValidTagChild[]

`Readonly` length

`Readonly` name

call

`Rest` ...children: ValidTagChild[]

`Rest` ...classNames: string[]

`Rest` ...classNames: string[]

`Rest` ...tags: ValidTagChild[]

`Optional` argArray: any

`Rest` ...children: ValidTagChild[]

`Rest` ...argArray: any[]

`Rest` ...children: ValidTagChild[]

`Rest` ...argArray: any[]

`Private` getMetaForTag

newId: T extends ""
? never
: T

`Private` isSelfClosingTag

`Private` isStorableTag