furikaeru
v0.3.0
Published
> A minimal component lib for personal projects
Downloads
3
Readme
Furikaeru component library
A minimal component lib for personal projects
Note
Due to a vue bug https://github.com/vuejs/vue-next/issues/4783, boolean props are breaking, please expect some issues. thx
Features
- Tree shaked
- fully typed @johnsoncodehk/volar
- fully customizable @windicss, @antfu/vite-plugin-windicss
- Icons powered by @antfu/vite-plugin-purge-icons
Based on
- Vue 3
- Vite
- WindiCSS
- TypeScript
- Iconify
Usage
please don't skip following steps
install
yarn add furikaeru
npm install furikaeru
pnpm add furikaeru
install peer dependencies
- vue@next
- @iconify/iconify@latest
- @iconify/json@latest
- vite-plugin-purge-icons@latest
- click-outside-vue3@latest
- vite-plugin-windicss@latest
- windicss@latest
config
- add to windi config
// a safelist preset of some of the color classes, use this or import individual configs
// and extend. see lib/src/windi/index.ts
import { furiWindiSafelist } from 'furikaeru'
export default defineConfig({
safelist: [...furiWindiSafelist],
extract: { include: ['./node_modules/furikaeru/dist/*'] },
});
- import CSS (very small one)
import 'furikaeru/dist/style.css';
- register click-outside directive
import vClickOutside from 'click-outside-vue3';
app.use(vClickOutside);
Caution
even after doing all these, there might be some issues, I'm advising not use this for your projects. Thx