babylonjs-node-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.
@@ -1706,6 +1706,8 @@ export interface IDraggableIconProps {
1706
1706
  }
1707
1707
  /**
1708
1708
  * An icon that can be dragged by the user
1709
+ * @param props properties
1710
+ * @returns draggable icon element
1709
1711
  */
1710
1712
  export const DraggableIcon: FC<IDraggableIconProps>;
1711
1713
 
@@ -1747,6 +1749,8 @@ export interface IFlexibleDragHandlerProps {
1747
1749
  }
1748
1750
  /**
1749
1751
  * This component receives the drop events and updates the layout accordingly
1752
+ * @param props properties
1753
+ * @returns DragHandler element
1750
1754
  */
1751
1755
  export const FlexibleDragHandler: FC<IFlexibleDragHandlerProps>;
1752
1756
 
@@ -1769,6 +1773,8 @@ export interface IFlexibleDropZoneProps {
1769
1773
  /**
1770
1774
  * This component contains the drag and drop zone for the resize bars that
1771
1775
  * allow redefining width and height of layout elements
1776
+ * @param props properties
1777
+ * @returns drop zone element
1772
1778
  */
1773
1779
  export const FlexibleDropZone: FC<IFlexibleDropZoneProps>;
1774
1780
 
@@ -1782,6 +1788,7 @@ export interface IFlexibleGridContainerProps {
1782
1788
  }
1783
1789
  /**
1784
1790
  * Component responsible for mapping the layout to the actual components
1791
+ * @returns GridContainer element
1785
1792
  */
1786
1793
  export const FlexibleGridContainer: FC<IFlexibleGridContainerProps>;
1787
1794
 
@@ -1801,6 +1808,8 @@ export interface IFlexibleGridLayoutProps {
1801
1808
  /**
1802
1809
  * This component represents a grid layout that can be resized and rearranged
1803
1810
  * by the user.
1811
+ * @param props properties
1812
+ * @returns layout element
1804
1813
  */
1805
1814
  export const FlexibleGridLayout: FC<IFlexibleGridLayoutProps>;
1806
1815
 
@@ -1844,6 +1853,8 @@ export type ResizeItem = {
1844
1853
  };
1845
1854
  /**
1846
1855
  * A component that renders a bar that the user can drag to resize.
1856
+ * @param props properties
1857
+ * @returns resize bar element
1847
1858
  */
1848
1859
  export const FlexibleResizeBar: FC<IFlexibleRowResizerProps>;
1849
1860
 
@@ -1881,6 +1892,8 @@ export interface IFlexibleTabProps {
1881
1892
  * to activate or drag to reorder. It also listens for
1882
1893
  * drop events if the user wants to drop another tab
1883
1894
  * after it.
1895
+ * @param props properties
1896
+ * @returns FlexibleTab element
1884
1897
  */
1885
1898
  export const FlexibleTab: FC<IFlexibleTabProps>;
1886
1899
 
@@ -1912,6 +1925,8 @@ export interface IFlexibleTabsContainerProps {
1912
1925
  /**
1913
1926
  * This component contains a set of tabs of which only one is visible at a time.
1914
1927
  * The tabs can also be dragged from and to different containers.
1928
+ * @param props properties
1929
+ * @returns tabs container element
1915
1930
  */
1916
1931
  export const FlexibleTabsContainer: FC<IFlexibleTabsContainerProps>;
1917
1932
 
@@ -2035,11 +2050,15 @@ export const getPosInLayout: (layout: Layout, column: number, row?: number) => L
2035
2050
  export const removeLayoutRowAndRedistributePercentages: (layout: Layout, column: number, row: number) => void;
2036
2051
  /**
2037
2052
  * Add a percentage string to a number
2053
+ * @param p1 the percentage string
2054
+ * @param p2 the number
2055
+ * @returns the sum of the percentage string and the number
2038
2056
  */
2039
2057
  export const addPercentageStringToNumber: (p1: string, p2: number) => number;
2040
2058
  /**
2041
2059
  * Parses a percentage string into a number
2042
2060
  * @param p the percentage string
2061
+ * @returns the parsed number
2043
2062
  */
2044
2063
  export const parsePercentage: (p: string) => number;
2045
2064
 
@@ -2251,6 +2270,7 @@ export interface IGraphConnectorHandlerProps {
2251
2270
  /**
2252
2271
  * This component is used to initiate a connection between two nodes. Simply
2253
2272
  * drag the handle in a node and drop it in another node to create a connection.
2273
+ * @returns connector element
2254
2274
  */
2255
2275
  export const GraphConnectorHandler: FC<IGraphConnectorHandlerProps>;
2256
2276
 
@@ -2320,6 +2340,8 @@ export const MarkerArrowId = "arrow";
2320
2340
  /**
2321
2341
  * This component draws a SVG line between two points, with an optional marker
2322
2342
  * indicating direction
2343
+ * @param props properties
2344
+ * @returns graph line element
2323
2345
  */
2324
2346
  export const GraphLine: FC<IGraphLineProps>;
2325
2347
 
@@ -2367,6 +2389,8 @@ export interface IGraphContainerProps {
2367
2389
  }
2368
2390
  /**
2369
2391
  * This component contains all the nodes and handles their dragging
2392
+ * @param props properties
2393
+ * @returns graph node container element
2370
2394
  */
2371
2395
  export const GraphNodesContainer: FC<IGraphContainerProps>;
2372
2396
 
@@ -2462,6 +2486,8 @@ export interface ITextInputProps {
2462
2486
  }
2463
2487
  /**
2464
2488
  * This component represents a text input that can be submitted or cancelled on buttons
2489
+ * @param props properties
2490
+ * @returns TextInputWithSubmit element
2465
2491
  */
2466
2492
  export const TextInputWithSubmit: (props: ITextInputProps) => JSX.Element;
2467
2493
 
@@ -2744,6 +2770,7 @@ interface IFloatLineComponentProps {
2744
2770
  unit?: React.ReactNode;
2745
2771
  onDragStart?: (newValue: number) => void;
2746
2772
  onDragStop?: (newValue: number) => void;
2773
+ disabled?: boolean;
2747
2774
  }
2748
2775
  export class FloatLineComponent extends React.Component<IFloatLineComponentProps, {
2749
2776
  value: string;
@@ -5795,6 +5822,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
5795
5822
  }
5796
5823
  /**
5797
5824
  * An icon that can be dragged by the user
5825
+ * @param props properties
5826
+ * @returns draggable icon element
5798
5827
  */
5799
5828
  export var DraggableIcon: React.FC<IDraggableIconProps>;
5800
5829
 
@@ -5844,6 +5873,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
5844
5873
  }
5845
5874
  /**
5846
5875
  * This component receives the drop events and updates the layout accordingly
5876
+ * @param props properties
5877
+ * @returns DragHandler element
5847
5878
  */
5848
5879
  export var FlexibleDragHandler: React.FC<IFlexibleDragHandlerProps>;
5849
5880
 
@@ -5870,6 +5901,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
5870
5901
  /**
5871
5902
  * This component contains the drag and drop zone for the resize bars that
5872
5903
  * allow redefining width and height of layout elements
5904
+ * @param props properties
5905
+ * @returns drop zone element
5873
5906
  */
5874
5907
  export var FlexibleDropZone: React.FC<IFlexibleDropZoneProps>;
5875
5908
 
@@ -5887,6 +5920,7 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
5887
5920
  }
5888
5921
  /**
5889
5922
  * Component responsible for mapping the layout to the actual components
5923
+ * @returns GridContainer element
5890
5924
  */
5891
5925
  export var FlexibleGridContainer: React.FC<IFlexibleGridContainerProps>;
5892
5926
 
@@ -5909,6 +5943,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
5909
5943
  /**
5910
5944
  * This component represents a grid layout that can be resized and rearranged
5911
5945
  * by the user.
5946
+ * @param props properties
5947
+ * @returns layout element
5912
5948
  */
5913
5949
  export var FlexibleGridLayout: React.FC<IFlexibleGridLayoutProps>;
5914
5950
 
@@ -5955,6 +5991,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
5955
5991
  };
5956
5992
  /**
5957
5993
  * A component that renders a bar that the user can drag to resize.
5994
+ * @param props properties
5995
+ * @returns resize bar element
5958
5996
  */
5959
5997
  export var FlexibleResizeBar: React.FC<IFlexibleRowResizerProps>;
5960
5998
 
@@ -5995,6 +6033,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
5995
6033
  * to activate or drag to reorder. It also listens for
5996
6034
  * drop events if the user wants to drop another tab
5997
6035
  * after it.
6036
+ * @param props properties
6037
+ * @returns FlexibleTab element
5998
6038
  */
5999
6039
  export var FlexibleTab: React.FC<IFlexibleTabProps>;
6000
6040
 
@@ -6029,6 +6069,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
6029
6069
  /**
6030
6070
  * This component contains a set of tabs of which only one is visible at a time.
6031
6071
  * The tabs can also be dragged from and to different containers.
6072
+ * @param props properties
6073
+ * @returns tabs container element
6032
6074
  */
6033
6075
  export var FlexibleTabsContainer: React.FC<IFlexibleTabsContainerProps>;
6034
6076
 
@@ -6164,11 +6206,15 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
6164
6206
  export const removeLayoutRowAndRedistributePercentages: (layout: BABYLON.NodeEditor.SharedUIComponents.Layout, column: number, row: number) => void;
6165
6207
  /**
6166
6208
  * Add a percentage string to a number
6209
+ * @param p1 the percentage string
6210
+ * @param p2 the number
6211
+ * @returns the sum of the percentage string and the number
6167
6212
  */
6168
6213
  export const addPercentageStringToNumber: (p1: string, p2: number) => number;
6169
6214
  /**
6170
6215
  * Parses a percentage string into a number
6171
6216
  * @param p the percentage string
6217
+ * @returns the parsed number
6172
6218
  */
6173
6219
  export const parsePercentage: (p: string) => number;
6174
6220
 
@@ -6399,6 +6445,7 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
6399
6445
  /**
6400
6446
  * This component is used to initiate a connection between two nodes. Simply
6401
6447
  * drag the handle in a node and drop it in another node to create a connection.
6448
+ * @returns connector element
6402
6449
  */
6403
6450
  export var GraphConnectorHandler: React.FC<IGraphConnectorHandlerProps>;
6404
6451
 
@@ -6481,6 +6528,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
6481
6528
  /**
6482
6529
  * This component draws a SVG line between two points, with an optional marker
6483
6530
  * indicating direction
6531
+ * @param props properties
6532
+ * @returns graph line element
6484
6533
  */
6485
6534
  export var GraphLine: React.FC<IGraphLineProps>;
6486
6535
 
@@ -6540,6 +6589,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
6540
6589
  }
6541
6590
  /**
6542
6591
  * This component contains all the nodes and handles their dragging
6592
+ * @param props properties
6593
+ * @returns graph node container element
6543
6594
  */
6544
6595
  export var GraphNodesContainer: React.FC<IGraphContainerProps>;
6545
6596
 
@@ -6648,6 +6699,8 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
6648
6699
  }
