0.1.1 • Published 4 years ago

simple-vue-timer v0.1.1

Weekly downloads
5
License
ISC
Repository
github
Last release
4 years ago

vue-timer-library

This is a vuejs component to display a counter of the number of days, hours, minutes and seconds until/after a certain day.

Installation

npm install simple-vue-timer

Usage

import simpleVueTimer from 'simple-vue-timer'

Vue.component('svt', simpleVueTimer)

in your components
<svt
  :size="'sm'"
  :borderColor="'#d50'"
  :direction="'up'"
  :color="'#fff'"
  :bg="'#43a'"
  :time="new Date('2020/05/17')"
/>

Properties

ParamterDescriptionRequiredDefault
sizecontrols sizing of the rendered component: String. One of xs, sm, md, lgfalselg
timea date object : Datefalsenew Date()
bgwhat background the rendered component will have: Stringfalse#000
colorwhat color of text the rendered component will have: Stringfalse#fff
borderColorwhat color the border will have: Stringfalse#000
showMessagewhether to show simple message on the component: Booleanfalsefalse

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT