PixiJS

Class: AccessibilityManager

PIXI.AccessibilityManager

The Accessibility manager recreates the ability to tab and have content read by screen readers. This is very important as it can possibly help people with disabilities access PixiJS content.

A DisplayObject can be made accessible just like it can be made interactive. This manager will map the events as if the mouse was being used, minimizing the effort required to implement.

An instance of this class is automatically created by default, and can be found at renderer.plugins.accessibility

new PIXI.AccessibilityManager (renderer)

AccessibilityManager.ts:83
Name Type Description
renderer PIXI.CanvasRenderer | PIXI.Renderer

A reference to the current renderer

Members

debug boolean

Setting this to true will visually show the divs.

Default Value:
  • false

isActive boolean readonly

Value of true if accessibility is currently active and accessibility layers are showing.

isMobileAccessibility boolean readonly

Value of true if accessibility is enabled for touch devices.

renderer PIXI.CanvasRenderer | PIXI.Renderer

The renderer this accessibility manager works for.

Methods

capHitArea (hitArea) void

AccessibilityManager.ts:384

Adjust the hit area based on the bounds of a display object

Name Type Description
hitArea PIXI.Rectangle

Bounds of the child

destroy () void

AccessibilityManager.ts:582

Destroys the accessibility manager

updateDebugHTML (div) void

AccessibilityManager.ts:374

private function that will visually add the information to the accessability div

Name Type Description
div HTMLElement