Skip to content

A versatile UI component library with built-in support for both dark and light modes. Users can easily customize components globally or locally, following a lightweight CSS framework aligned with HTML standards. It also provides multiple themes and a user-friendly color scheme generator.

License

Notifications You must be signed in to change notification settings

ioak-io/basicui

Repository files navigation

Basicui

Basicui offers a versatile UI component library with built-in support for both dark and light modes. Users can easily customize components globally or locally, following a lightweight CSS framework aligned with HTML standards. It also provides multiple themes and a user-friendly color scheme generator. Moreover, it boasts rich typographic support for enhanced text-based content.

Key Features

Dark Mode & Light Mode Support: Integrated support for both dark and light modes, ensuring user preference adaptability.

Customizability: Global and local customization options empower users to tailor components according to their needs. Modify components universally or fine-tune specific instances effortlessly.

Lightweight CSS Framework: Aligned with original HTML standards, this CSS-driven framework prioritizes simplicity without introducing new syntax or complex interface parameters.

Multiple Theme Support: Enables the utilization of various themes, allowing for diverse visual presentations.

Color Scheme Generation: A user-friendly utility simplifies the generation of color gradations for any chosen color, streamlining the customization process.

Rich Typographic Support: Comprehensive support for varied typography, enhancing the visual appeal and readability of content.

Interactive Documentation (Storybook): A robust documentation system with Storybook integration, offering an interactive environment for exploring components, their functionality, and implementation. This facilitates smoother development and understanding for users.

Supported Node.js and npm Versions

This project is developed and tested with the following versions:

  • Node.js: v20.0.0 or higher
  • npm: v10.0.0 or higher

Prerequisites and dependencies

  • None

Installation

  1. Clone the repository: git clone https://github.com/ioak-io/basicui.git
  2. Navigate to the project directory: cd basicui
  3. Install dependencies: npm install

Usage

  1. Run the development server: npm run storybook
  2. Open your browser and go to http://localhost:6006 to view the app.

Documentation

Access the interactive playground https://basicui.ioak.io

Dependency Updates

The dependencies in this project are regularly reviewed and updated. The last check for updated versions was performed on 29th Dec 2023.

To check for updates and update the dependencies, run the following command: npm outdated

License

This project is licensed under the MIT License.

The MIT License is a permissive open-source license that allows you to use, modify, and distribute the code, even for commercial purposes, provided you include the original copyright notice and the disclaimer of warranty.

For more information, see the MIT License file.

About

A versatile UI component library with built-in support for both dark and light modes. Users can easily customize components globally or locally, following a lightweight CSS framework aligned with HTML standards. It also provides multiple themes and a user-friendly color scheme generator.

Resources

License

Stars

Watchers

Forks

Packages

No packages published