babylonjs-gui-editor 6.38.1 → 6.40.0

package/babylon.guiEditor.module.d.ts

@@ -644,7 +644,8 @@ export class PropertyTabComponent extends React.Component<IPropertyTabComponentP
     renderNode(nodes: Control[]): JSX.Element;
     /**
      * returns the class name of a list of controls if they share a class, or an empty string if not
-     * @param nodes
+     * @param nodes the list of controls to check
+     * @returns the class name of a list of controls if they share a class, or an empty string if not
      */
     getControlsCommonClassName(nodes: Control[]): string;
     renderProperties(nodes: Control[]): JSX.Element | undefined;
@@ -1010,6 +1011,9 @@ interface IGizmoLineProps {
 }
 /**
  * This class represents the gizmo drawn on a line Control.
+ * It is used to scale and rotate the control around a pivot point
+ * @param props the properties of the gizmo
+ * @returns a gizmo line
  */
 export function GizmoLine(props: IGizmoLineProps): JSX.Element;
 export {};
@@ -1799,6 +1803,8 @@ export interface IDraggableIconProps {
 }
 /**
  * An icon that can be dragged by the user
+ * @param props properties
+ * @returns draggable icon element
  */
 export const DraggableIcon: FC<IDraggableIconProps>;
 
@@ -1840,6 +1846,8 @@ export interface IFlexibleDragHandlerProps {
 }
 /**
  * This component receives the drop events and updates the layout accordingly
+ * @param props properties
+ * @returns DragHandler element
  */
 export const FlexibleDragHandler: FC<IFlexibleDragHandlerProps>;
 
