Origami Frontend Components & Services

SassDoc: o-overlay

oOverlay(opts)

Outputs all available features and styles for overlays.

The output includes the .o-overlay class definition as well as class definitions for every variant.

parameter type default description
opts (optional) 'variants': ('compact', 'full-screen', 'heading-shaded') Overlay options including variants to output styles for.

Examples

Example #1

All overlay styles

@include oOverlay();

Example #2

Base styles and compact variant, but with no full-screen or heading-shaded variants

@include oOverlay($opts: ('variants': ('compact'));

Links

oOverlayContentClose

Overlay close button styles.

The output does not include a class definition, and should be wrapped in a selector.

Example

Output button styles

.my-close-button {
    @include oOverlayContentClose();
}

Links

o-overlay-is-silent

Silent mode: on (true) or off (false) Set to false to output default overlay classes.

Links

oOverlay(opts)

Outputs all available features and styles for overlays.

The output includes the .o-overlay class definition as well as class definitions for every variant.

parameter type default description
opts (optional) 'variants': ('compact', 'full-screen', 'heading-shaded') Overlay options including variants to output styles for.

Examples

Example #1

All overlay styles

@include oOverlay();

Example #2

Base styles and compact variant, but with no full-screen or heading-shaded variants

@include oOverlay($opts: ('variants': ('compact'));

Links

Support Status
active
Switch component view

GitHub Repository

Install o-overlay

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

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

Help & Support

o-overlay is maintained directly by the Origami team. If you have any questions about o-overlay 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