Building an HTML Widget

Why develop an HTML Widget?

HTML Widgets get downloaded to each Player, so they have several benefits over providing the same experience over an online HTML web page or Web Widgets.

HTML Widgets are great because they:

  • They are local, so they load even without a working Internet connection.
  • Have no CORS restrictions. You can create Widgets that pull in data from any online web site. E.g., retrieve stock market prices from an online web page without any prior arrangement and show them as you wish.
  • They are playback-aware, so they are notified when they are “loaded,” “shown,” and “hidden.” This makes better use of bandwidth.
  • You will soon have access to an API that will enable you to interact with the playback engine directly.

What are the requirements?

Required skills

Anyone who can develop an HTML5/Javascript web page can develop a Widget. No special skills are required. We also provide you with some required tools:

  • full documentation on how Widgets work
  • complete examples you can download and test

Creating an HTML Widget

Make sure you read the next section of the Developer’s guide to create your Widget or use one of our samples. After you are done, then you can upload it to Yodeck.

To create an HTML Widget, go to “Custom Widgets” and select to add a new HTML widget. In the form that appears:

  • type in the Name of the widget
  • choose an icon for your widget
  • add an optional Description for it
  • define the Zoom Factor (%)
  • toggle Auto Adjust Zoom
  • choose if you want to Enable Chromium
  • upload your ZIP file

How to ZIP your custom widget

Ensure ZIP your custom widget’s files without being in any folder on your PC’s desktop. More details on how to properly ZIP a custom widget can be found here.

  • write down the UI Configuration

Click ” Save ” to upload your custom widget.

html widget form

REMEMBER: After making changes in your Account, you need to Push Changes to your Monitors