Skip to content

fm-ph/quark-component

Folders and files

NameName
Last commit message
Last commit date

Latest commit

54afe1c Β· Oct 5, 2019

History

4 Commits
Apr 21, 2018
May 14, 2018
May 14, 2018
Apr 21, 2018
Apr 21, 2018
Apr 21, 2018
Apr 21, 2018
Apr 21, 2018
Apr 21, 2018
Apr 21, 2018
Apr 21, 2018
Oct 5, 2019
Oct 5, 2019

Repository files navigation

quark-component

build status stability npm version js-standard-style semantic-release

Simple recursive component class with template rendering and hooks.

This package is part of quark framework but it can be used independently.

Installation

NPM

npm install quark-component --save

Usage

Basic

import { Component } from 'quark-component'

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

To be written...

API

See https://fm-ph.github.io/quark-component/

Build

To build the sources with babel in ./lib directory :

npm run build

Documentation

To generate the JSDoc :

npm run docs

To generate the documentation and deploy on gh-pages branch :

npm run docs:deploy

Testing

To run the tests, first clone the repository and install its dependencies :

git clone https://github.com/fm_ph/quark-component.git
cd quark-component
npm install

Then, run the tests :

npm test

To watch (test-driven development) :

npm run test:watch

For coverage :

npm run test:coverage

License

MIT License Β© Patrick Heng Fabien Motte