Link Search Menu Expand Document

Glass Web Components

A library of Web Components designed for use with Rock Mountain Platform, but since they are just Web Components, they work in any major framework or with no framework at all.

Built With Stencil

About 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 the Components (in your own project)

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

Script tag

  • Put a script tag similar to this <script type="module" src='https://unpkg.com/glass-web-components@latest/dist/glass-web-components/glass-web-components.esm.js'></script> in the head of your index.html. Note that, instead of @latest, you might use a specific version so that you can test new versions explicitly before deploying in your production system.
  • Once the script tag above is in place, you can then use any Glass Web Componenet element anywhere in your template, JSX, html etc

Node Modules

  • Run npm install glass-web-components --save
  • Put a script tag similar to this <script type="module" src="node_modules/glass-web-components/dist/glass-web-components/glass-web-components.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

Table of contents