@window-splitter/vue 0.8.5 → 0.8.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/.turbo/turbo-build.log +4 -4
  2. package/CHANGELOG.md +12 -0
  3. package/README.md +60 -0
  4. package/package.json +5 -5
package/.turbo/turbo-build.log CHANGED
@@ -1,15 +1,15 @@
1
1
 
2
2
  
3
- > @window-splitter/vue@0.8.4 build /Users/andrew/Documents/react-window-splitter/packages/vue
3
+ > @window-splitter/vue@0.8.5 build /Users/andrew/Documents/react-window-splitter/packages/vue
4
4
  > vite build
5
5
 
6
6
  The CJS build of Vite's Node API is deprecated. See https://vite.dev/guide/troubleshooting.html#vite-cjs-node-api-deprecated for more details.
7
7
  vite v6.3.3 building for production...
8
- transforming (1) src/index.tstransforming (12) ../interface/dist/esm/mergeAttributes.js✓ 14 modules transformed.
8
+ transforming (1) src/index.ts✓ 14 modules transformed.
9
9
  rendering chunks (1)...
10
10
  [vite:dts] Start generate declaration files...
11
11
  computing gzip size (0)...computing gzip size (1)...dist/index.mjs 52.74 kB │ gzip: 14.31 kB │ map: 166.06 kB
12
- [vite:dts] Declaration files built in 1823ms.
12
+ [vite:dts] Declaration files built in 1560ms.
13
13
  
14
14
  rendering chunks (1)...computing gzip size (1)...dist/index.js 37.98 kB │ gzip: 12.41 kB │ map: 162.27 kB
15
- ✓ built in 2.07s
15
+ ✓ built in 1.77s
package/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ # v0.8.6 (Sun May 04 2025)
2
+
3
+ #### ⚠️ Pushed to `main`
4
+
5
+ - add readme ([@hipstersmoothie](https://github.com/hipstersmoothie))
6
+
7
+ #### Authors: 1
8
+
9
+ - Andrew Lisowski ([@hipstersmoothie](https://github.com/hipstersmoothie))
10
+
11
+ ---
12
+
1
13
  # v0.8.5 (Sun May 04 2025)
2
14
 
3
15
  #### 🐛 Bug Fix
package/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # @window-splitter/vue
2
+
3
+ A full featured window splitter for Vue.
4
+
5
+ - Support for the full [window splitter](https://www.w3.org/WAI/ARIA/apg/patterns/windowsplitter/) ARIA spec
6
+ - Support for percentage and pixel based constraints
7
+ - Collapsible panels
8
+ - Controlled panels
9
+ - Layout Persistance - LocalStorage and Cookie
10
+
11
+ [Read the full docs](https://react-window-splitter-six.vercel.app)
12
+
13
+ > NOTE: Docs are currently on react but it's the same API. Refer the the stories for usage examples.
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ npm install @window-splitter/vue
19
+ ```
20
+
21
+ ## Usage
22
+
23
+ ```vue
24
+ <script setup>
25
+ import { PanelGroup } from "@window-splitter/vue";
26
+ </script>
27
+
28
+ <template>
29
+ <PanelGroup>
30
+ <Panel min="130px" max="400px" />
31
+ <PanelResizer />
32
+ <Panel min="130px" />
33
+ </PanelGroup>
34
+ </template>
35
+ ```
36
+
37
+ ## Features
38
+
39
+ - WAI-ARIA compliant
40
+ - Keyboard accessible
41
+ - Touch friendly
42
+ - Customizable
43
+ - TypeScript support
44
+
45
+ ## Server Side Rendering + Strict Mode
46
+
47
+ While not required for the simple case, for anything more complex you will
48
+ need to add an `id` prop to your panels and handles.
49
+ This is so that the component can tell all of the components apart during layout and rendering.
50
+
51
+ Features that require `id`:
52
+
53
+ - Conditional Panels
54
+ - Server Side Rendering
55
+
56
+ ## Prior Art
57
+
58
+ This library is heavily inspired by the following libraries:
59
+
60
+ - [react-resizable-panels](https://github.com/bvaughn/react-resizable-panels)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@window-splitter/vue",
4
- "version": "0.8.5",
4
+ "version": "0.8.6",
5
5
  "sideEffects": false,
6
6
  "homepage": "https://react-window-splitter-six.vercel.app",
7
7
  "repository": {
@@ -38,7 +38,7 @@
38
38
  "license": "MIT",
39
39
  "description": "A WAI-ARIA compliant window splitter for Vue.",
40
40
  "devDependencies": {
41
- "@internal/eslint-config": "0.8.5",
41
+ "@internal/eslint-config": "0.8.6",
42
42
  "@storybook/vue3": "^8.6.12",
43
43
  "@storybook/vue3-vite": "^8.6.12",
44
44
  "@testing-library/dom": "^10.4.0",
@@ -60,8 +60,8 @@
60
60
  "vue": "^3.5.13"
61
61
  },
62
62
  "dependencies": {
63
- "@window-splitter/interface": "0.8.5",
64
- "@window-splitter/state": "0.8.5"
63
+ "@window-splitter/interface": "0.8.6",
64
+ "@window-splitter/state": "0.8.6"
65
65
  },
66
66
  "peerDependencies": {
67
67
  "vue": ">=3.x"
@@ -80,5 +80,5 @@
80
80
  },
81
81
  "types": "./dist/index.d.ts",
82
82
  "module": "./dist/index.mjs",
83
- "gitHead": "b1a919f0f05d2216d8926513fb191167a5437674"
83
+ "gitHead": "7bdd351ea9e9a209d4a8db3a66f7742ee8e2db1b"
84
84
  }