Origami Frontend Components & Services

Readme: o-loading

This is an Origami component that provides a visual loading indicator.

Markup

In order to display a loading indicator in your product, you will need to supply the theme and the size modifiers in your markup, e.g.:

<div class="o-loading o-loading--light o-loading--small"></div>

Sass

In order to output all of the variations in theme and size of o-loading, you'll need to include the following:

@import 'o-loading/main';

@include oLoading();

You can also be more selective about which themes or sizes of the loading indicator you wish to output, by using a map.
The $opts map accepts two lists:

'themes':

And 'sizes':

@import 'o-loading/main';

@include oLoading($opts: (
    'themes': ('light'),
    'sizes': ('medium', 'large')
));

// outputs a large light spinner and a medium light spinner

If you need to build a loading spinner into a component, for example, you can use the following mixin:

@import 'o-loading/main';

.my-loading-spinner {
    @include oLoadingContent($opts: (
        'theme': 'light',
        'size': 'small'
    ));
}

Migration

State Major Version Last Minor Release Migration guide
✨ active 3 N/A migrate to v3
⚠ maintained 2 2.3 migrate to v2
╳ deprecated 1 1.0 N/A

Contact

If you have any questions or comments about this component, or need help using it, please either raise an issue, visit #ft-origami or email Origami Support.

Licence

This software is published by the Financial Times under the MIT licence.

Switch component view

GitHub Repository

Install o-loading

If using the Build Service, add o-loading@^3.1.2 to your link tag. Ensure the correct brand is set with a query parameter &brand=internal.

If running a Manual Build, run bower install --save "o-loading@^3.1.2".

Help & Support

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

Slack: #ft-origami
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: #ft-origami
Email: origami.support@ft.com