@atlasrfidsolutions/atlas-ui v0.9.38

Atlas Design System

Welcome to the Atlas Design System - the source for UI components used for all Atlas software products.

UI components are based on Ionic core components and are built using StencilJS (details below).

Components Demo

To see the components in action, clone this repository and run:

npm start

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.

Naming Components

When creating new component tags, be sure to use the aui prefix in the tag name. Note that the tag name (i.e., custom HTML element) is not the same as the component name in the source code.

If the component is designed for user input, then use the input suffix. If input is restricted to predefined options, then use the select suffix. Otherwise, find another noun that concisely describes the component's function in the UI.

Some example tag names:

• aui-barcode-input
• aui-text-input
• aui-text-area-input
• aui-user-select

Using the components

Node Modules

• Run npm install @atlasrfidsolutions/atlas-ui --save
• Put a script tag similar to this <script type='module' src='node_modules/my-component/dist/my-component.esm.js'></script> in the head of your index.html, OR import the library with import "@atlasrfidsolutions/atlas-ui"; in a global script
• Then you can use the element anywhere in your template, JSX, html etc