Home

Awesome

apiNG

Join the chat at https://gitter.im/JohnnyTheTank/apiNG npm version Bower version

apiNG-plugin-rss is a RSS plugin for apiNG.

Information

Documentation

  1. INSTALLATION
    1. Get file
    2. Include file
    3. Add dependency
    4. Add plugin
  2. USAGE
    1. Models
    2. Requests

1. INSTALLATION

I. Get file

Install via either bower, npm, CDN (jsDelivr) or downloaded files:

II. Include file

Include aping-plugin-rss.min.js in your apiNG application

<!-- when using bower -->
<script src="bower_components/apiNG-plugin-rss/dist/aping-plugin-rss.min.js"></script>

<!-- when using npm -->
<script src="node_modules/aping-plugin-rss/dist/aping-plugin-rss.min.js"></script>

<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/npm/aping-plugin-rss@latest/dist/aping-plugin-rss.min.js"></script>

<!-- when using downloaded files -->
<script src="aping-plugin-rss.min.js"></script>

III. Add dependency

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

angular.module('app', ['jtt_aping', 'jtt_aping_rss']);

IV. Add the plugin

Add the plugin's directive aping-rss="[]" to your apiNG directive and configure your requests

<aping
    template-url="templates/social.html"
    model="social"
    items="20"
    aping-rss="[{'path':'http://blog.hackerearth.com/feed'}]">
</aping>

2. USAGE

I. Models

Supported apiNG models

modelcontent
socialRSS feed
native (RSS)RSS feed

II. Requests

Every apiNG plugin expects an array of requests as html attribute.

Requests by URL

parametersampledefaultdescriptionoptional
pathhttp://blog.hackerearth.com/feedRSS feed urlno
items15Items per request (0-n)yes
parseImagefalsetrueUse true for try to parse image from content. This parameter only works for social modelyes
protocolhttpsUse https or http to force the protocol. Leave it blank to for dynamic choiceyes

Sample requests:

Licence

MIT