@babylonjs/accessibility 7.16.0 → 7.17.0

package/dist/babylon.accessibility.module.d.ts

@@ -1,35 +1,81 @@
 
-declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinAccessibilityItem" {
-import { ReactElement } from "react";
-import { HTMLTwinItem } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
-export interface IHTMLTwinItemComponentProps {
-    description: string | undefined;
-    children: ReactElement[];
-    a11yItem: HTMLTwinItem;
+declare module "@babylonjs/accessibility/index" {
+export * from "@babylonjs/accessibility/HtmlTwin/index";
+
 }
+declare module "@babylonjs/accessibility/legacy/legacy" {
+export * from "@babylonjs/accessibility/index";
 
+}
+declare module "@babylonjs/accessibility/HtmlTwin/index" {
+export * from "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer";
 
 }
-declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinGUIItem" {
+declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinSceneTree" {
 import { Scene } from "@babylonjs/core/scene";
-import { Control } from "@babylonjs/gui/2D/controls/control";
-import { HTMLTwinItem } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
 import { IHTMLTwinRendererOptions } from "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer";
 /**
- * A abstract layer to store the html twin tree structure. It is constructed from the BabylonJS scene entities that need to be accessible. It informs the parent-children relationship of html twin tree, and informs how to render: description, isActionable, onclick/onrightclick/onfocus/onblur.
+ * The scene tree of the HTML twin. It contain all the top level nodes
+ * @param props
+ * @returns
  */
-export class HTMLTwinGUIItem extends HTMLTwinItem {
+export function HTMLTwinSceneTree(props: {
+    scene: Scene;
+    options: IHTMLTwinRendererOptions;
+
+
+}
+declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinSceneContext" {
+/// <reference types="react" />
+/**
+ * Context used to update a scene when an entity is added or removed from the accessibility tree.
+ */
+export interface ISceneContext {
+    updateScene: () => void;
+}
+export const SceneContext: import("react").Context<ISceneContext>;
+
+}
+declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer" {
+import { Scene } from "@babylonjs/core/scene";
+/**
+ * Options for the HTMLTwinRenderer.
+ */
+export interface IHTMLTwinRendererOptions {
     /**
-     * The corresponding BabylonJS entity. Can be a Node or a Control.
+     * If this is true, all GUI controls will be added to the twin tree, regardless if they have
+     * a defined accessibility tag or not. If it's false, only controls with an accessibility tag
+     * will be added. True by default.
      */
-    entity: Control;
-    constructor(entity: Control, scene: Scene);
+    addAllControls: boolean;
+}
+/**
+ * This class is the main entry point for the HTML twin renderer. To render a twin for a scene,
+ * simply call HTMLTwinRenderer.Render(scene).
+ */
+export class HTMLTwinRenderer {
     /**
-     * The text content displayed in HTML element.
-     * @param options - Options to render HTML twin tree where this element is contained.
-     * @returns The text content displayed in HTML element.
+     * Render the HTML twin for the given scene.
+     * @param scene the scene to render the twin for
+     * @param options options for the renderer
      */
-    getDescription(options: IHTMLTwinRendererOptions): string;
+    static Render(scene: Scene, options?: IHTMLTwinRendererOptions): void;
+}
+
+}
+declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinNodeItem" {
+import { Node } from "@babylonjs/core/node";
+import { Scene } from "@babylonjs/core/scene";
+import { HTMLTwinItem } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
+/**
+ * A abstract layer to store the html twin tree structure. It is constructed from the BabylonJS scene entities that need to be accessible. It informs the parent-children relationship of html twin tree, and informs how to render: description, isActionable, onclick/onrightclick/onfocus/onblur.
+ */
+export class HTMLTwinNodeItem extends HTMLTwinItem {
+    /**
+     * The corresponding BabylonJS entity. Can be a Node or a Control.
+     */
+    entity: Node;
+    constructor(entity: Node, scene: Scene);
     /**
      * If this entity is actionable (can be clicked).
      */
@@ -52,27 +98,25 @@ export class HTMLTwinGUIItem extends HTMLTwinItem {
      * @param eventType - Which event is triggered. E.g. "click", "contextmenu"
      */
     triggerEvent(eventType: string): void;
+    private _getTriggerActions;
 }
 
 }
-declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinHostComponent" {
-import * as React from "react";
-import { HTMLTwinItem } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
+declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinItemAdapter" {
+import { AccessibilityEntity } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
 import { Scene } from "@babylonjs/core/scene";
 import { IHTMLTwinRendererOptions } from "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer";
-interface IHTMLTwinHostComponentProps {
+/**
+ * An adapter that transforms a Accessible entity in a React element. Contains observables for the events that can
+ * change the state of the entity or the accesible tree.
+ * @param props the props of the adapter
+ * @returns
+ */
+export function HTMLTwinItemAdapter(props: {
+    node: AccessibilityEntity;
     scene: Scene;
-    options?: IHTMLTwinRendererOptions;
-}
-interface IHTMLTwinHostComponentState {
-    a11yTreeItems: HTMLTwinItem[];
-}
-export class HTMLTwinHostComponent extends React.Component<IHTMLTwinHostComponentProps, IHTMLTwinHostComponentState> {
-    private _options;
-    constructor(props: IHTMLTwinHostComponentProps);
+    options: IHTMLTwinRendererOptions;
 
-}
-export {};
 
 }
 declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinItem" {
@@ -159,36 +203,46 @@ export class HTMLTwinItem {
 }
 
 }
-declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinItemAdapter" {
-import { AccessibilityEntity } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
+declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinHostComponent" {
+import * as React from "react";
+import { HTMLTwinItem } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
 import { Scene } from "@babylonjs/core/scene";
 import { IHTMLTwinRendererOptions } from "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer";
-/**
- * An adapter that transforms a Accessible entity in a React element. Contains observables for the events that can
- * change the state of the entity or the accesible tree.
- * @param props the props of the adapter
- * @returns
- */
-export function HTMLTwinItemAdapter(props: {
-    node: AccessibilityEntity;
+interface IHTMLTwinHostComponentProps {
     scene: Scene;
-    options: IHTMLTwinRendererOptions;
+    options?: IHTMLTwinRendererOptions;
+}
+interface IHTMLTwinHostComponentState {
+    a11yTreeItems: HTMLTwinItem[];
+}
+export class HTMLTwinHostComponent extends React.Component<IHTMLTwinHostComponentProps, IHTMLTwinHostComponentState> {
+    private _options;
+    constructor(props: IHTMLTwinHostComponentProps);
 
+}
+export {};
 
 }
-declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinNodeItem" {
-import { Node } from "@babylonjs/core/node";
+declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinGUIItem" {
 import { Scene } from "@babylonjs/core/scene";
+import { Control } from "@babylonjs/gui/2D/controls/control";
 import { HTMLTwinItem } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
+import { IHTMLTwinRendererOptions } from "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer";
 /**
  * A abstract layer to store the html twin tree structure. It is constructed from the BabylonJS scene entities that need to be accessible. It informs the parent-children relationship of html twin tree, and informs how to render: description, isActionable, onclick/onrightclick/onfocus/onblur.
  */
-export class HTMLTwinNodeItem extends HTMLTwinItem {
+export class HTMLTwinGUIItem extends HTMLTwinItem {
     /**
      * The corresponding BabylonJS entity. Can be a Node or a Control.
      */
-    entity: Node;
-    constructor(entity: Node, scene: Scene);
+    entity: Control;
+    constructor(entity: Control, scene: Scene);
+    /**
+     * The text content displayed in HTML element.
+     * @param options - Options to render HTML twin tree where this element is contained.
+     * @returns The text content displayed in HTML element.
+     */
+    getDescription(options: IHTMLTwinRendererOptions): string;
     /**
      * If this entity is actionable (can be clicked).
      */
@@ -211,72 +265,18 @@ export class HTMLTwinNodeItem extends HTMLTwinItem {
      * @param eventType - Which event is triggered. E.g. "click", "contextmenu"
      */
     triggerEvent(eventType: string): void;
-    private _getTriggerActions;
-}
-
-}
-declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer" {
-import { Scene } from "@babylonjs/core/scene";
-/**
- * Options for the HTMLTwinRenderer.
- */
-export interface IHTMLTwinRendererOptions {
-    /**
-     * If this is true, all GUI controls will be added to the twin tree, regardless if they have
-     * a defined accessibility tag or not. If it's false, only controls with an accessibility tag
-     * will be added. True by default.
-     */
-    addAllControls: boolean;
-}
-/**
- * This class is the main entry point for the HTML twin renderer. To render a twin for a scene,
- * simply call HTMLTwinRenderer.Render(scene).
- */
-export class HTMLTwinRenderer {
-    /**
-     * Render the HTML twin for the given scene.
-     * @param scene the scene to render the twin for
-     * @param options options for the renderer
-     */
-    static Render(scene: Scene, options?: IHTMLTwinRendererOptions): void;
-}
-
-}
-declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinSceneContext" {
-/// <reference types="react" />
-/**
- * Context used to update a scene when an entity is added or removed from the accessibility tree.
- */
-export interface ISceneContext {
-    updateScene: () => void;
 }
-export const SceneContext: import("react").Context<ISceneContext>;
 
 }
-declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinSceneTree" {
-import { Scene } from "@babylonjs/core/scene";
-import { IHTMLTwinRendererOptions } from "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer";
-/**
- * The scene tree of the HTML twin. It contain all the top level nodes
- * @param props
- * @returns
- */
-export function HTMLTwinSceneTree(props: {
-    scene: Scene;
-    options: IHTMLTwinRendererOptions;
-
-
-}
-declare module "@babylonjs/accessibility/HtmlTwin/index" {
-export * from "@babylonjs/accessibility/HtmlTwin/htmlTwinRenderer";
-
+declare module "@babylonjs/accessibility/HtmlTwin/htmlTwinAccessibilityItem" {
+import { ReactElement } from "react";
+import { HTMLTwinItem } from "@babylonjs/accessibility/HtmlTwin/htmlTwinItem";
+export interface IHTMLTwinItemComponentProps {
+    description: string | undefined;
+    children: ReactElement[];
+    a11yItem: HTMLTwinItem;
 }
-declare module "@babylonjs/accessibility/index" {
-export * from "@babylonjs/accessibility/HtmlTwin/index";
 
-}
-declare module "@babylonjs/accessibility/legacy/legacy" {
-export * from "@babylonjs/accessibility/index";
 
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@babylonjs/accessibility",
-    "version": "7.16.0",
+    "version": "7.17.0",
     "main": "dist/babylon.accessibility.max.js",
     "module": "dist/babylon.accessibility.max.js",
     "esnext": "dist/babylon.accessibility.max.js",
@@ -24,8 +24,8 @@
         "@types/react-dom": ">=16.0.9"
     },
     "devDependencies": {
-        "@babylonjs/core": "^7.16.0",
-        "@babylonjs/gui": "^7.16.0",
+        "@babylonjs/core": "^7.17.0",
+        "@babylonjs/gui": "^7.17.0",
         "react": "^17.0.2",
         "react-dom": "^17.0.2"
     },