Widgets in Apereo OAE

Lightning talk on widgets in Apereo OAE. How, why and more.

Transcript

1. June 04, 2013 Widgets in Apereo OAE Bert Pareyn
2. June 04, 2013 What’s a widget? • Modular component – HTML Fragment – JavaScript – CSS – i18n bundles – Con guration 2
3. June 04, 2013 • Reusable – Multiple instances of the same widget • e.g. embedding video • Specialized – Limited functionality • e.g. only embed video • Manageable – Can be small • Because of specialization 3 Why use widgets?
4. June 04, 2013 • 2 ways of using a widget – Build the page • e.g. show top and left hand navigation, display a content item, ... – Support for the context of the page • e.g. edit permissions of content, add members to a research group, change your pro le picture, ... 4 How do you use widgets?
5. June 04, 2013 • Widgets can be included on the page – <div data-widget='footer'><!-- --></div> • Widgets can be lazy loaded – Widget API loads widgets when triggered • Con guration (manifest.json) de nes triggers – Selectors » A CSS class added to an element – Events » When red, load the widget 5 How are widgets loaded?
6. June 04, 2013 • APIs and documentation – /docs for up-to-date documentation • Reusable components – Check out oae.components.css for reusable lists, buttons, icons, ... • Support! – irc #sakai – on list oae-dev@collab.sakaiproject.org 6 What help is out there?
7. June 04, 2013 • Widgets part of contribution model • Widget SDK – Documentation – Examples – Widget skeleton framework – Needs to be updated 7 Contributing
8. June 04, 2013 Widgets in Apereo OAE Bert Pareyn