check
Code copied to clipboard.
close
menu

State Layer

State layers are absolutely-positioned div blocks that respond to mouse events on their PARENT element. By default, they change opacity in response, but they can be tweaked to do anything that's supported by a CSS transition.

Example Instance

<StateLayer bgColor="onprimary"></StateLayer>

content_copy
warning
Note: The above snippet omits import statements and surrounding markup. It's assumed you'd be pasting this inside the return block of an existing functional component.

Installation

Next.js

Note: Other React frameworks are not currently supported, but they might still work. Try at your own risk.

Method Instructions
LiftKit CLI
From any Next.js project, run the following command in your terminal.
npm run add state-layer
content_copy
Github open_in_new View on Github

Props

Unique

Props unique to this component.

Name Required Type Description Default Val
bgColor no LkColor | "currentColor" Background color of the state layer undefined
forcedState no "hover" | "active" | "focus" Applies a static state manually (e.g., for selected options) undefined

Common

Props with globally-defined behavior that are used in multiple components.