This version of this component hasn't been branded yet.

Please check the latest version, 2.4.3, as branding is a relatively new addition to our components.


Responsive, configurable overlays for displaying notifications to users


Modal overlay

Standard modal. Includes a close button in the top left so the user can dismiss the overlay.

Modal fullscreen overlay

Fullscreen modal. The user can dismiss the overlay with the close button or back button.

Modal without close button

Modal without a dismiss button in the top right. This should be used where the user has to make a choice or confirm they've seen something.

An overlay that is nested in the page

O-overlay can also be used to create overlays that don't sit in the front centre of the screen but appear in a specific area.

<div class="content">
	<div class="blur left">

		<h2>What is Lorem Ipsum?</h2>
		<p>Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry&apos;s standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>

		<h2>Why do we use it?</h2>
		<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using &apos;Content here, content here&apos;, making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for &apos;lorem ipsum&apos; will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>
	<div class="right-rail">
		<p>Hello! this is the right rail</p>
Bower Dependencies
ftdomdelegate ^2.0.1
o-colors ^4.0.0
o-dom >=0.4.0 <3
o-hoverable >=0.2.0 <4
o-icons >=4.0.0 <6.0.0
o-normalise ^1.2.1
o-layers >=0.2.0 <3
o-viewport >=0.1.1 <4
o-visual-effects ^2.0.0
o-brand ^2.0.2
GitHub Repository


Build Service

Add the following to your <script> and <link> tags.


How do I do that?

For more information see the Origami build service.

Manual Build Process

Run the following command in the root directory of your project, to add this dependency to your bower.json file:

bower install --save "o-overlay"@"^2.4.1"

For more information see the Origami build process.