https://github.com/moebiusmania/tumblr-feed
Web Component for easily getting a Tumblr blog JSON feed
https://github.com/moebiusmania/tumblr-feed
component feed tumblr web webcomponent
Last synced: 3 months ago
JSON representation
Web Component for easily getting a Tumblr blog JSON feed
- Host: GitHub
- URL: https://github.com/moebiusmania/tumblr-feed
- Owner: moebiusmania
- License: apache-2.0
- Created: 2016-12-31T22:22:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-10T17:06:11.000Z (about 8 years ago)
- Last Synced: 2025-03-01T02:45:47.872Z (4 months ago)
- Topics: component, feed, tumblr, web, webcomponent
- Language: JavaScript
- Homepage: https://moebiusmania.github.io/tumblr-feed/
- Size: 77.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# <tumblr-feed>
Web Component for easily getting a Tumblr blog JSON feed.
## Install
```
$ yarn add tumblr-feed
```
then inside your JS files you can include it
```js
import 'tumblr-feed';
```
or if you want to use the pre built version
```html
```
## How to use
The bare minimum to have it working is to write the tag with the "blog" attribute set:
```html
```
and then in your Javascript file
```js
function tumblr(data){
console.log(data) // the data returned from the specified blog
}
```
## Options
|Property|Type|Default|Required|Description|
|--------|----|-------|--------|---|
|blog|String|"staff"|true| the name of the blog you want to load data from (example: **staff**.tumblr.com)|
|callback|String|"tumblr"|false|the name of the callback function that will be executed on loading the feed|
|posts|Number|10|false| the number of posts to get, **maximum 50**|
## Polyfill
This component is built on top of [Web Components](https://www.webcomponents.org/) v1 specification, if you need to have it run on **modern browsers** (*modern means excluding IE11...*) you can include the [official polyfill](https://github.com/webcomponents/webcomponentsjs), available on both the NPM and Bower registries.
**#usetheplatform**
## Limitations / project purpose
This Feed APIs are **really bad designed** by Tumblr, so all limitations like max number of posts and the callback function exposed as a global one cannot be overridden.
The purpose of this web component is to quickly retrieve one or more Tumblr blogs feed (in JSON format) for simple projects.
If you need deeper integration with Tumblr inside an application you should definetely look for the [official APIs](https://www.tumblr.com/docs/en/api/v2).
## License
Distributed under the [Apache 2.0](LICENSE) license.