Open primary navigation
Origami Frontend Components & Services

JSDoc: o-load

o-load has a support status of "dead". This means that there are no plans to fix any issues with this component, and it may stop working at any point. More information on the status of this component is available in the README. If you still rely on this component or have concerns, please contact the Origami team.

devOpts

Global Property

Type

  • Object

Required config for build modules on-the-fly via SystemJS plugin-babel

Links

oLoadResolvedModule

A resolved o-load module

Properties

  • component - (types: HTMLElement | types: undefined) The parent element of rendered component
  • config - (type: Object) The parsed component config
  • opts - (type: Object) The full o-load opts object

Type

Object

Links

oLoad(oLoadEl, defaultOpts)

Global Function

Main o-load constructor

parameter type default description
oLoadEl HTMLElement Element to replace with rendered component
defaultOpts Object Initial options object (merged with declarative opts)

Returns

  • Promise.<oLoadResolvedModule> - [description]

Links

createOptsFromDataSet(el)

Global Function

Rename data attributes and assign values to options Object

parameter type default description
el HTMLElement Parent HTML createElement

Returns

  • Object - - Parsed options object

Links

oLoad.init(rootEl, opts?)

Static Method

Initialise o-load

parameter type default description
rootEl undefined | HTMLElement | String A o-load element
opts? Object Optional configuration object

Returns

  • oLoad | Array.<oLoad> - - o-load instance(s)

Links

oLoad(oLoadEl, defaultOpts)

Global Function

Main o-load constructor

parameter type default description
oLoadEl HTMLElement Element to replace with rendered component
defaultOpts Object Initial options object (merged with declarative opts)

Returns

  • Promise.<oLoadResolvedModule> - [description]

Links

Status
dead Origami v1 (Bower)
Switch component view

GitHub: o-load

Install o-load

If using the Build Service, add o-load@^1.1.3 to your script and link tags.

If using the npm package manager for a Manual Build, run npm install --save-peer "@financial-times/o-load@^1.1.3".

Help & Support

o-load is maintained directly by the Origami team. If you have any questions about o-load or Origami in general, we are happy to help. 😊

Slack: #origami-support
Email: origami.support@ft.com

Feedback / Issues

To report a bug or request features please create an issue on Github. For support or general feedback please get in touch 😊

Slack: #origami-support
Email: origami.support@ft.com