https://github.com/lissy93/vue-checklist
☑️ Simple vue component for showing checklists
https://github.com/lissy93/vue-checklist
Last synced: 3 months ago
JSON representation
☑️ Simple vue component for showing checklists
- Host: GitHub
- URL: https://github.com/lissy93/vue-checklist
- Owner: Lissy93
- License: other
- Created: 2018-11-22T12:40:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-15T18:53:07.000Z (about 7 years ago)
- Last Synced: 2025-01-11T21:13:54.037Z (over 1 year ago)
- Language: Vue
- Homepage: https://vue-checklist.netlify.com/
- Size: 905 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Vue Checklist
A simple vue component for displaying checklist items
## Usage
### Install
`yarn add vue-checklist`
### Import and Use
```typescript
import Vue from 'vue';
import Component from 'vue-class-component';
import { Checklist } from 'vue-checklist';
@Component({
components: {
Checklist,
},
data: () => {
return {
theList: [
{ name: 'item 1', description: 'Lorem ipsum dolor sit amet', checked: false },
{ name: 'item 2', description: 'consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua', checked: false },
{ name: 'item 3', description: 'Ut enim ad minim veniam', checked: false },
],
};
},
})
export default class ChecklistExample extends Vue {}
```
## Contributing
If you find a bug, or have a feature suggestion, then feel free to raise an issue.
Pull requests are always welcome, either to add a feature, or to fix or improve something.
Building Locally:
- **Clone**: `git clone https://github.com/Lissy93/vue-checklist.git && cd vue-checklist`
- **Project setup**: `yarn install`
- **Compiles and hot-reloads for development**: `yarn run serve`
- **Compiles and minifies for production**: `yarn run build`
- **Lints and fixes files**: `yarn run lint`
- **Run the end-to-end tests**: `yarn run test:e2e`
## The MIT License (MIT)
### Copyright (c) Alicia Sykes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included install
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.