Table of Contents

• quark/ctr
  • Args
  • assertDom(subclass,baseclass,...args)
  • link(target,name)
  • linkAcc(target,name)
  • Class: VirtualDOM
    • VirtualDOM
  • Class: ViewController
    • ViewController
    • viewcontroller.window
    • viewcontroller.owner
    • viewcontroller.children
    • viewcontroller.props
    • viewcontroller.state
    • viewcontroller.refs
    • viewcontroller.ref
    • viewcontroller.dom
    • viewcontroller.isLoaded
    • viewcontroller.isMounted
    • viewcontroller.isDestroyd
    • viewcontroller.metaView
    • viewcontroller.constructor(props,arg)
    • viewcontroller.setState(newState,cb?)
    • viewcontroller.update(cb?)
    • viewcontroller.triggerLoad()
    • viewcontroller.triggerMounted()
    • viewcontroller.triggerUpdate(old,vdom)
    • viewcontroller.triggerDestroy()
    • viewcontroller.render()
    • viewcontroller.appendTo(parent)
    • viewcontroller.afterTo(prev)
    • viewcontroller.destroy()
  • createElement(Type,props,...children)
  • VDom
  • RenderData
  • RenderNode
  • RenderResult

quark/ctr #

Args #

• @type Args = {
  window: Window;
  owner: ViewController;
  children: ;
  }

assertDom(subclass,baseclass,...args) #

Check if it is a valid VirtualDOM type, and the parameter subclass is of type baseclass

• @template <T>
• @param subclass: VirtualDOM<T>
• @param baseclass: DOMConstructor<T>
• @param args: any`[]`

link(target,name) #

ViewController prop

• @param target: ViewController
• @param name: string

linkAcc(target,name) #

ViewController prop and define prop accessor

• @param target: ViewController
• @param name: string

Class: VirtualDOM #

VirtualDOM #

• @template <T>

Class: ViewController #

ViewController #

UI view controller component

• @implements DOM
• @template <P,S>

viewcontroller.window #

Window object ref

• @get window: Window

viewcontroller.owner #

Parent controller which the current controller belongs

• @get owner: ViewController

viewcontroller.children #

Outer children vdom

• @get children:

viewcontroller.props #

the ViewController external incoming attributes

• @get props: Readonly<P>

viewcontroller.state #

View Controller States

• @get state: Readonly<S>

viewcontroller.refs #

Subordinate objects referenced by the ref name

• @get refs: Readonly<Dict<ViewController|View>>

viewcontroller.ref #

The Ref-Name in the owner controller

• @get ref: string

viewcontroller.dom #

The rendered DOM object under the current ViewController

• @get dom: DOM

viewcontroller.isLoaded #

After triggering Load, it will be set to true

• @get isLoaded: boolean

viewcontroller.isMounted #

It will be set to true before triggering Mounted

• @get isMounted: boolean

viewcontroller.isDestroyd #

It will be set to true before triggering Destroy

• @get isDestroyd: boolean

viewcontroller.metaView #

• @get metaView: View

viewcontroller.constructor(props,arg) #

• @param props: {Object}
• @param arg: {Args}

viewcontroller.setState(newState,cb?) #

Update the current ViewController state and re-render if the state does change

• @template <K>
• @param newState: object
• @param cb?: Function

viewcontroller.update(cb?) #

Force re-rendering of the ViewController

• @param cb?: Function

viewcontroller.triggerLoad() #

Triggered before the first render call

• @return any

viewcontroller.triggerMounted() #

Triggered after the first render call completed

• @return any

viewcontroller.triggerUpdate(old,vdom) #

Triggered when the DOM content is updated

• @param old: VirtualDOM
• @param vdom: VirtualDOM
• @return any

viewcontroller.triggerDestroy() #

Triggered when after calling remove()

• @return any

viewcontroller.render() #

When rendering occurs, call to return the vdom object that needs to be rendered

• @return RenderResult

viewcontroller.appendTo(parent) #

• @override
• @param parent: View
• @return View

viewcontroller.afterTo(prev) #

• @override
• @param prev: View
• @return View

viewcontroller.destroy() #

Note: Do not proactively call this method

• @override

createElement(Type,props,...children) #

Create virtual dom by jsx element

• @template <T>
• @param Type: DOMConstructor<T>|JSX.IntrinsicElementsName
• @param props: Dict|null
• @param children: any`[]`
• @return VirtualDOM

VDom #

• @type VDom = VirtualDOM<T>
• @template <T>

RenderData #

• @type RenderData = VirtualDOM|string

RenderNode #

• @type RenderNode = RenderData|null|undefined|void

RenderResult #

• @type RenderResult = RenderNode[]|RenderNode