@babylonjs/gui-editor 6.39.0 → 6.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -644,7 +644,8 @@ export class PropertyTabComponent extends React.Component<IPropertyTabComponentP
644
644
  renderNode(nodes: Control[]): JSX.Element;
645
645
  /**
646
646
  * returns the class name of a list of controls if they share a class, or an empty string if not
647
- * @param nodes
647
+ * @param nodes the list of controls to check
648
+ * @returns the class name of a list of controls if they share a class, or an empty string if not
648
649
  */
649
650
  getControlsCommonClassName(nodes: Control[]): string;
650
651
  renderProperties(nodes: Control[]): JSX.Element | undefined;
@@ -1010,6 +1011,9 @@ interface IGizmoLineProps {
1010
1011
  }
1011
1012
  /**
1012
1013
  * This class represents the gizmo drawn on a line Control.
1014
+ * It is used to scale and rotate the control around a pivot point
1015
+ * @param props the properties of the gizmo
1016
+ * @returns a gizmo line
1013
1017
  */
1014
1018
  export function GizmoLine(props: IGizmoLineProps): JSX.Element;
1015
1019
  export {};
@@ -1799,6 +1803,8 @@ export interface IDraggableIconProps {
1799
1803
  }
1800
1804
  /**
1801
1805
  * An icon that can be dragged by the user
1806
+ * @param props properties
1807
+ * @returns draggable icon element
1802
1808
  */
1803
1809
  export const DraggableIcon: FC<IDraggableIconProps>;
1804
1810
 
@@ -1840,6 +1846,8 @@ export interface IFlexibleDragHandlerProps {
1840
1846
  }
1841
1847
  /**
1842
1848
  * This component receives the drop events and updates the layout accordingly
1849
+ * @param props properties
1850
+ * @returns DragHandler element
1843
1851
  */
1844
1852
  export const FlexibleDragHandler: FC<IFlexibleDragHandlerProps>;
1845
1853
 
