quark-component 0.0.0-development

quark-component

0.0.0-development

Component ▸
- Instance members
- #$el
- #$name
- #$parent
- #$root
- #$els
- #$refs
- #$props
- #init
- #mounted
- #beforeDestroy
- #destroyed
- #data
- #$preRenderMount
- #$mount
- #$destroy
- #$debug
- #$scope
- #$nextTick
- #template
- #components
startsWith
walk

Need help reading this?

Component

Component class.

new Component($0: Object, options: Object)

License: {@link https://opensource.org/licenses/MIT|MIT}

Author: Patrick Heng & Fabien Motte <hengpatrick.pro@gmail.com / contact@fabienmotte.com>

Parameters

(Object
            = {})

Name	Description
$0.el `any` (default `null`)
$0.name `any` (default `'anonymous'`)
$0.components `any` (default `{}`)

options

(Object
            = {})

Options.

Example

const rootComponent = new Component({ el: '#root' })

Instance Members

▸ $el

DOM element the instance is mounted on.

$el

Type: (String | HTMLElement)

▸ $name

Component name.

$name

Type: String

▸ $parent

Parent instance.

$parent

Type: Component

▸ $root

Root instance.

$root

Type: Component

▸ $els

DOM elements registered.

$els

Type: Object<String, HTMLElement>

▸ $refs

Child components instances registered.

$refs

Type: Object<String, Component>

▸ $props

Props component registered.

$props

Type: Object<String, string>

▸ init()

Init hook. Called synchronously after the instance has been initialized.

init()

▸ mounted()

Mounted hook. Called synchronously after the component compiled template is inserted in the DOM.

mounted()

▸ beforeDestroy()

Before destroy hook. Called synchronously before the component has been destroyed.

beforeDestroy()

▸ destroyed()

Destroyed hook. Called synchronously after the component has been destroyed.

destroyed()

▸ data()

Data used to compile the template.

data(): Object<String, any>

Returns

Object<String, any>: Data.

▸ $preRenderMount(el)

Mount a pre-rendered component.

$preRenderMount(el: (String | HTMLElement))

Parameters

el ((String | HTMLElement)) Element.

▸ $mount(el, type)

Mount a component.

$mount(el: (String | HTMLElement | null), type: String)

Parameters

((String | HTMLElement | null)
            = null)

Element.

type (String) Mount type.

▸ $destroy()

Destroy a component.

$destroy()

▸ $debug()

Log component debug informations.

$debug()

▸ $scope(methods)

Bind methods to the scope component.

$scope(methods: Array)

Parameters

methods

(Array
            = [])

Methods to bind.

▸ $nextTick(callback)

Next tick.

$nextTick(callback: Function)

Parameters

callback

(Function
            = ()=>{})

Callback

▸ template

Template getter.

template

Type: Object

▸ components

Components getter.

components

Type: Object<String, Component>

startsWith

Starts with.

startsWith

Parameters

str (String) String.

prefix (String) Prefix.

Returns

Boolean: True if given string starts with given prefix, else otherwise.

walk

Walk a DOM node and call the given callback.

walk(nodes: any, cb: Function, node: HTMLElement)

Parameters

nodes (any)

cb (Function) Callback function.

node (HTMLElement) HTMLElement node.