Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
klues committed Dec 19, 2024
1 parent 908fb7b commit 770af90
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# Vue CSS Grid Layout
A grid layout for Vue.js using CSS Grid. Developed for use in the [AAC application AsTeRICS Grid](https://github.com/asterics/AsTeRICS-Grid).
A grid layout for Vue.js using CSS Grid Layout.

<div align="center" width="100%">
<img src="img/dragging-resizing-collisions.gif" height="200">
<img src="img/move-all.gif" height="200">
</div>

## Features
This library was created since both [vue-grid-layout](https://github.com/jbaysolutions/vue-grid-layout) and [gridstack.js](https://github.com/gridstack/gridstack.js) didn't fit the requirements for the use in the [AAC application AsTeRICS Grid](https://github.com/asterics/AsTeRICS-Grid). The main features are:
* uses the native [CSS Grid Layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout) instead of absolute positioning
* automatically fills the whole container with same-sized grid elements ([not easily possible in gridstack.js](https://github.com/gridstack/gridstack.js/issues/2583))
* uses native [Vue List Move Transitions](https://v2.vuejs.org/v2/guide/transitions#List-Move-Transitions) for animations
* predictable collision handling: either swapping elements by dropping an element onto another element or move other elements to the right, by dropping it in-between two elements
* not moving other elements until dropping the moved element (not messing up of the layout while moving)
* easy way to move all elements

> [!NOTE]
> Currently only Vue `2.7` is supported. PR for Vue 3 are welcome.
## Use via npm in SFC
To use this library via npm and with Vue's Single-File Components (SFC), follow these steps:

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"version": "1.0.1",
"author": "Benjamin Klaus",
"license": "AGPL-3.0",
"keywords": ["vue", "vue.js", "vuejs", "vue-library", "grid layout", "CSS Grid", "grid", "raster"],
"keywords": ["vue", "vue.js", "vuejs", "vue-library", "grid layout", "CSS Grid", "grid", "raster", "draggable", "resizable"],
"type": "module",
"main": "dist/vue-css-grid-layout.umd.js",
"module": "dist/vue-css-grid-layout.es.js",
Expand Down

0 comments on commit 770af90

Please sign in to comment.