@onerecord/web-components NPM

OneRecord Web Components

This is a library of Web Components for the OneRecord organization.

This project uses StencilJS.

Stencil

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.

Using these components

There are three strategies we recommend for using web components built with Stencil.

Script tag

Put a script tag similar to this <script src='https://unpkg.com/my-component@0.0.1/dist/my-component.esm.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 my-component --save
Put a script tag similar to this <script src='node_modules/my-component/dist/my-component.esm.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 my-component --save
Add an import to the npm packages import my-component;
Then you can use the element anywhere in your template, JSX, html etc

Local Development

Use the correct node version (see .nvmrc file for which version).

Install dependencies with yarn install. Install in root directory and in proxy-server/ Run yarn start to start up the development server. Run yarn start:proxy to start up a proxy server that you can then use in other, locally running applications.