glass-react-components v0.0.13
Glass React Components
A library of React web components wrapped around w3c-standard web components. For now, these are designed for use with the Rock Mountain Platform, but they are just React Components, so they work with any React project. To use only the W3C-standard web components, see glass-web-components instead.
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 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
Developer Getting Started (with this project)
To start building a new web component using Stencil, clone this repo to a new directory:
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin
and run:
npm install
npm start
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Need help? Check out our docs here.
Naming Components
When creating new component tags, we recommend not using stencil
in the component name (ex: <stencil-datepicker>
). This is because the generated component has little to nothing to do with Stencil; it's just a web component!
Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion
.
Publishing to npm
- CD into the
glass-web-components
directory. - Execute
npm login
(and enter credentials) - To publish your public package to the npm registry, run:
npm publish
- To see your public package page, visit https://www.npmjs.com/package/glass-web-components
- For more information on the publish command, see the CLI documentation.
Useful References
- Passing an Object or Array to Stencil through markup
- Stencil Style Guide
- Quick Tip — Using Prop() Context in Stencil
- Quick Tip — Dynamic Stencil Component Names with JSX
- Using Refs in Stencil
- Render Props in Stencil
- Consuming a Stencil Component in React App
- Creating Shared State in Stencil
- Using Objects/Arrays as Props in Stencil Components
- Creating a Simple Login Form Using Stencil
- Getting to Know Stencil Decorators
- User Interface Design patterns
- Welie.com - Patterns in Interaction Design