mat-design-system v1.0.7

Money Advice Trust Design System

This is the Money Advice Trust's Design System, built upon Stencil.

What is 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.

Getting Started

To get started, clone this repo and run:

npm install
npm start

To build the design system for production, run:

npm run build

Need help? Check out our Stencil's docs here.

Naming Components

Components should be prefixed with mat. For example, a button would be named <mat-button>.

This is for two reasons:

• it ensures that components are identifiable with the MAT design system.
• web components cannot be a single name, e.g. button. Instead, they must be at least two words. Using the mat- prefix alleviates this requirement.

Using the Design System in other projects

Script tag

• Publish to NPM
• Put a script tag similar to this <script src='https://unpkg.com/my-component@0.0.1/dist/mycomponent.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/mycomponent.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc