@group-gti/tc-rss-feed-widget NPM

TC RSS Feed Widget

This is a widget to display a RSS feeds from TARGETconnect, you will need your RSS feed url to use this widget.

Prerequisites

There are a few things you need to know before you can add the widget to your website/application:

You will need to know the version of the widget you want to use, the latest version can be found on npm
You will need your RSS feed Url, please contact TARGETconnect support if you are having trouble finding this.

Getting started

Paste the following script on to the webpage you want to display the widget on (replacing {version} & {url} with your values)

<script type="module" src="https://cdn.jsdelivr.net/npm/@group-gti/tc-rss-feed-widget@{version}/dist/tc-rss-feed-widget/tc-rss-feed-widget.esm.js"></script>
<tc-rss-feed-widget url="{url}"></tc-rss-feed-widget>

NOTE: version will be in x.x.x format (e.g 1.0.0)

Properties

Properties that can be passed into the widget:

Property	Description	Type	Default
`url`	TARGETconnect RSS feed Url	`string`	`-`
`heading`	Optional: Override the heading on the widget	`string`	`Feed title`
`description`	Optional: Override the desciption on the widget, if you want to turn the desciption off change to `false`	`string/boolean`	`Feed description`
`height`	Optional: Override the height of the widget, by default it will fill the HTML container it is in. Example height="500px"	`string`	`-`
`width`	Optional: Override the width of the widget, by default it will fill the HTML container it is in. Example width="350px"	`string`	`-`
`theme`	Optional: Turn the default widget theme off	`boolean`	`true`
`details`	Optional: Turn the details (modal) off	`boolean`	`true`

Please note the minimum width the widget can be is 250px.

Browser compatibility

The widget is build with Web components which are centered around the Custom Element v1 spec, a cross-browser way to define and create essentially new HTML tags, and is the successor to the now-defunct v0 spec.

We are currently supporting the following browsers: