PIXI.AccessibilityManager

class 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

Constructor

new PIXI.AccessibilityManager(renderer: PIXI.CanvasRenderer | PIXI.Renderer) → {}

Parameters:
Name	Type	Description
renderer	PIXI.CanvasRenderer \| PIXI.Renderer	A reference to the current renderer

Summary

Properties from AccessibilityManager

boolean	debug = false Setting this to true will visually show the divs.
boolean	isActive
boolean	isMobileAccessibility
PIXI.CanvasRenderer \| PIXI.Renderer	renderer

Methods from AccessibilityManager

void

capHitArea(hitArea: PIXI.Rectangle)

void

destroy()

Destroys the accessibility manager

void

updateDebugHTML(div: HTMLElement)

Public Properties

debug AccessibilityManager.ts:48

debug: boolean = false

Setting this to true will visually show the divs.

isActive AccessibilityManager.ts:127

isActive: boolean

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

isMobileAccessibility AccessibilityManager.ts:137

isMobileAccessibility: boolean

Value of true if accessibility is enabled for touch devices.

renderer AccessibilityManager.ts:51

renderer: PIXI.CanvasRenderer | PIXI.Renderer

The renderer this accessibility manager works for.

Public Methods

capHitArea AccessibilityManager.ts:385

capHitArea(hitArea: PIXI.Rectangle) → {void}

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

Parameters:
Name	Type	Description
hitArea	PIXI.Rectangle	Bounds of the child

Returns:
Type	Description
void

destroy AccessibilityManager.ts:581

destroy() → {void}

Destroys the accessibility manager

Returns:
Type	Description
void

updateDebugHTML AccessibilityManager.ts:375

updateDebugHTML(div: HTMLElement) → {void}

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

Parameters:
Name	Type	Description
div	HTMLElement

Returns:
Type	Description
void