ensemble.Compo

ensemble

• ensemble
  • ~Compo ⇐ _composition
    • instance
      • .node ⇒ Element
      • .parent ⇒ ensemble.Compo
      • .previous ⇒ ensemble.Compo
      • .next ⇒ ensemble.Compo
      • .classList ⇒ DOMTokenList
      • ._Symbol.toStringTag ⇒ string
      • ._element(ns, tag, name, props, [options], [elementNS])
      • .hasAttr(attr) ⇒ boolean
      • .getAttr(attr) ⇒ string
      • .setAttr(attr, value)
      • .delAttr(attr)
      • .getStyle(prop) ⇒ mixed
      • .show()
      • .hide()
      • .enable()
      • .disable()
    • static
      • .isCompo() ⇒ boolean
  • ~DENIED_PROPS : RegExp

ensemble~Compo ⇐ _composition

Compo is a composition element with shorthands method and utils.

It is a wrapper around an Element node [DOM]. It could be used as base for abstraction of a custom component element.

Kind: inner class of ensemble
Extends: _composition

• ~Compo ⇐ _composition
  • instance
    • .node ⇒ Element
    • .parent ⇒ ensemble.Compo
    • .previous ⇒ ensemble.Compo
    • .next ⇒ ensemble.Compo
    • .classList ⇒ DOMTokenList
    • ._Symbol.toStringTag ⇒ string
    • ._element(ns, tag, name, props, [options], [elementNS])
    • .hasAttr(attr) ⇒ boolean
    • .getAttr(attr) ⇒ string
    • .setAttr(attr, value)
    • .delAttr(attr)
    • .getStyle(prop) ⇒ mixed
    • .show()
    • .hide()
    • .enable()
    • .disable()
  • static
    • .isCompo() ⇒ boolean

compo.node ⇒ Element

Getter for node property, intended as the Element node inside this composition. Note that a direct access to the node is discouraged.

Kind: instance property of Compo

compo.parent ⇒ ensemble.Compo

Getter for parent property, intended as the parent compo of this composition.

Kind: instance property of Compo

compo.previous ⇒ ensemble.Compo

Getter for previous property, intended as the previous sibling of this composition.

Kind: instance property of Compo

compo.next ⇒ ensemble.Compo

Getter for next property, intended as the next sibling of this composition.

Kind: instance property of Compo

compo.classList ⇒ DOMTokenList

Getter for classList property, intended as the classList of the Element node inside this composition.

Kind: instance property of Compo
See: DOMTokenList

compo._Symbol.toStringTag ⇒ string

Getter for Symbol property, returns the symbolic name for ensemble.Compo class.

Kind: instance property of Compo
See: Symbol.toStringTag()
Todo

• return undef
• backward compatibility

compo._element(ns, tag, name, props, [options], [elementNS])

Element wrapper.

Kind: instance method of Compo
See

• document.createElement()
• document.createElementNS()

Param	Type	Description
ns	string	Component namespace
tag	string	The element Node tag -or- component name
name	string	Name for composition, used for CSS className
props	object	Properties for composition
[options]	object	An optional ElementCreationOptions object [DOM]
[elementNS]	object	Options for namespaced Element node [DOM]
[elementNS.namespaceURI]	string	A valid namespace URI
[elementNS.qualifiedName]	string	A valid qualified name

compo.hasAttr(attr) ⇒ boolean

Check for an attribute of this composition.

Kind: instance method of Compo
See: Element.hasAttribute()

Param	Type	Description
attr	string	An attribute

compo.getAttr(attr) ⇒ string

Gets an attribute from this composition.

Kind: instance method of Compo
See: Element.getAttribute()

Param	Type	Description
attr	string	An attribute

compo.setAttr(attr, value)

Sets an attribute in this composition.

Kind: instance method of Compo
See: Element.setAttribute()

Param	Type	Description
attr	string	An attribute
value	string	The value

compo.delAttr(attr)

Removes an attribute from this composition.

Kind: instance method of Compo
See: Element.removeAttribute()

Param	Type	Description
attr	string	An attribute

compo.getStyle(prop) ⇒ mixed

Gets a current style property.

Kind: instance method of Compo
See: window.getComputedStyle()

Param	Type	Description
prop	string	A style property

compo.show()

Time to show this composition.

Kind: instance method of Compo

compo.hide()

Time to hide this composition.

Kind: instance method of Compo

compo.enable()

Util to set attribute disabled to true

Kind: instance method of Compo

compo.disable()

Util to set attribute disabled to false

Kind: instance method of Compo

Compo.isCompo() ⇒ boolean

Check if passed object is an ensemble.Compo instance.

Kind: static method of Compo
Todo

• backward compatibility

ensemble~DENIED_PROPS : RegExp

Constructor method.

Kind: inner constant of ensemble
Todo

• props.dataset

Param	Type	Default	Description
ns	string		Component namespace
[tag]	string	"'div'"	The [DOM] Element node tag -or- component name
[name]	string | Array.<string>		The composition name, used for CSS className
[props]	object		Properties for composition
[options]	object		An optional ElementCreationOptions object [DOM]
[elementNS]	object		Options for namespaced Element node [DOM]
[elementNS.namespaceURI]	string		A valid namespace URI
[elementNS.qualifiedName]	string		A valid qualified name