PixiJS

Interface: AccessibleOptions

AccessibleOptions

When accessible is enabled on any display object, these properties will affect its accessibility.

Properties:
Name Type Default Description
accessible boolean false

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set
accessibleChildren boolean true

Setting to false will prevent any children inside this container to be accessible. Defaults to true.
accessibleHint string | null

Sets the aria-label attribute of the shadow div
accessiblePointerEvents PointerEvents 'auto'

Specify the pointer-events the accessible div will use Defaults to auto.
accessibleTitle string

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'container [tabIndex]'
accessibleType string 'button'

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.
tabIndex number 0

Members

accessible boolean

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Default Value:
  • false

accessibleChildren boolean

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Default Value:
  • true

accessibleHint string | null

Sets the aria-label attribute of the shadow div

accessiblePointerEvents PointerEvents

Specify the pointer-events the accessible div will use Defaults to auto.

Default Value:
  • 'auto'

accessibleTitle string

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'container [tabIndex]'

accessibleType string

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Default Value:
  • 'button'

tabIndex number

Default Value:
  • 0