@@ -1862,6 +1870,8 @@ export interface IFlexibleDropZoneProps {
 /**
  * This component contains the drag and drop zone for the resize bars that
  * allow redefining width and height of layout elements
+ * @param props properties
+ * @returns drop zone element
  */
 export const FlexibleDropZone: FC<IFlexibleDropZoneProps>;
 
@@ -1875,6 +1885,7 @@ export interface IFlexibleGridContainerProps {
 }
 /**
  * Component responsible for mapping the layout to the actual components
+ * @returns GridContainer element
  */
 export const FlexibleGridContainer: FC<IFlexibleGridContainerProps>;
 
@@ -1894,6 +1905,8 @@ export interface IFlexibleGridLayoutProps {
 /**
  * This component represents a grid layout that can be resized and rearranged
  * by the user.
+ * @param props properties
+ * @returns layout element
  */
 export const FlexibleGridLayout: FC<IFlexibleGridLayoutProps>;
 
@@ -1937,6 +1950,8 @@ export type ResizeItem = {
 };
 /**
  * A component that renders a bar that the user can drag to resize.
+ * @param props properties
+ * @returns resize bar element
  */
 export const FlexibleResizeBar: FC<IFlexibleRowResizerProps>;
 
@@ -1974,6 +1989,8 @@ export interface IFlexibleTabProps {
  * to activate or drag to reorder. It also listens for
  * drop events if the user wants to drop another tab
  * after it.
+ * @param props properties
+ * @returns FlexibleTab element
  */
 export const FlexibleTab: FC<IFlexibleTabProps>;
 
@@ -2005,6 +2022,8 @@ export interface IFlexibleTabsContainerProps {
 /**
  * This component contains a set of tabs of which only one is visible at a time.
  * The tabs can also be dragged from and to different containers.
+ * @param props properties
+ * @returns tabs container element
  */
 export const FlexibleTabsContainer: FC<IFlexibleTabsContainerProps>;
 
@@ -2128,11 +2147,15 @@ export const getPosInLayout: (layout: Layout, column: number, row?: number) => L
 export const removeLayoutRowAndRedistributePercentages: (layout: Layout, column: number, row: number) => void;
 /**
  * Add a percentage string to a number
+ * @param p1 the percentage string
+ * @param p2 the number
+ * @returns the sum of the percentage string and the number
  */
 export const addPercentageStringToNumber: (p1: string, p2: number) => number;
 /**
  * Parses a percentage string into a number
  * @param p the percentage string
+ * @returns the parsed number
  */
 export const parsePercentage: (p: string) => number;
 
@@ -2344,6 +2367,7 @@ export interface IGraphConnectorHandlerProps {
 /**
  * This component is used to initiate a connection between two nodes. Simply
  * drag the handle in a node and drop it in another node to create a connection.
+ * @returns connector element
  */
 export const GraphConnectorHandler: FC<IGraphConnectorHandlerProps>;
 
@@ -2413,6 +2437,8 @@ export const MarkerArrowId = "arrow";
 /**
  * This component draws a SVG line between two points, with an optional marker
  * indicating direction
+ * @param props properties
+ * @returns graph line element
  */
 export const GraphLine: FC<IGraphLineProps>;
 
@@ -2460,6 +2486,8 @@ export interface IGraphContainerProps {
 }
 /**
  * This component contains all the nodes and handles their dragging
+ * @param props properties
+ * @returns graph node container element
  */
 export const GraphNodesContainer: FC<IGraphContainerProps>;
 
@@ -2555,6 +2583,8 @@ export interface ITextInputProps {
 }
 /**
  * This component represents a text input that can be submitted or cancelled on buttons
+ * @param props properties
+ * @returns TextInputWithSubmit element
  */
 export const TextInputWithSubmit: (props: ITextInputProps) => JSX.Element;
 
@@ -2837,6 +2867,7 @@ interface IFloatLineComponentProps {
     unit?: React.ReactNode;
     onDragStart?: (newValue: number) => void;
     onDragStop?: (newValue: number) => void;
+    disabled?: boolean;
 }
 export class FloatLineComponent extends React.Component<IFloatLineComponentProps, {
     value: string;
@@ -5149,7 +5180,8 @@ declare module BABYLON {
         renderNode(nodes: BABYLON.GUI.Control[]): JSX.Element;
         /**
          * returns the class name of a list of controls if they share a class, or an empty string if not
-         * @param nodes
+         * @param nodes the list of controls to check
+         * @returns the class name of a list of controls if they share a class, or an empty string if not
          */
         getControlsCommonClassName(nodes: BABYLON.GUI.Control[]): string;
         renderProperties(nodes: BABYLON.GUI.Control[]): JSX.Element | undefined;
@@ -5457,6 +5489,9 @@ declare module BABYLON {
     }
     /**
      * This class represents the gizmo drawn on a line Control.
+     * It is used to scale and rotate the control around a pivot point
+     * @param props the properties of the gizmo
+     * @returns a gizmo line
      */
     export function GizmoLine(props: IGizmoLineProps): JSX.Element;
 
@@ -6216,6 +6251,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     }
     /**
      * An icon that can be dragged by the user
+     * @param props properties
+     * @returns draggable icon element
      */
     export var DraggableIcon: React.FC<IDraggableIconProps>;
 
@@ -6265,6 +6302,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     }
     /**
      * This component receives the drop events and updates the layout accordingly
+     * @param props properties
+     * @returns DragHandler element
      */
     export var FlexibleDragHandler: React.FC<IFlexibleDragHandlerProps>;
 
@@ -6291,6 +6330,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     /**
      * This component contains the drag and drop zone for the resize bars that
      * allow redefining width and height of layout elements
+     * @param props properties
+     * @returns drop zone element
      */
     export var FlexibleDropZone: React.FC<IFlexibleDropZoneProps>;
 
@@ -6308,6 +6349,7 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     }
     /**
      * Component responsible for mapping the layout to the actual components
+     * @returns GridContainer element
      */
     export var FlexibleGridContainer: React.FC<IFlexibleGridContainerProps>;
 
@@ -6330,6 +6372,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     /**
      * This component represents a grid layout that can be resized and rearranged
      * by the user.
+     * @param props properties
+     * @returns layout element
      */
     export var FlexibleGridLayout: React.FC<IFlexibleGridLayoutProps>;
 
@@ -6376,6 +6420,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     };
     /**
      * A component that renders a bar that the user can drag to resize.
+     * @param props properties
+     * @returns resize bar element
      */
     export var FlexibleResizeBar: React.FC<IFlexibleRowResizerProps>;
 
@@ -6416,6 +6462,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
      * to activate or drag to reorder. It also listens for
      * drop events if the user wants to drop another tab
      * after it.
+     * @param props properties
+     * @returns FlexibleTab element
      */
     export var FlexibleTab: React.FC<IFlexibleTabProps>;
 
@@ -6450,6 +6498,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     /**
      * This component contains a set of tabs of which only one is visible at a time.
      * The tabs can also be dragged from and to different containers.
+     * @param props properties
+     * @returns tabs container element
      */
     export var FlexibleTabsContainer: React.FC<IFlexibleTabsContainerProps>;
 
@@ -6585,11 +6635,15 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     export const removeLayoutRowAndRedistributePercentages: (layout: BABYLON.GuiEditor.SharedUIComponents.Layout, column: number, row: number) => void;
     /**
      * Add a percentage string to a number
+     * @param p1 the percentage string
+     * @param p2 the number
+     * @returns the sum of the percentage string and the number
      */
     export const addPercentageStringToNumber: (p1: string, p2: number) => number;
     /**
      * Parses a percentage string into a number
      * @param p the percentage string
+     * @returns the parsed number
      */
     export const parsePercentage: (p: string) => number;
 
@@ -6820,6 +6874,7 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     /**
      * This component is used to initiate a connection between two nodes. Simply
      * drag the handle in a node and drop it in another node to create a connection.
+     * @returns connector element
      */
     export var GraphConnectorHandler: React.FC<IGraphConnectorHandlerProps>;
 
@@ -6902,6 +6957,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     /**
      * This component draws a SVG line between two points, with an optional marker
      * indicating direction
+     * @param props properties
+     * @returns graph line element
      */
     export var GraphLine: React.FC<IGraphLineProps>;
 
@@ -6961,6 +7018,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     }
     /**
      * This component contains all the nodes and handles their dragging
+     * @param props properties
+     * @returns graph node container element
      */
     export var GraphNodesContainer: React.FC<IGraphContainerProps>;
 
@@ -7069,6 +7128,8 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
     }
     /**
      * This component represents a text input that can be submitted or cancelled on buttons
+     * @param props properties
+     * @returns TextInputWithSubmit element
      */
     export const TextInputWithSubmit: (props: ITextInputProps) => JSX.Element;
 
@@ -7378,6 +7439,7 @@ declare module BABYLON.GuiEditor.SharedUIComponents {
         unit?: React.ReactNode;
         onDragStart?: (newValue: number) => void;
         onDragStop?: (newValue: number) => void;
+        disabled?: boolean;
     }
     export class FloatLineComponent extends React.Component<IFloatLineComponentProps, {
         value: string;

package/package.json

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