babylonjs-accessibility 7.15.2 → 7.16.1

package/babylon.accessibility.d.ts

@@ -1,28 +1,64 @@
 
 declare module BABYLON.Accessibility {
-    export interface IHTMLTwinItemComponentProps {
-        description: string | undefined;
-        children: React.ReactElement[];
-        a11yItem: HTMLTwinItem;
+
+
+
+
+    /**
+     * The scene tree of the HTML twin. It contain all the top level nodes
+     * @param props
+     * @returns
+     */
+    export function HTMLTwinSceneTree(props: {
+        scene: BABYLON.Scene;
+        options: IHTMLTwinRendererOptions;
+    }): import("react/jsx-runtime").JSX.Element;
+
+
+    /// <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 function HTMLTwinAccessibilityItem(props: IHTMLTwinItemComponentProps): import("react/jsx-runtime").JSX.Element;
+    export var SceneContext: import("react").Context<ISceneContext>;
 
 
     /**
-     * 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.
+     * Options for the HTMLTwinRenderer.
      */
-    export class HTMLTwinGUIItem extends HTMLTwinItem {
+    export interface IHTMLTwinRendererOptions {
         /**
-         * The corresponding BabylonJS entity. Can be a Node or a BABYLON.GUI.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: BABYLON.GUI.Control;
-        constructor(entity: BABYLON.GUI.Control, scene: BABYLON.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: BABYLON.Scene, options?: IHTMLTwinRendererOptions): void;
+    }
+
+
+    /**
+     * 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 BABYLON.Node or a Control.
+         */
+        entity: BABYLON.Node;
+        constructor(entity: BABYLON.Node, scene: BABYLON.Scene);
         /**
          * If this entity is actionable (can be clicked).
          */
@@ -45,21 +81,21 @@ declare module BABYLON.Accessibility {
          * @param eventType - Which event is triggered. E.g. "click", "contextmenu"
          */
         triggerEvent(eventType: string): void;
+        private _getTriggerActions;
     }
 
 
-    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: BABYLON.Scene;
-        options?: IHTMLTwinRendererOptions;
-    }
-    interface IHTMLTwinHostComponentState {
-        a11yTreeItems: HTMLTwinItem[];
-    }
-    export class HTMLTwinHostComponent extends React.Component<IHTMLTwinHostComponentProps, IHTMLTwinHostComponentState> {
-        private _options;
-        constructor(props: IHTMLTwinHostComponentProps);
-        render(): import("react/jsx-runtime").JSX.Element;
-    }
+        options: IHTMLTwinRendererOptions;
+    }): import("react/jsx-runtime").JSX.Element | null;
 
 
     /**
@@ -140,28 +176,35 @@ declare module BABYLON.Accessibility {
     }
 
 
-    /**
-     * 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: BABYLON.Scene;
-        options: IHTMLTwinRendererOptions;
-    }): import("react/jsx-runtime").JSX.Element | null;
+        options?: IHTMLTwinRendererOptions;
+    }
+    interface IHTMLTwinHostComponentState {
+        a11yTreeItems: HTMLTwinItem[];
+    }
+    export class HTMLTwinHostComponent extends React.Component<IHTMLTwinHostComponentProps, IHTMLTwinHostComponentState> {
+        private _options;
+        constructor(props: IHTMLTwinHostComponentProps);
+        render(): import("react/jsx-runtime").JSX.Element;
+    }
 
 
     /**
      * 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 BABYLON.Node or a Control.
+         * The corresponding BabylonJS entity. Can be a Node or a BABYLON.GUI.Control.
          */
-        entity: BABYLON.Node;
-        constructor(entity: BABYLON.Node, scene: BABYLON.Scene);
+        entity: BABYLON.GUI.Control;
+        constructor(entity: BABYLON.GUI.Control, scene: BABYLON.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).
          */
@@ -184,58 +227,15 @@ declare module BABYLON.Accessibility {
          * @param eventType - Which event is triggered. E.g. "click", "contextmenu"
          */
         triggerEvent(eventType: string): void;
-        private _getTriggerActions;
     }
 
 
-    /**
-     * 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: BABYLON.Scene, options?: IHTMLTwinRendererOptions): void;
-    }
-
-
-    /// <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 interface IHTMLTwinItemComponentProps {
+        description: string | undefined;
+        children: React.ReactElement[];
+        a11yItem: HTMLTwinItem;
     }
-    export var SceneContext: import("react").Context<ISceneContext>;
-
-
-    /**
-     * The scene tree of the HTML twin. It contain all the top level nodes
-     * @param props
-     * @returns
-     */
-    export function HTMLTwinSceneTree(props: {
-        scene: BABYLON.Scene;
-        options: IHTMLTwinRendererOptions;
-    }): import("react/jsx-runtime").JSX.Element;
-
-
-
-
+    export function HTMLTwinAccessibilityItem(props: IHTMLTwinItemComponentProps): import("react/jsx-runtime").JSX.Element;