Building a Web Widget

Building a Web Widget

Why develop a Web Widget?

Web Widgets are displayed on each Player, so they have several benefits over providing the same experience over an online HTML web page.

Web Widget pros:

  • They are online, so they will reload automatically and display the latest info.
  • 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.
  • Are playback-aware, so they are notified when they are “loaded,” “shown,” and “hidden.” This makes better use of bandwidth.
  • Web Pages can store data that survive a reboot.
  • Can log in to any web page that requires Authorization and display any graph or report of your choice

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 a Web 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
  • Add an optional Description for it.
  • Add the Web page’s URL
  • Choose an icon for your widget.
  • Set the Zoom factor (%) , which is set to 100% by default. By altering it, you zoom in (>100) or out (<100) of the web-page by the given percentage.
  • Auto-Adjust Zoom , which is also enabled by default, adjust the zoom for monitors with a width other than 1920 pixels so that they look the same.
  • Disable Private Browsing : Web pages by default open in private browsing mode to prevent caching issues. You can use the toggle to disable it.
  • Enable Chrome : Some modern web-pages do not work properly with WebKit. Currently, when using Chromium, the web-page can’t have transparency.
    5.1 Retain Session Data: By default, this feature is disabled when using Chromium. If you want to keep the same session for this web-page, you can click on the toggle to enable it. Upon enabling this option, the “Disable Private Browser” option will be enabled as well.
    5.2 Enable Flash Player : By default, this feature is disabled when using Chromium. If a web-page requires a flash player to display the web-page content, you can click on the toggle to enable it.
  • Scripting Engine (Run Custom Script) : You can click on the toggle to enable the scripting engine feature, where you can actually add scripts to run after a web-page is loaded to modify and navigate it as you wish. For more information, please check out the Web Scripting Engine section in the user manual.
  • Write down the UI Configuration

web widget form

Click ” Save ” to upload your custom widget.