angular-reading-indicator v1.0.0

angular-reading-indicator

AngularJS directive that shows progressbar with the current reading progress of a given article or the whole website with a reading time estimate.

Copyright (C) 2015, Dominic Rico-Gomez hello@coderocket.me

Installation

You can choose your preferred method of installation:

• Through bower: bower install angular-reading-indicator --save
• Through npm: npm install angular-moment --save
• From a CDN: jsDelivr or CDNJS
• Download from github: angular-reading-indicator

Usage

Include both moment.js and angular-moment.js in your application.

<script src="components/moment/moment.js"></script>
<script src="components/angular-moment/angular-moment.js"></script>

Add the module angularMoment as a dependency to your app module:

var myapp = angular.module('myapp', ['angularMoment']);

If you need internationalization support, load specified moment.js locale file first:

<script src="components/moment/locale/de.js"></script>

Then call the amMoment.changeLocale() method (e.g. inside your app's run() callback):

myapp.run(function(amMoment) {
amMoment.changeLocale('de');
});

Configuration

Parameter preprocess(e.g: unix, utc) would pre-execute before.

angular.module('myapp').constant('angularMomentConfig', {
preprocess: 'unix', // optional
timezone: 'Europe/London' // optional
});

Timeago directive

Use am-time-ago directive to format your relative timestamps. For example:

<span am-time-ago="message.time"></span>
<span am-time-ago="message.time" am-preprocess="unix"></span>

angular-moment will dynamically update the span to indicate how much time passed since the message was created. So, if your controller contains the following code:

$scope.message = {
text: 'hello world!',
time: new Date()
};

The user will initially see "a few seconds ago", and about a minute after the span will automatically update with the text "a minute ago", etc.

amDateFormat filter

Format dates using moment.js format() method. Example:

<span>{{message.time | amDateFormat:'dddd, MMMM Do YYYY, h:mm:ss a'}}</span>

This snippet will format the given time as "Monday, October 7th 2013, 12:36:29 am".

For more information about Moment.JS formatting options, see the docs for the format() function.

amCalendar filter

Format dates using moment.js calendar() method. Example:

<span>{{message.time | amCalendar}}</span>

This snippet will format the given time as e.g. "Today 2:30 AM" or "Last Monday 2:30 AM" etc..

For more information about Moment.JS calendar time format, see the docs for the calendar() function.

amDifference filter

Get the difference between two dates in milliseconds. Parameters are date, units and usePrecision. Date defaults to current date. Example:

<span>Scheduled {{message.createdAt | amDifference : null : 'days' }} days from now</span>

This snippet will return the number of days between the current date and the date filtered.

For more information about Moment.JS difference function, see the docs for the diff() function.

Time zone support

The amDateFormat and amCalendar filters can be configured to display dates aligned to a specific timezone. You can configure the timezone using the following syntax:

angular.module('myapp').constant('angularMomentConfig', {
timezone: 'Name of Timezone' // e.g. 'Europe/London'
});

Remember to include moment-timezone.js in your project, otherwise the custom timezone functionality will not be available. You will also need to include a timezone data file that you can create using the Timezone Data Builder or simply download from here.

License

Released under the terms of the MIT License.