Skip to content

webtui/webtui

Repository files navigation

WebTUI

Modular CSS Library that brings the beauty of Terminal UIs to the browser

Quickstart

Install the base WebTUI package with your preferred package manager

bun i @webtui/css
npm i @webtui/css
yarn add @webtui/css
pnpm install @webtui/css

In your global CSS file, define the order of layers then import the library

@layer base, utils, components;

@import '@webtui/css';

Start using the library in your HTML

<button>click</button>
<button size-="large">click me too</button>
<div box-="square">
    <p>content</p>
</div>

For more detailed installation instructions, see the installation guide and framework-specific installations

Packages

All the officially-maintained packages in the monorepo

Development

This repository is a monorepo that contains the website and all the official WebTUI packages.

  1. Ensure Bun is installed
  2. Clone the repository
    git clone https://github.com/webtui/webtui
  3. Install dependencies
    bun i
  4. Build the project
    bun run build
  5. Start the dev server
    bun run dev