Miss any of our Open RFC calls?Watch the recordings here! »

polymer-twitter-timeline

1.0.1 • Public • Published

<twitter-timeline> Polymer Element

Build status XO code style

Wrapper of Twitter Widget.js as a customizable Polymer 3.0 WebComponent.

Why

Forget to import any library, just import the component and polifylls if needed (webcomponentsjs) and you are ready to go.

NOTE:

I'm using a modified version of @polymer/polymer which I forked, removing the flat (useless and problematic) property for yarn.

Install

$ yarn add polymer-twitter-timeline

Usage

You may want to load it using Webpack.

awesome-component.js

import 'polymer-twitter-timeline';
 
// Your awesome component logic...
 
...
 
static get template() {
  return `
  <twitter-timeline data-widget-id="yourAwesomeWidgetId" id="firstTimeline"></twitter-timeline>
  `
}
 
...

The demo uses a bundled element. You can check the webpack.config.js for more details.

Default Properties

 
{
  /** Twtt istance **/
  Twtt: {
    type: Function
  },
  uniqueId: {
    type: String,
    value: 'twitterTimelinePolymerLibLoader'
  },
  /**
   * Twitter data-id to feed the timeline
   * - Create a new widget: https://twitter.com/settings/widgets/new
   * - Get the data from whatever source you want
   * - Get the data-widget-id
   *
   */
  dataWidgetId: {
    type: String
  },
  /**
   * Specifies `width` and `height` of the widget
   *
   * @type {{width: string, height: string}}
   */
  size: {
    type: Object,
    value: () => {
      return {
        width: "400",
        height: "400"
      }
    }
  },
  /**
   * Value for `data-chrome` (https://dev.twitter.com/web/embedded-timelines#customize-widget-components)
   *
   * @type 'noheader,nofooter,noborders,noscrollbar,transparent'
  */
  chrome: {
    type: String,
    value: ''
  }
}
 

API

.loadTimeline(widgetId)

widgetId (optional)

Type: string
Will load (or reload) the timeline with the widget id passed or with the this.dataWidgetId property if setted.

Twitter data-id to feed the timeline:


.removeTimeline()

Remove current timeline.


Events

on-timeline-loaded

After the correct initialization of the library and the timeline

Twtt instance

The Twtt instance is available as this.Twtt

Other references

polymer-lib-loader - for loading the library

Develop

$ yarn

Compile and start a web server (http://localhost:8080/demo)

$ yarn start

Build: only the Webpack action simply run

$ yarn build

Test

XO for coding style and WCT for unit test:

$ yarn test

License

MIT © LasaleFamine

Keywords

none

Install

npm i polymer-twitter-timeline

DownloadsWeekly Downloads

1

Version

1.0.1

License

MIT

Last publish

Collaborators

  • avatar