Skip to content

Highlight

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery/blob/main/js/accessibility/Highlight.ts for the most up-to-date information.

Overview

Highlights displayed by the overlay support these types. Highlight behavior works like the following: - If value is null, the highlight will use default stylings of HighlightPath and surround the Node with focus. - If value is a Shape the Shape is set to a HighlightPath with default stylings in the global coordinate frame. - If you provide a Node it is your responsibility to position it in the global coordinate frame. - If the value is 'invisible' no highlight will be displayed at all.

@author Jesse Greenberg (PhET Interactive Simulations)

Type Highlight

import type { Highlight } from 'scenerystack/scenery';

Node | Shape | null | "invisible"

Source Code

See the source for Highlight.ts in the scenery repository.