|
1 |
| -# vue-spinner |
| 1 | +# vue-grid-layout |
2 | 2 |
|
3 |
| -A collection of loading spinners with Vue.js. Just convert yuanyan's React.js project [Halogen](https://github.com/yuanyan/halogen) to Vue.js components. Special thanks to [yuanyan](https://github.com/yuanyan) for the wonderful project. |
| 3 | +**WORK IN PROGRESS: USE AT YOUR OWN RISK!** |
4 | 4 |
|
5 |
| -## [Live demo](http://greyby.github.io/vue-spinner/) |
| 5 | +vue-grid-layout is a grid layout system, like [Gridster](http://gridster.net), for Vue.js. |
6 | 6 |
|
7 |
| -## Installation |
| 7 | +**Heavily inspired in [React-Grid-Layout](https://github.com/STRML/react-grid-layout)** |
8 | 8 |
|
9 |
| -### NPM |
10 |
| -```bash |
11 |
| -$ npm install vue-spinner |
12 |
| -``` |
| 9 | +It's responsive and supports breakpoints. Breakpoint layouts can be provided by the user |
| 10 | +or autogenerated. |
13 | 11 |
|
14 |
| -### CommonJS |
15 |
| -```js |
16 |
| -var PulseLoader = require('vue-spinner/src/PulseLoader.vue'); |
| 12 | +<!-- |
| 13 | +[**[Demo](https://jbaysolutions.github.io/vue-grid-layout/examples/0-showcase.html) | [Changelog](/CHANGELOG.md)**] |
| 14 | +--> |
17 | 15 |
|
18 |
| -new Vue({ |
19 |
| - components: { |
20 |
| - 'PulseLoader': PulseLoader |
21 |
| - } |
22 |
| -}) |
23 |
| -``` |
| 16 | +<!-- |
| 17 | +## Table of Contents |
24 | 18 |
|
25 |
| -### ES6 |
26 |
| -```js |
27 |
| -import PulseLoader from 'vue-spinner/src/PulseLoader.vue' |
| 19 | +- [Demos](#demos) |
| 20 | +- [Features](#features) |
| 21 | +- [Installation](#installation) |
| 22 | +- [Usage](#usage) |
| 23 | +- [Responsive Usage](#responsive-usage) |
| 24 | +- [Providing Grid Width](#providing-grid-width) |
| 25 | +- [Grid Layout Props](#grid-layout-props) |
| 26 | +- [Responsive Grid Layout Props](#responsive-grid-layout-props) |
| 27 | +- [Grid Item Props](#grid-item-props) |
| 28 | +- [Contribute](#contribute) |
| 29 | +- [TODO List](#todo-list) |
28 | 30 |
|
29 |
| -new Vue({ |
30 |
| - components: { |
31 |
| - PulseLoader |
32 |
| - } |
33 |
| -}) |
34 |
| -``` |
| 31 | +## Demos |
35 | 32 |
|
36 |
| -### For browserify |
37 |
| -If you use browserify + vueify, you may need to import vue-spinner like this: |
| 33 | +1. [Showcase](https://strml.github.io/react-grid-layout/examples/0-showcase.html) |
38 | 34 |
|
39 |
| -```js |
40 |
| -var PulseLoader= require('vue-spinner/dist/vue-spinner.min').PulseLoader; |
41 |
| -``` |
| 35 | +--> |
42 | 36 |
|
43 |
| -```js |
44 |
| -import { PulseLoader } from 'vue-spinner/dist/vue-spinner.min.js' |
45 |
| -``` |
| 37 | +#### Projects based on vue-grid-layout |
46 | 38 |
|
47 |
| -[explain here](https://github.com/greyby/vue-spinner/issues/2) |
| 39 | +- [Draxed](https://www.draxed.com/) |
48 | 40 |
|
49 |
| -### Browser globals |
50 |
| -The `dist` folder contains `vue-spinner.js` and `vue-spinner.min.js` with all components exported in the <code>window.VueSpinner</code> object. These bundles are also available on NPM packages. |
| 41 | +*Know of others? Create a PR to let me know!* |
51 | 42 |
|
52 |
| -```html |
53 |
| -<script src="path/to/vue.js"></script> |
54 |
| -<script src="path/to/vue-spinner.js"></script> |
55 |
| -<script> |
56 |
| - var PulseLoader = VueStrap.PulseLoader |
57 |
| -</script> |
58 |
| -``` |
| 43 | +## Features |
59 | 44 |
|
60 |
| -## Local setup |
| 45 | +* 100% Vue.js - no jQuery |
| 46 | +* Draggable widgets |
| 47 | +* Resizable widgets |
| 48 | +* Static widgets |
| 49 | +* Vertical auto-packing |
| 50 | +* Bounds checking for dragging and resizing |
| 51 | +* Widgets may be added or removed without rebuilding grid |
| 52 | +* Layout can be serialized and restored |
| 53 | +* Responsive breakpoints |
| 54 | +* Separate layouts per responsive breakpoint |
| 55 | +* Grid Items placed using CSS Transforms |
61 | 56 |
|
62 |
| -``` |
63 |
| -npm install |
64 |
| -npm run dev |
65 |
| -``` |
66 | 57 |
|
67 |
| -## Usage |
| 58 | +## Installation |
68 | 59 |
|
69 |
| -```html |
70 |
| -<pulse-loader :loading="loading" :color="color" :size="size"></pulse-loader> |
71 |
| -<grid-loader :loading="loading" :color="color" :size="size"></grid-loader> |
72 |
| -<clip-loader :loading="loading" :color="color" :size="size"></clip-loader> |
73 |
| -<rise-loader :loading="loading" :color="color" :size="size"></rise-loader> |
74 |
| -<beat-loader :loading="loading" :color="color" :size="size"></beat-loader> |
75 |
| -<sync-loader :loading="loading" :color="color" :size="size"></sync-loader> |
76 |
| -<rotate-loader :loading="loading" :color="color" :size="size"></rotate-loader> |
77 |
| -<fade-loader :loading="loading" :color="color" :height="height" :width="width"></fade-loader> |
78 |
| -<pacman-loader :loading="loading" :color="color" :size="size"></pacman-loader> |
79 |
| -<square-loader :loading="loading" :color="color" :size="size"></square-loader> |
80 |
| -<scale-loader :loading="loading" :color="color" :height="height" :width="width"></scale-loader> |
81 |
| -<skew-loader :loading="loading" :color="color" :size="size"></skew-loader> |
82 |
| -<moon-loader :loading="loading" :color="color" :size="size"></moon-loader> |
83 |
| -<ring-loader :loading="loading" :color="color" :size="size"></ring-loader> |
84 |
| -<bounce-loader :loading="loading" :color="color" :size="size"></bounce-loader> |
85 |
| -<dot-loader :loading="loading" :color="color" :size="size"></dot-loader> |
86 |
| -``` |
87 | 60 |
|
88 |
| -You can customize the color and size with setting the props. All props have default value. You can control the spinner show/hidden with setting the loading prop. |
89 | 61 |
|
90 |
| -## TODO |
| 62 | +## Usage |
| 63 | + |
| 64 | + |
| 65 | +## Contribute |
91 | 66 |
|
| 67 | +If you have a feature request, please add it as an issue or make a pull request. |
92 | 68 |
|
93 | 69 |
|
94 |
| -## License |
| 70 | +## TODO List |
95 | 71 |
|
96 |
| - vue-spinner is licensed under [The MIT License](LICENSE). |
| 72 | +- [x] Basic grid layout |
| 73 | +- [x] Fluid grid layout |
| 74 | +- [x] Grid packing |
| 75 | +- [x] Draggable grid items |
| 76 | +- [x] Live grid packing while dragging |
| 77 | +- [x] Resizable grid items |
| 78 | +- [x] Layouts per responsive breakpoint |
| 79 | +- [ ] Static elements |
| 80 | +- [ ] Min/max w/h per item |
| 81 | +- [ ] Resizable handles on other corners |
| 82 | +- [ ] Configurable w/h per breakpoint |
0 commit comments