Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Latest commit

 

History

History
62 lines (43 loc) · 2.05 KB

README.md

File metadata and controls

62 lines (43 loc) · 2.05 KB

Vue-Widgets

The vue-widgets provide customized vue component for displaying content with headers (similar to bootstrap panel), which is useful for building dashboards quickly. This component can hold any content you provide, such as charts, text, images etc. using the vue slots mechanism. This component allows header customization, with properties such as collapse, fullscreen and close. User can customize the header and it's background color and the component will remember its state using localstorage. User can easily enable or disable any of the built-in features (collapse, fullscreen, close, set color etc.) using the component options.

Live Example

http://162.242.223.167:9000/

Installing

npm install vue-widgets -S

Getting Started

import Vue from 'vue'
import VueWidgets from 'vue-widgets'
import 'vue-widgets/dist/styles/vue-widgets.css'

Vue.use(VueWidgets)

Usage

<Widget>
    <WidgetHeading :id="1" :Title="'Heading'" :TextColor="true" :DeleteButton="true" :ColorBox="true" :Expand="true" :Collapse="true"></WidgetHeading>
    <WidgetBody>
        body content
    </WidgetBody>
</Widget>

Prerequisites

Node.js 4+ NPM 3+ and Vue Js 2.0+ are required.

Development

Install all required dependencies:

npm install

// Build and run the project
npm run dev

Go to localhost:8081 to inspect the example in your Browser.

Built With

  • Webpack - The web framework used
  • gulp - Automated development toolkit

Contributing

If you find a bug or want to contribute to the code or documentation, you can help by submitting an issue or a pull request

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

vue-widgets icons is brought to you by fontawesome