@@ -1862,6 +1870,8 @@ export interface IFlexibleDropZoneProps {
1862
1870
  /**
1863
1871
  * This component contains the drag and drop zone for the resize bars that
1864
1872
  * allow redefining width and height of layout elements
1873
+ * @param props properties
1874
+ * @returns drop zone element
1865
1875
  */
1866
1876
  export const FlexibleDropZone: FC<IFlexibleDropZoneProps>;
1867
1877
 
@@ -1875,6 +1885,7 @@ export interface IFlexibleGridContainerProps {
1875
1885
  }
1876
1886
  /**
1877
1887
  * Component responsible for mapping the layout to the actual components
1888
+ * @returns GridContainer element
1878
1889
  */
1879
1890
  export const FlexibleGridContainer: FC<IFlexibleGridContainerProps>;
1880
1891
 
@@ -1894,6 +1905,8 @@ export interface IFlexibleGridLayoutProps {
1894
1905
  /**
1895
1906
  * This component represents a grid layout that can be resized and rearranged
1896
1907
  * by the user.
1908
+ * @param props properties
1909
+ * @returns layout element
1897
1910
  */
1898
1911
  export const FlexibleGridLayout: FC<IFlexibleGridLayoutProps>;
1899
1912
 
@@ -1937,6 +1950,8 @@ export type ResizeItem = {
1937
1950
  };
1938
1951
  /**
1939
1952
  * A component that renders a bar that the user can drag to resize.
1953
+ * @param props properties
1954
+ * @returns resize bar element
1940
1955
  */
1941
1956
  export const FlexibleResizeBar: FC<IFlexibleRowResizerProps>;
1942
1957
 
@@ -1974,6 +1989,8 @@ export interface IFlexibleTabProps {
1974
1989
  * to activate or drag to reorder. It also listens for
1975
1990
  * drop events if the user wants to drop another tab
1976
1991
  * after it.
1992
+ * @param props properties
1993
+ * @returns FlexibleTab element
1977
1994
  */
1978
1995
  export const FlexibleTab: FC<IFlexibleTabProps>;
1979
1996
 
@@ -2005,6 +2022,8 @@ export interface IFlexibleTabsContainerProps {
2005
2022
  /**
2006
2023
  * This component contains a set of tabs of which only one is visible at a time.
2007
2024
  * The tabs can also be dragged from and to different containers.
2025
+ * @param props properties
2026
+ * @returns tabs container element
2008
2027
  */
2009
2028
  export const FlexibleTabsContainer: FC<IFlexibleTabsContainerProps>;
2010
2029
 
@@ -2128,11 +2147,15 @@ export const getPosInLayout: (layout: Layout, column: number, row?: number) => L
2128
2147
  export const removeLayoutRowAndRedistributePercentages: (layout: Layout, column: number, row: number) => void;
2129
2148
  /**
2130
2149
  * Add a percentage string to a number
2150
+ * @param p1 the percentage string
2151
+ * @param p2 the number
2152
+ * @returns the sum of the percentage string and the number
2131
2153
  */
2132
2154
  export const addPercentageStringToNumber: (p1: string, p2: number) => number;
2133
2155
  /**
2134
2156
  * Parses a percentage string into a number
2135
2157
  * @param p the percentage string
2158
+ * @returns the parsed number
2136
2159
  */
2137
2160
  export const parsePercentage: (p: string) => number;
2138
2161
 
@@ -2344,6 +2367,7 @@ export interface IGraphConnectorHandlerProps {
2344
2367
  /**
2345
2368
  * This component is used to initiate a connection between two nodes. Simply
2346
2369
  * drag the handle in a node and drop it in another node to create a connection.
2370
+ * @returns connector element
2347
2371
  */
2348
2372
  export const GraphConnectorHandler: FC<IGraphConnectorHandlerProps>;
2349
2373
 
@@ -2413,6 +2437,8 @@ export const MarkerArrowId = "arrow";
2413
2437
  /**
2414
2438
  * This component draws a SVG line between two points, with an optional marker
2415
2439
  * indicating direction
2440
+ * @param props properties
2441
+ * @returns graph line element
2416
2442
  */
2417
2443
  export const GraphLine: FC<IGraphLineProps>;
2418
2444
 
@@ -2460,6 +2486,8 @@ export interface IGraphContainerProps {
2460
2486
  }
2461
2487
  /**
2462
2488
  * This component contains all the nodes and handles their dragging
2489
+ * @param props properties
2490
+ * @returns graph node container element
2463
2491
  */
2464
2492
  export const GraphNodesContainer: FC<IGraphContainerProps>;
2465
2493
 
@@ -2555,6 +2583,8 @@ export interface ITextInputProps {
2555
2583
  }
2556
2584
  /**
2557
2585
  * This component represents a text input that can be submitted or cancelled on buttons
2586
+ * @param props properties
2587
+ * @returns TextInputWithSubmit element
2558
2588
  */
2559
2589
  export const TextInputWithSubmit: (props: ITextInputProps) => JSX.Element;
2560
2590
 
@@ -2837,6 +2867,7 @@ interface IFloatLineComponentProps {
2837
2867
  unit?: React.ReactNode;
2838
2868
  onDragStart?: (newValue: number) => void;
2839
2869
  onDragStop?: (newValue: number) => void;
2870
+ disabled?: boolean;
2840
2871
  }
2841
2872
  export class FloatLineComponent extends React.Component<IFloatLineComponentProps, {
2842
2873
  value: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@babylonjs/gui-editor",
3
- "version": "6.39.0",
3
+ "version": "6.41.0",
4
4
  "main": "dist/babylon.guiEditor.max.js",
5
5
  "module": "dist/babylon.guiEditor.max.js",
6
6
  "esnext": "dist/babylon.guiEditor.max.js",
@@ -24,8 +24,8 @@
24
24
  "@types/react-dom": ">=16.0.9"
25
25
  },
26
26
  "devDependencies": {
27
- "@babylonjs/core": "^6.39.0",
28
- "@babylonjs/gui": "^6.39.0",
27
+ "@babylonjs/core": "^6.41.0",
28
+ "@babylonjs/gui": "^6.41.0",
29
29
  "react": "^17.0.2",
30
30
  "react-dom": "^17.0.2"
31
31
  },