@coheia/simple-webcomponents v1.2.1

Simple Web Components

Proof of concept of a structure to automate the processes of development, documentation and distribution of webcomponents, designed to serve a Desgin System, or a UI Library which follows the principles of Component Driven UI, being built from the bottom up.

Live demo

Getting Started

git clone git@github.com:coheia/simple-webcomponents.git
cd simple-webcomponents
npm install
npm run dev

In a separated terminal run:

npm run storybook

This will launch the development server at http://localhost:3002, where you can view the Storybook and begin developing your own web components.

Note that prior knowledge of TypeScript, Sass, Lit, and Storybook is recommended. Refer to their respective documentation for more information on these technologies:

• typescript
• sass
• lit
• storybook

Simple Icons Feature

Simple Icons is a tool that converts SVG files into custom web components with options such as custom size and fill color. It generates LitElement components with a filename prefix "swc-i-" and an Iconography.mdx file that displays all the generated icons.

How it works

Roadmap

Alpha components are in-development and may have many frequent breaking
changes.

Beta components are mostly polished and ready for use.

Stable components are reviewed, documented, and API complete.

• 🔴 Not started
• 🟡 In progress
• 🟢 Complete

Components