Utility to allow selective enabling/disabling of hover effects
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
test
.gitignore
README.md
bower.json
main.js
main.scss
origami.json
package.json

README.md

Origami hover effects Build Status

Helper to activate hover states only on devices that support them, preventing unintended hover effects from happening on touch devices.

Usage

Add this class to the document to enable hover effects:

<!-- This class gets removed on touch devices -->
<html class="o-hoverable-on">

Why o-hoverable?

It's common for interactive elements on web pages to have hover effects, either via JavaScript mouse* events, or via CSS :hover pseudoclasses. However, while some users will be interacting with your web page using a mouse, others may be using a touch screen. Since touch screens typically don't have a 'hover' capability, hover effects are usually undesirable.

In fact, some touch devices may have 'emulated hover', where the first touch activates a hover effect and the second is treated as a click. This is a way for the browser to provide a way to use pages that 'require' hover (e.g. to select a flyout menu option) but this is also usually undesirable if you design your site sensibly.

This module provides for all Origami hover effects to be turned on and off, and provides a JavaScript utility to do so intelligently based on the input devices available to the user.

Sass

Component developers must prefix :hover states with $o-hoverable-if-hover-enabled, allowing hover effects to be configured by this module:

@import 'o-hoverable/main';

#{$o-hoverable-if-hover-enabled} .o-mymodule-button:hover {
	// Paint it black when hover is supported
	background: black;
}

Compiles to:

.o-hoverable-on .o-mymodule-button:hover {
	background: black;
}

JavaScript

Component developers must load hover effects conditionnally:

function showMyMenuOnHover() {
	if (!require('o-hoverable').isHoverEnabled()) {
		// Hover isn't supported: don't do anything
		return;
	}
	// Hover is supported: show a menu
}

Configuring the class

If you want to change the class used to trigger hover effects, you can do so by redefining the $o-hoverable-if-hover-enabled variable before importing this module's Sass.

$o-hoverable-if-hover-enabled: '.do-that-hover-thang';

And calling setClassName on the JavaScript module:

require('o-hoverable').setClassName('do-that-hover-thang');

Disabling o-hoverable

Restore hover effects on all devices (even touch devices):

$o-hoverable-if-hover-enabled: '';
@import 'o-hoverable/main';

#{$o-hoverable-if-hover-enabled} .o-mymodule-button:hover {
	// Paint it black
	background: black;
}

Compiles to:

.o-mymodule-button:hover {
	background: black;
}

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.