6649
6700
  /**
6650
6701
  * This component represents a text input that can be submitted or cancelled on buttons
6702
+ * @param props properties
6703
+ * @returns TextInputWithSubmit element
6651
6704
  */
6652
6705
  export const TextInputWithSubmit: (props: ITextInputProps) => JSX.Element;
6653
6706
 
@@ -6957,6 +7010,7 @@ declare module BABYLON.NodeEditor.SharedUIComponents {
6957
7010
  unit?: React.ReactNode;
6958
7011
  onDragStart?: (newValue: number) => void;
6959
7012
  onDragStop?: (newValue: number) => void;
7013
+ disabled?: boolean;
6960
7014
  }
6961
7015
  export class FloatLineComponent extends React.Component<IFloatLineComponentProps, {
6962
7016
  value: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "babylonjs-node-editor",
3
- "version": "6.39.0",
3
+ "version": "6.41.0",
4
4
  "main": "babylon.nodeEditor.js",
5
5
  "types": "babylon.nodeEditor.module.d.ts",
6
6
  "files": [
@@ -14,7 +14,7 @@
14
14
  "clean": "rimraf dist && rimraf babylon*.*"
15
15
  },
16
16
  "dependencies": {
17
- "babylonjs": "^6.39.0"
17
+ "babylonjs": "^6.41.0"
18
18
  },
19
19
  "devDependencies": {
20
20
  "@dev/build-tools": "1.0.0",