pixi.js

Version:

pixijs.com

pixijs/pixijs

1 lines • 5.74 kB

Source Map (JSON)

View Raw

{"version":3,"file":"accessibilityTarget.mjs","sources":["../../src/accessibility/accessibilityTarget.ts"],"sourcesContent":["import type { Container } from '../scene/container/Container';\n\n/**\n * The type of the pointer event to listen for.\n * @category accessibility\n * @standard\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events\n */\nexport type PointerEvents = 'auto'\n| 'none'\n| 'visiblePainted'\n| 'visibleFill'\n| 'visibleStroke'\n| 'visible'\n| 'painted'\n| 'fill'\n| 'stroke'\n| 'all'\n| 'inherit';\n\n/**\n * When `accessible` is enabled on any display object, these properties will affect its accessibility.\n * @example\n * const container = new Container();\n * container.accessible = true;\n * container.accessibleTitle = 'My Container';\n * container.accessibleHint = 'This is a container';\n * container.tabIndex = 0;\n * @category accessibility\n * @standard\n */\nexport interface AccessibleOptions\n{\n /**\n * Flag for if the object is accessible. If true AccessibilityManager will overlay a\n * shadow div with attributes set\n * @default false\n * @example\n * ```js\n * const container = new Container();\n * container.accessible = true;\n * ```\n */\n accessible: boolean;\n /**\n * Sets the title attribute of the shadow div\n * If accessibleTitle AND accessibleHint has not been this will default to 'container [tabIndex]'\n * @type {string}\n * @default null\n * @example\n * ```js\n * const container = new Container();\n * container.accessible = true;\n * container.accessibleTitle = 'My Container';\n * ```\n */\n accessibleTitle: string | null;\n /**\n * Sets the aria-label attribute of the shadow div\n * @default null\n * @advanced\n * @example\n * ```js\n * const container = new Container();\n * container.accessible = true;\n * container.accessibleHint = 'This is a container';\n * ```\n */\n accessibleHint: string | null;\n /**\n * Sets the tabIndex of the shadow div. You can use this to set the order of the\n * elements when using the tab key to navigate.\n * @default 0\n * @example\n * ```js\n * const container = new Container();\n * container.accessible = true;\n * container.tabIndex = 0;\n *\n * const sprite = new Sprite(texture);\n * sprite.accessible = true;\n * sprite.tabIndex = 1;\n * ```\n */\n tabIndex: number;\n /**\n * Specify the type of div the accessible layer is. Screen readers treat the element differently\n * depending on this type. Defaults to button.\n * @default 'button'\n * @type {string}\n * @advanced\n * @example\n * ```js\n * const container = new Container();\n * container.accessible = true;\n * container.accessibleType = 'button'; // or 'link', 'checkbox', etc.\n * ```\n */\n accessibleType: keyof HTMLElementTagNameMap;\n /**\n * Specify the pointer-events the accessible div will use\n * Defaults to auto.\n * @default 'auto'\n * @type {PointerEvents}\n * @advanced\n * @example\n * ```js\n * const container = new Container();\n * container.accessible = true;\n * container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.\n * ```\n */\n accessiblePointerEvents: PointerEvents;\n\n /**\n * Sets the text content of the shadow\n * @default null\n * @example\n * ```js\n * const container = new Container();\n * container.accessible = true;\n * container.accessibleText = 'This is a container';\n * ```\n */\n accessibleText: string | null;\n\n /**\n * Setting to false will prevent any children inside this container to\n * be accessible. Defaults to true.\n * @default true\n * @example\n * ```js\n * const container = new Container();\n * container.accessible = true;\n * container.accessibleChildren = false; // This will prevent any children from being accessible\n *\n * const sprite = new Sprite(texture);\n * sprite.accessible = true; // This will not work since accessibleChildren is false\n * ```\n */\n accessibleChildren: boolean;\n}\n\n/**\n * The Accessibility object is attached to the {@link Container}.\n * @private\n */\nexport interface AccessibleTarget extends AccessibleOptions\n{\n /** @private */\n _accessibleActive: boolean;\n /** @private */\n _accessibleDiv: AccessibleHTMLElement | null;\n /** @private */\n _renderId: number;\n}\n\n/** @internal */\nexport interface AccessibleHTMLElement extends HTMLElement\n{\n type?: string;\n container?: Container;\n}\n\n/**\n * Default property values of accessible objects\n * used by {@link AccessibilitySystem}.\n * @internal\n * @example\n * import { accessibleTarget } from 'pixi.js';\n *\n * function MyObject() {}\n * Object.assign(MyObject.prototype, accessibleTarget);\n */\nexport const accessibilityTarget: AccessibleTarget = {\n accessible: false,\n accessibleTitle: null,\n accessibleHint: null,\n tabIndex: 0,\n accessibleType: 'button',\n accessibleText: null,\n accessiblePointerEvents: 'auto',\n accessibleChildren: true,\n _accessibleActive: false,\n _accessibleDiv: null,\n _renderId: -1,\n};\n"],"names":[],"mappings":";AA8KO,MAAM,mBAAwC,GAAA;AAAA,EACjD,UAAY,EAAA,KAAA;AAAA,EACZ,eAAiB,EAAA,IAAA;AAAA,EACjB,cAAgB,EAAA,IAAA;AAAA,EAChB,QAAU,EAAA,CAAA;AAAA,EACV,cAAgB,EAAA,QAAA;AAAA,EAChB,cAAgB,EAAA,IAAA;AAAA,EAChB,uBAAyB,EAAA,MAAA;AAAA,EACzB,kBAAoB,EAAA,IAAA;AAAA,EACpB,iBAAmB,EAAA,KAAA;AAAA,EACnB,cAAgB,EAAA,IAAA;AAAA,EAChB,SAAW,EAAA,CAAA,CAAA;AACf;;;;"}