Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

Latest commit

 

History

History
55 lines (38 loc) · 1.72 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.72 KB
Raw

UI Component library templates

A set of templates for frontend libraries such as React and Preact. Each library will be compiled to ES modules1. The scss files will be compiled into a single css file, due to this shortcoming you might need to purge the unused styling for the best load times.

Usage example

First you need to import the CSS stylings. Keep in mind for frameworks such as Next.js, you need to import this file at a specific place to make it a global styling.

import 'your-lib-name/index.css';

Then you can import the component like the following code code snippet.

import { YourComponentName } from 'your-lib-name';

Warning
Keep in mind the compiled components lacks the "use client" directive, therefor incase of next.js 13 app dir, you will need to wrap them inside a client component2

Supported libraries

Component library support
React ✅
Preact ✅
Svelte -
Solid -
... -

Stack

  • Typescript
  • Scss
  • Postcss
  • Rollup
  • Eslint
  • Prettier
  • Tslib

Caution

Since I don't have that much experience in writing javascript libraries, there might be some mistakes in implementations, therefore please use these templates with caution.

Copyright

This project is licensed under MIT license.


Footnotes

  1. https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive ↩

  2. https://beta.nextjs.org/docs/rendering/server-and-client-components#third-party-packages ↩