bloum v0.9.1
Table of Contents
- ๐ Introduction
- ๐ Features
- ๐ฆ Installation
- ๐ป Usage
- ๐ Documentation
- โ๏ธ License
What is Bloum?
Bloum is an open-source library of web components. The goal of this library is to provide a set of CSS and JavaScript components that can be used in any web project, regardless of the framework or library used. The main use-case for Bloum is to provide easy-to-use components for a project using MPA (Multi-Page Application) like Laravel, Django or Rails. It pairs well with server-side rendering and progressive enhancement tools like HTMX and Alpine.js.
Features
- ๐ Feature-rich: Bloum provides a wide range of components to build modern web apps or design systems.
- ๐ชถ Lightweight: Bloum is light. It's less than 20KB minified and gzipped.
- ๐ Accessible: Built with accessibility in mind. It's fully keyboard-navigable and WAI-ARIA compliant.
- ๐ Dark mode: Supports dark mode out of the box.
- ๐ฑ Responsive: Works on all modern browsers and devices.
- ๐ฆ Single package: Everything is bundled in a single package for an easy setup.
- ๐จ Theming: Easy to customize with CSS variables.
Installation
CDN
Use the following lines in your head
tag
to load the latest version of Bloum from a CDN:
<script src="https://unpkg.com/bloum" defer></script>
<link href="https://unpkg.com/bloum/dist/bloum.min.css" rel="stylesheet">
Package Manager
Install Bloum using your favorite package manager:
# NPM
npm install bloum
# Yarn
yarn add bloum
# Pnpm
pnpm add bloum
# Bun
bun add bloum
Usage
Once installed, import the library in your JavaScript project:
import "bloum"
This will register all the components globally.
After that, include the stylesheet in your JavaScript if you're using a bundler like Vite or Webpack:
import "bloum/dist/bloum.min.css"
Then, use the components in your HTML.
Documentation
The documentation is available at https://www.bloum.dev for more information on how to use the components.
License
Bloum is MIT licensed ยฉ Gil Balsiger
4 months ago
4 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago