babylonjs-gui 7.12.0 → 7.13.1

package/babylon.gui.d.ts

@@ -159,6 +159,11 @@ declare module BABYLON.GUI {
          * Gets or sets a boolean indicating that the canvas must be reverted on Y when updating the texture
          */
         applyYInversionOnUpdate: boolean;
+        /**
+         * A boolean indicating whether or not the elements can be navigated to using the tab key.
+         * Defaults to false.
+         */
+        disableTabNavigation: boolean;
         /**
          * Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger).
          * Useful when you want more antialiasing
@@ -236,8 +241,8 @@ declare module BABYLON.GUI {
         /**
          * Gets or sets the current focused control
          */
-        get focusedControl(): BABYLON.Nullable<IFocusableControl>;
-        set focusedControl(control: BABYLON.Nullable<IFocusableControl>);
+        get focusedControl(): BABYLON.Nullable<Control>;
+        set focusedControl(control: BABYLON.Nullable<Control>);
         /**
          * Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode
          */
@@ -382,6 +387,7 @@ declare module BABYLON.GUI {
         private _translateToPicking;
         /** Attach to all scene events required to support pointer events */
         attach(): void;
+        private _focusNextElement;
         /**
          * @internal
          */
@@ -418,7 +424,7 @@ declare module BABYLON.GUI {
          * Move the focus to a specific control
          * @param control defines the control which will receive the focus
          */
-        moveFocusToControl(control: IFocusableControl): void;
+        moveFocusToControl(control: Control): void;
         private _manageFocus;
         private _attachPickingToSceneRender;
         private _attachToOnPointerOut;
@@ -971,7 +977,7 @@ declare module BABYLON.GUI {
      * Root class used for all 2D controls
      * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#controls
      */
-    export class Control implements BABYLON.IAnimatable {
+    export class Control implements BABYLON.IAnimatable, IFocusableControl {
         /** defines the name of the control */
         name?: string | undefined;
         /**
@@ -1193,6 +1199,10 @@ declare module BABYLON.GUI {
          * An event triggered when a control is clicked on
          */
         onPointerClickObservable: BABYLON.Observable<Vector2WithInfo>;
+        /**
+         * An event triggered when a control receives an ENTER key down event
+         */
+        onEnterPressedObservable: BABYLON.Observable<Control>;
         /**
          * An event triggered when pointer enters the control
          */
@@ -1513,6 +1523,52 @@ declare module BABYLON.GUI {
          * Array of animations
          */
         animations: BABYLON.Nullable<BABYLON.Animation[]>;
+        protected _focusedColor: BABYLON.Nullable<string>;
+        /**
+         * Border color when control is focused
+         * When not defined the ADT color will be used. If no ADT color is defined, focused state won't have any border
+         */
+        get focusedColor(): BABYLON.Nullable<string>;
+        set focusedColor(value: BABYLON.Nullable<string>);
+        /**
+         * The tab index of this control. -1 indicates this control is not part of the tab navigation.
+         * A positive value indicates the order of the control in the tab navigation.
+         * A value of 0 indicated the control will be focused after all controls with a positive index.
+         * More than one control can have the same tab index and the navigation would then go through all controls with the same value in an order defined by the layout or the hierarchy.
+         * The value can be changed at any time.
+         * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex
+         */
+        tabIndex: number;
+        protected _isFocused: boolean;
+        protected _unfocusedColor: BABYLON.Nullable<string>;
+        /** BABYLON.Observable raised when the control gets the focus */
+        onFocusObservable: BABYLON.Observable<Control>;
+        /** BABYLON.Observable raised when the control loses the focus */
+        onBlurObservable: BABYLON.Observable<Control>;
+        /** BABYLON.Observable raised when a key event was processed */
+        onKeyboardEventProcessedObservable: BABYLON.Observable<BABYLON.IKeyboardEvent>;
+        /** @internal */
+        onBlur(): void;
+        /** @internal */
+        onFocus(): void;
+        /**
+         * Function called to get the list of controls that should not steal the focus from this control
+         * @returns an array of controls
+         */
+        keepsFocusWith(): BABYLON.Nullable<Control[]>;
+        /**
+         * Function to focus a button programmatically
+         */
+        focus(): void;
+        /**
+         * Function to unfocus a button programmatically
+         */
+        blur(): void;
+        /**
+         * Handles the keyboard event
+         * @param evt Defines the KeyboardEvent
+         */
+        processKeyboard(evt: BABYLON.IKeyboardEvent): void;
         /**
          * Creates a new control
          * @param name defines the name of the control
@@ -1924,45 +1980,11 @@ declare module BABYLON.GUI {
      */
     export class FocusableButton extends Button implements IFocusableControl {
         name?: string | undefined;
-        /** Highlight color when button is focused */
-        focusedColor: BABYLON.Nullable<string>;
-        private _isFocused;
-        private _unfocusedColor;
-        /** BABYLON.Observable raised when the control gets the focus */
-        onFocusObservable: BABYLON.Observable<Button>;
-        /** BABYLON.Observable raised when the control loses the focus */
-        onBlurObservable: BABYLON.Observable<Button>;
-        /** BABYLON.Observable raised when a key event was processed */
-        onKeyboardEventProcessedObservable: BABYLON.Observable<BABYLON.IKeyboardEvent>;
         constructor(name?: string | undefined);
-        /** @internal */
-        onBlur(): void;
-        /** @internal */
-        onFocus(): void;
-        /**
-         * Function called to get the list of controls that should not steal the focus from this control
-         * @returns an array of controls
-         */
-        keepsFocusWith(): BABYLON.Nullable<Control[]>;
-        /**
-         * Function to focus a button programmatically
-         */
-        focus(): void;
-        /**
-         * Function to unfocus a button programmatically
-         */
-        blur(): void;
-        /**
-         * Handles the keyboard event
-         * @param evt Defines the KeyboardEvent
-         */
-        processKeyboard(evt: BABYLON.IKeyboardEvent): void;
         /**
          * @internal
          */
         _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
-        /** @internal */
-        dispose(): void;
     }
 
 
@@ -1996,6 +2018,15 @@ declare module BABYLON.GUI {
          * Function to unfocus the control programmatically
          */
         blur(): void;
+        /**
+         * Gets or sets the tabIndex of the control
+         */
+        tabIndex?: number;
+        /**
+         * Gets or sets the color used to draw the focus border
+         * Defaults to "white"
+         */
+        focusBorderColor?: string;
     }
 
 
@@ -2550,19 +2581,17 @@ declare module BABYLON.GUI {
     /**
      * Class used to create input text control
      */
-    export class InputText extends Control implements IFocusableControl {
+    export class InputText extends Control {
         name?: string | undefined;
         protected _textWrapper: TextWrapper;
         protected _placeholderText: string;
         protected _background: string;
         protected _focusedBackground: string;
-        protected _focusedColor: string;
         protected _placeholderColor: string;
         protected _thickness: number;
         protected _margin: ValueAndUnit;
         protected _autoStretchWidth: boolean;
         protected _maxWidth: ValueAndUnit;
-        protected _isFocused: boolean;
         /** the type of device that most recently focused the input: "mouse", "touch" or "pen" */
         protected _focusedBy: string;
         protected _blinkTimeout: number;
@@ -2607,10 +2636,6 @@ declare module BABYLON.GUI {
         onTextChangedObservable: BABYLON.Observable<InputText>;
         /** BABYLON.Observable raised just before an entered character is to be added */
         onBeforeKeyAddObservable: BABYLON.Observable<InputText>;
-        /** BABYLON.Observable raised when the control gets the focus */
-        onFocusObservable: BABYLON.Observable<InputText>;
-        /** BABYLON.Observable raised when the control loses the focus */
-        onBlurObservable: BABYLON.Observable<InputText>;
         /** BABYLON.Observable raised when the text is highlighted */
         onTextHighlightObservable: BABYLON.Observable<InputText>;
         /** BABYLON.Observable raised when copy event is triggered */
@@ -2619,8 +2644,6 @@ declare module BABYLON.GUI {
         onTextCutObservable: BABYLON.Observable<InputText>;
         /** BABYLON.Observable raised when paste event is triggered */
         onTextPasteObservable: BABYLON.Observable<InputText>;
-        /** BABYLON.Observable raised when a key event was processed */
-        onKeyboardEventProcessedObservable: BABYLON.Observable<BABYLON.IKeyboardEvent>;
         /** Gets or sets the maximum width allowed by the control */
         get maxWidth(): string | number;
         /** Gets the maximum width allowed by the control in pixels */
@@ -2650,7 +2673,6 @@ declare module BABYLON.GUI {
         get focusedBackground(): string;
         set focusedBackground(value: string);
         /** Gets or sets the background color when focused */
-        get focusedColor(): string;
         set focusedColor(value: string);
         /** Gets or sets the background color */
         get background(): string;
@@ -2691,14 +2713,6 @@ declare module BABYLON.GUI {
         onBlur(): void;
         /** @internal */
         onFocus(): void;
-        /**
-         * Function to focus an inputText programmatically
-         */
-        focus(): void;
-        /**
-         * Function to unfocus an inputText programmatically
-         */
-        blur(): void;
         protected _getTypeName(): string;
         /**
          * Function called to get the list of controls that should not steal the focus from this control