@justaweb-dev/histoire-library
v1.0.6
Published
A Histoire components library
Downloads
11
Readme
Histoire Component Library
A Vue 3 component library with accessible, modern UI components, built with Tailwind CSS and designed for easy integration into your projects.
Features
- Accessible color palette:
- Light mode: salmon tones
- Dark mode: dark grays and neon accents
- Fully typed with TypeScript
- Tailwind CSS for utility-first styling
- Dark mode support via
.darkclass - Ready for use as a package in other Vue projects
Installation
1. Build the library
pnpm install
pnpm build2. Link the library locally (for development)
In the library folder:
pnpm link --globalIn your consuming project (e.g. vue-frontend):
pnpm link --global @justaweb-dev/histoire-library3. Import the CSS in your app
import '@justaweb-dev/histoire-library/dist/histoire-comp-lib.css'Usage
Import and use components in your Vue app:
import { HButton, HNavbar, HCard, HHero, HInput, HInputUpload, HModal, HTable, HPagination } from '@justaweb-dev/histoire-library'Tailwind CSS in Production
Recent change:
To ensure Tailwind CSS styles are included and work correctly in production builds, the following line was added to src/global.css:
@import 'tailwindcss' important;This guarantees that all Tailwind utilities are available in the final CSS bundle, even after tree-shaking and minification.
Dark Mode
Dark mode is enabled using the .dark class on a parent element.
You can toggle dark mode by adding or removing the dark class on the <html> or <body> element.
Development
- Run storybook-like playground:
pnpm story:dev - Build for production:
pnpm build
License
MIT
