Giter VIP home page Giter VIP logo

timeago-js's Introduction

timeago-js

timeago-js is a small (<1 kb) Javascript library with multilingual support that automatically updates date elements with user friendly statements, such as "just now", "n seconds ago" etc. It offers mul

How to install

  1. git clone https://github.com/osmanjtekin/timeago-js.git

  2. Add type="module" to the script tag, and import {timeago} from "./helpers/timeago-js/timeago.js" to the js file.

Usage

By default, the timeago() function:

  • Targets all elements with the time class.
  • Retrieves the timestamp value (in seconds) from the data-timestamp attribute of the targeted elements.
  • Sets the refresh rate to 30 seconds
  • Sets the language to English

Custom values can be set with: timeago(<class_name>, <refresh_rate>, <language>).

Adding a language

To include a new language, add a new array containing the localized string to languages.js:

const <language>_<territory> = [
    "<now|one second ago>",    "<seconds ago>",
    "<one minute ago>",        "<minutes ago>",
    "<one hour ago>",          "<hours ago>",
    "<one day ago>",           "<days ago>",
    "<one week ago>",          "<weeks ago>",
    "<one month ago>",         "<months ago>",
    "<one year ago>",          "<years ago>"
  ];

Where:

Make sure you add <language>_<territory> to export.

Then either open an issue or submit a pull request.

License

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.