Skip to content

zxhfighter/measure

Repository files navigation

xdesign

Build Status

Examples can be see here : https://zxhfighter.github.io/measure/.

start

$ npm install

dev

$ npm run dev

Compose a component

Component code are in src/component.

You can use gulp generate:component to quickly scafford a component.

$ gulp generate:component --name your-component

A your-component folder will be created in src/component, and the contents are:

your-component
├── index.ts
├── public.api.ts
├── your-component.config.ts
├── your-component.html
├── your-component.less
├── your-component.module.ts
└── your-component.ts

and it will add your component entry to src/component/index.ts.

Write a demo for your component

You can then write a demo to test your component in src/demo.

When you use gulp generate:component --name your-component, a folder will be generated in src/demo too.

your-component
├── index.ts
├── your-component.html
├── your-component.less
└── your-component.ts

But you will still config the src/demo/app.router.ts and src/demo/app.module.ts.

build

build component

to build your component:

$ npm run build

build dev demo app

to build your demo app with aot:

$ npm run build:demo:aot

lint

to lint your code:

$ npm run lint

docs

to generate api docs and guide docs:

$ npm run docs

api docs will be in docs/dist.

guide docs will be in docs/dist/guides;