Skip to content

Commit 333c55b

Browse files
author
stefanBid
committed
chore: update package configuration and improve build process
- Changed type definitions output path in package.json from "types/index.d.ts" to "dist/index.d.ts". - Updated exports in package.json to include types for better module resolution. - Removed "types" directory from files array in package.json. - Simplified build script in package.json by removing vue-tsc declaration generation. - Added vite-plugin-dts to generate TypeScript declaration files during the build. - Renamed function from useFloatingPanel to useSbFloatingPanel for consistency in src/use-sb-floating-panel/useSbFloatingPanel.ts. - Updated index export in src/index.ts to explicitly export useSbFloatingPanel. - Removed declarationDir from tsconfig.json to streamline output to dist. - Updated vite.config.ts to include vite-plugin-dts and adjusted path resolution. - Created README.md for project documentation. - Initialized package.json for sb-floating-panel-vue with relevant metadata and dependencies.
1 parent 202bb25 commit 333c55b

File tree

9 files changed

+844
-21
lines changed

9 files changed

+844
-21
lines changed

β€ŽREADME.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
# sb-floating-panel-vue
2-
A lightweight Vue 3 composable hook built on top of @floating-ui/vue to easily manage floating panels with optional arrow and responsive width support.
2+
[![npm](https://img.shields.io/npm/v/sb-floating-panel-vue.svg)](https://www.npmjs.com/package/sb-floating-panel-vue)
3+
[![license](https://img.shields.io/npm/l/sb-floating-panel-vue.svg)](https://github.com/stefanobiddau/sb-floating-panel-vue/blob/main/LICENSE)
4+
5+
> A lightweight Vue 3 composable hook built on top of [@floating-ui/vue](https://github.com/floating-ui/floating-ui) to manage floating panels with arrow and resize support.
6+
7+
---
8+
9+
## ✨ Features
10+
11+
- πŸ“¦ Minimal and composable API
12+
- 🎯 Precise floating panel positioning via `@floating-ui/vue`
13+
- 🎈 Optional arrow positioning
14+
- πŸ“ Auto-resize support
15+
- 🧠 TypeScript-first
16+
17+
---
18+
19+
## πŸš€ Installation
20+
21+
```bash
22+
npm install sb-floating-panel-vue
23+
# or
24+
yarn add sb-floating-panel-vue

0 commit comments

Comments
Β (0)