Skip to content

CihanAksoy/vue-timeago

 
 

Repository files navigation

vue-timeago NPM version NPM downloads Build Status

A timeago component for Vue 1 and Vue 2.

Install

# for Vue 2
$ npm install --save vue-timeago
# for Vue 1
$ npm install --save vue-timeago@2

It's also available on NPMCDN: https://npmcdn.com/vue-timeago/index.umd.js

Usage

import VueTimeago from 'vue-timeago'

Vue.use(VueTimeago, {
  name: 'timeago', // component name, `timeago` by default
  locale: 'en-US',
  locales: {
    'en-US': require('vue-timeago/locales/en-US.json')
  }
})

Then in your lovely component:

<!-- simple usage -->
<!-- time is a dateString that can be parsed by Date.parse() -->
<timeago :since="time"></timeago>

<!-- Auto-update time every 60 seconds -->
<timeago :since="time" :auto-update="60"></timeago>

<!-- max time, time before this will not be converted  -->
<!-- otherwise use custom formatTime function to format -->
<!-- 86400 * 365 = a year -->
<timeago :since="time" :max-time="86400 * 365" :format="formatTime"></timeago>

<!-- custom locale -->
<!-- use a different locale instead of the global config -->
<timeago :since="time" locale="zh-CN"></timeago>

A very basic demo: https://egoistian.com/vue-timeago

i18n support

For all supported languages, see /locales, it's easy to add a new language support, feel free to submit a Pull Request to help us support more languages!

Development

I use rollup to build the cjs and umd version bundles, and use vbuild to build the example. Install them globally and then see the npm scripts.

License

MIT © EGOIST

About

A tiny timeago component for Vue 1 and 2.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 68.5%
  • Vue 31.5%