timeago-vue

0.0.1 • Public • Published

timeago-vue

timeago-vue is a simple vue component used to format date with *** time ago statement. eg: '3 hours ago'.

The component based on timeago.js which is a simple javascript module.

  • Realtime render. Automatic release the resources.
  • Simple. Only 2kb.
  • Efficient. When the time is 3 hour ago, the interval will an hour (3600 * 1000 ms).
  • Locales supported.

Build Status npm npm npm

1. Install

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

2. Usage

import TimeagoVue from 'timeago-vue'
 
Vue.use(TimeagoVue, {
  name: 'timeago', // component name, `timeago` by default
});

Then in your lovely component:

<!-- simple usage -->
<!-- time is a dateString / Date instance -->
<timeago :datetime="datetime"></timeago>
 
<!-- live render, default is `true` -->
<timeago :datetime="time" :live="false"></timeago>
 
<!-- display locale, default is `en` -->
<timeago :datetime="time" :locale="zh_CN"></timeago>
 
<!-- set the class of HTML -->
<timeago :datetime="time" :className="my_timeago"></timeago>

A very basic demo: http://git.hust.cc/timeago-vue.

3. 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

# for dev 
$ npm run example
 
# for publishing 
$ npm run build

License

MIT © hustcc

Package Sidebar

Install

npm i timeago-vue

Weekly Downloads

1

Version

0.0.1

License

MIT

Last publish

Collaborators

  • atool