Extensions add specific functionality to Items API. They rely on modules within LT being available.
--
Adds a semi-transparent overlay on top of the entire page. This is for users who have sensitivity to bright light, high contrast, or blue light.
Methods
halt()
Turns off the page overlay.
Since
- 0.9.0
run(customColoropt, customZIndexopt)
Since
- 0.9.0
Example
import { LT } from '@caspingus/lt/src/assessment/index';
LT.init(itemsApp); // Set up LT with the Items API application instance variable
LT.extensions.pageOverlay.run();Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
customColor |
string |
<optional> |
A custom color value to use for the overlay. Recommend rgba. Defaults to rgba(250, 170, 140, 0.5) |
customZIndex |
number |
<optional> |
A custom z-index value to use for the overlay. Defaults to 99999. |