babylonjs-accessibility 6.4.0 → 6.5.0

package/babylon.accessibility.module.d.ts

@@ -49,14 +49,17 @@ declare module "babylonjs-accessibility/HtmlTwin/htmlTwinHostComponent" {
 import * as React from "react";
 import { HTMLTwinItem } from "babylonjs-accessibility/HtmlTwin/htmlTwinItem";
 import { Scene } from "babylonjs/scene";
+import { IHTMLTwinRendererOptions } from "babylonjs-accessibility/HtmlTwin/htmlTwinRenderer";
 interface IHTMLTwinHostComponentProps {
     scene: Scene;
+    options?: IHTMLTwinRendererOptions;
 }
 interface IHTMLTwinHostComponentState {
     a11yTreeItems: HTMLTwinItem[];
 }
 export class HTMLTwinHostComponent extends React.Component<IHTMLTwinHostComponentProps, IHTMLTwinHostComponentState> {
     private _observersMap;
+    private _options;
     constructor(props: IHTMLTwinHostComponentProps);
     componentDidUpdate(prevProps: Readonly<IHTMLTwinHostComponentProps>, prevState: Readonly<IHTMLTwinHostComponentState>, snapshot?: any): void;
     /**
@@ -178,8 +181,28 @@ export class HTMLTwinNodeItem extends HTMLTwinItem {
 }
 declare module "babylonjs-accessibility/HtmlTwin/htmlTwinRenderer" {
 import { Scene } from "babylonjs/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 {
-    static Render(scene: Scene): void;
+    /**
+     * 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;
 }
 
 }
@@ -263,12 +286,14 @@ declare module BABYLON.Accessibility {
 
     interface IHTMLTwinHostComponentProps {
         scene: BABYLON.Scene;
+        options?: IHTMLTwinRendererOptions;
     }
     interface IHTMLTwinHostComponentState {
         a11yTreeItems: HTMLTwinItem[];
     }
     export class HTMLTwinHostComponent extends React.Component<IHTMLTwinHostComponentProps, IHTMLTwinHostComponentState> {
         private _observersMap;
+        private _options;
         constructor(props: IHTMLTwinHostComponentProps);
         componentDidUpdate(prevProps: Readonly<IHTMLTwinHostComponentProps>, prevState: Readonly<IHTMLTwinHostComponentState>, snapshot?: any): void;
         /**
@@ -379,8 +404,28 @@ declare module BABYLON.Accessibility {
     }
 
 
+    /**
+     * 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 {
-        static Render(scene: BABYLON.Scene): void;
+        /**
+         * 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;
     }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-accessibility",
-    "version": "6.4.0",
+    "version": "6.5.0",
     "main": "babylon.accessibility.max.js",
     "types": "babylon.accessibility.module.d.ts",
     "files": [
@@ -14,8 +14,8 @@
         "clean": "rimraf dist && rimraf babylon*.*"
     },
     "dependencies": {
-        "babylonjs": "^6.4.0",
-        "babylonjs-gui": "^6.4.0"
+        "babylonjs": "^6.5.0",
+        "babylonjs-gui": "^6.5.0"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",