|
| 1 | +# Vue Grid Responsive |
| 2 | + |
| 3 | +[](https://www.npmjs.com/package/vue-grid-responsive) • [](https://github.com/andrelmlins/vue-grid-responsive/blob/master/LICENSE) • [](https://travis-ci.com/andrelmlins/vue-grid-responsive) |
| 4 | + |
| 5 | +Responsive grid system based on Bootstrap for Vue. |
| 6 | + |
| 7 | +## Installation |
| 8 | + |
| 9 | +### NPM |
| 10 | + |
| 11 | +``` |
| 12 | +npm i vue-grid-responsive |
| 13 | +// OR |
| 14 | +yarn add vue-grid-responsive |
| 15 | +``` |
| 16 | + |
| 17 | +### CDN |
| 18 | + |
| 19 | +```html |
| 20 | +<script src="https://unpkg.com/vue-grid-responsive"></script> |
| 21 | +``` |
| 22 | + |
| 23 | +### Manual |
| 24 | + |
| 25 | +You can also download and import it manually |
| 26 | + |
| 27 | +```html |
| 28 | +<script src="/vue-grid-responsive/dist/vue-grid-reponsive.min.js"></script> |
| 29 | +``` |
| 30 | + |
| 31 | +## Module import |
| 32 | + |
| 33 | +```js |
| 34 | +import Vue from 'vue'; |
| 35 | +import { Row, Column } from 'vue-grid-responsive'; |
| 36 | + |
| 37 | +Vue.component('row', Row); |
| 38 | +Vue.component('column', Column); |
| 39 | +``` |
| 40 | + |
| 41 | +## Examples |
| 42 | + |
| 43 | +An example of how to use the library: |
| 44 | + |
| 45 | +```vue |
| 46 | +<template> |
| 47 | + <row container gutter="{12}"> |
| 48 | + <column xs="{12}" md="{4}" lg="{3}"> |
| 49 | + xs=12 md=4 lg=3 |
| 50 | + </column> |
| 51 | + <column xs="{12}" md="{4}" lg="{3}"> |
| 52 | + xs=12 md=4 lg=3 |
| 53 | + </column> |
| 54 | + <column xs="{12}" md="{4}" lg="{3}"> |
| 55 | + xs=12 md=4 lg=3 |
| 56 | + </column> |
| 57 | + <column xs="{12}" md="{4}" lg="{3}"> |
| 58 | + xs=12 md=4 lg=3 |
| 59 | + </column> |
| 60 | + </row> |
| 61 | +</template> |
| 62 | +``` |
| 63 | + |
| 64 | +## Demo [Link](https://vue-grid-responsive.netlify.com/) |
| 65 | + |
| 66 | +Local demo: |
| 67 | + |
| 68 | +``` |
| 69 | +git clone https://github.com/andrelmlins/vue-grid-responsive.git |
| 70 | +cd vue-grid-responsive |
| 71 | +npm && npm run dev |
| 72 | +``` |
| 73 | + |
| 74 | +## Properties |
| 75 | + |
| 76 | +Component props: |
| 77 | + |
| 78 | +### Row Component props |
| 79 | + |
| 80 | +| Prop | Default | Type | Description | |
| 81 | +| ------- | ------- | ------ | -------------------------------------- | |
| 82 | +| gutter | - | number | Grid spacing in the container | |
| 83 | +| columns | 12 | number | Setting columns count in the container | |
| 84 | + |
| 85 | +### Column Component props |
| 86 | + |
| 87 | +| Prop | Default | Type | Description | |
| 88 | +| ---- | ------- | ------ | -------------------------- | |
| 89 | +| xs | - | number | Size in extra small screen | |
| 90 | +| sm | - | number | Size in small screen | |
| 91 | +| md | - | number | Size in medium screen | |
| 92 | +| lg | - | number | Size in large screen | |
| 93 | +| xl | - | number | Size in extra large screen | |
| 94 | + |
| 95 | +## NPM Statistics |
| 96 | + |
| 97 | +Download stats for this NPM package |
| 98 | + |
| 99 | +[](https://nodei.co/npm/vue-grid-responsive/) |
| 100 | + |
| 101 | +## License |
| 102 | + |
| 103 | +Vue Grid Responsive is open source software [licensed as MIT](https://github.com/andrelmlins/vue-grid-responsive/blob/master/LICENSE). |
0 commit comments