@amanessinger/pace-web-chat

PACE Web Chat

This will be a standalone Web Component made using Stencil. It is derived from there starter project as of 31-MAR-2018.

Architecture

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

pace-web-chat will be used in the chatbot dialog preview of chatbotadmin

Cloning from starter project

To start building a new web component using Stencil, we've cloneed the repo to a new directory:

git clone https://github.com/ionic-team/stencil-component-starter.git pace-web-chat
cd pace-web-chat
git remote rm origin

and run:

npm install
npm start

All popular browsers are supported in their current versions, but for now we use Chrome. To watch for file changes during develop, run:

npm run dev

To build the component for production, run:

npm run build

To run the unit tests for the components in watch mode, run:

npm run test.watch

Also have a look at the stencil docs here.

Using this component

Script tag

• Publish to NPM
• Put a script tag similar to this <script src='https://unpkg.com/pace-web-chat@0.0.1/dist/pacewebchat.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

• Run npm install pace-web-chat --save
• Put a script tag similar to this <script src='node_modules/pace-web-chat/dist/pacewebchat.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

• Run npm install pace-web-chat --save
• Add { name: 'pace-web-chat' } to your collections
• Then you can use the element anywhere in your template, JSX, html etc