babylonjs-gui-editor 6.39.0 → 6.41.0

package/babylon.guiEditor.d.ts

@@ -451,7 +451,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;
@@ -759,6 +760,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;
 
@@ -1518,6 +1522,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>;
 
@@ -1567,6 +1573,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>;
 
@@ -1593,6 +1601,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>;
 
@@ -1610,6 +1620,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>;
 
@@ -1632,6 +1643,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>;
 
@@ -1678,6 +1691,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>;
 
@@ -1718,6 +1733,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>;
 
@@ -1752,6 +1769,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>;
 
@@ -1887,11 +1906,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;
 
@@ -2122,6 +2145,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>;
 
@@ -2204,6 +2228,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>;
 
@@ -2263,6 +2289,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>;
 
@@ -2371,6 +2399,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;
 
@@ -2680,6 +2710,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;