chrissgon / perfectui Goto Github PK

View Code? Open in Web Editor NEW

An exceptionally lightweight and highly customizable CSS and JavaScript framework for crafting elegant user interfaces 🎨🚀

License: MIT License

SCSS 80.04% TypeScript 19.96%

perfectui's Introduction

Perfect UI

An exceptionally lightweight and highly customizable CSS and JavaScript framework for crafting elegant user interfaces. 🎨💡

📦 Install

By package manager

Install package

# npm
npm i @chrissgon/perfectui

# yarn
yarn add @chrissgon/perfectui

# pnpm
pnpm i @chrissgon/perfectui

# bun
bun i @chrissgon/perfectui

Import library on your project.

import { setMode } from "@chrissgon/perfectui";
import "@chrissgon/perfectui/dist/perfectui.css";

By CDN's.

Import CDN's on your html.

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/@chrissgon/perfectui@latest/dist/perfectui.css"
/>

<script src="https://cdn.jsdelivr.net/npm/@chrissgon/perfectui@latest/dist/perfectui.js"></script>

<script>
  // access the functions via window or document
  console.log(window.perfectui); // { setMode: ƒ ...}
  console.log(document.perfectui); // { setMode: ƒ ...}
</script>

💪🏻 Contribution

This project is open source and welcomes community contributions. Feel free to fork, implement improvements, and submit a pull request. Every contribution is valued and appreciated!

Feel free to explore the source code, provide feedback, and report any issues you encounter.

Perfect UI Figma is free for both commercial and personal projects.