react-resizable-panels 4.19.0 → 4.19.1
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.
|
@@ -90,7 +90,7 @@ export declare type CellProps = HTMLAttributes<HTMLDivElement> & {
|
|
|
90
90
|
* Uniquely identifies this cell within the parent grid.
|
|
91
91
|
* Falls back to `useId` when not provided.
|
|
92
92
|
*
|
|
93
|
-
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes
|
|
93
|
+
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes (an explicit `data-testid` prop will take precedence).
|
|
94
94
|
*/
|
|
95
95
|
id?: string | number | undefined;
|
|
96
96
|
/**
|
|
@@ -186,7 +186,7 @@ declare function GridComponent({ children, className, columns, defaultLayout, di
|
|
|
186
186
|
/**
|
|
187
187
|
* Imperative Grid API.
|
|
188
188
|
*
|
|
189
|
-
* ℹ️ The `useGridRef` and `useGridCallbackRef` hooks are exported for convenience
|
|
189
|
+
* ℹ️ The `useGridRef` and `useGridCallbackRef` hooks are exported for convenience in TypeScript projects.
|
|
190
190
|
*/
|
|
191
191
|
export declare interface GridImperativeHandle {
|
|
192
192
|
/**
|
|
@@ -279,7 +279,7 @@ export declare type GridLayout = {
|
|
|
279
279
|
* ```
|
|
280
280
|
*
|
|
281
281
|
* A gridline should not be rendered alongside of a Cell that spans across its boundary
|
|
282
|
-
* (this includes disabled gridlines; an error will be logged to the console);
|
|
282
|
+
* (this includes disabled gridlines; in development builds, an error will be logged to the console);
|
|
283
283
|
* render multiple gridlines along the same boundary instead (e.g. before and after the spanning Cell).
|
|
284
284
|
*
|
|
285
285
|
* ℹ️ Once a boundary contains a gridline, it can only be resized using gridlines;
|
|
@@ -396,14 +396,14 @@ export declare type GridProps = HTMLAttributes<HTMLDivElement> & {
|
|
|
396
396
|
* - `getTrackByIndex(axis: "column" | "row", index: number): GridTrackImperativeHandle`
|
|
397
397
|
* - `setLayout(layout: Partial<GridLayout>): GridLayout`
|
|
398
398
|
*
|
|
399
|
-
* ℹ️ The `useGridRef` and `useGridCallbackRef` hooks are exported for convenience
|
|
399
|
+
* ℹ️ The `useGridRef` and `useGridCallbackRef` hooks are exported for convenience in TypeScript projects.
|
|
400
400
|
*/
|
|
401
401
|
gridRef?: Ref<GridImperativeHandle | null> | undefined;
|
|
402
402
|
/**
|
|
403
403
|
* Uniquely identifies this grid within an application.
|
|
404
404
|
* Falls back to `useId` when not provided.
|
|
405
405
|
*
|
|
406
|
-
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes
|
|
406
|
+
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes (an explicit `data-testid` prop will take precedence).
|
|
407
407
|
*/
|
|
408
408
|
id?: string | number | undefined;
|
|
409
409
|
/**
|
|
@@ -416,8 +416,8 @@ export declare type GridProps = HTMLAttributes<HTMLDivElement> & {
|
|
|
416
416
|
/**
|
|
417
417
|
* Called after the Grid's layout has been changed.
|
|
418
418
|
*
|
|
419
|
-
* ℹ️ For layout changes caused by pointer events, this
|
|
420
|
-
* This
|
|
419
|
+
* ℹ️ For layout changes caused by pointer events, this callback is not called until the pointer has been released.
|
|
420
|
+
* This callback is recommended for saving layouts to storage.
|
|
421
421
|
*/
|
|
422
422
|
onLayoutChanged?: ((layout: GridLayout, meta: LayoutChangedMeta<GridLayout>) => void) | undefined;
|
|
423
423
|
/**
|
|
@@ -537,7 +537,7 @@ declare function GroupComponent({ children, className, defaultLayout, disableCur
|
|
|
537
537
|
/**
|
|
538
538
|
* Imperative Group API.
|
|
539
539
|
*
|
|
540
|
-
* ℹ️ The `useGroupRef` and `useGroupCallbackRef` hooks are exported for convenience
|
|
540
|
+
* ℹ️ The `useGroupRef` and `useGroupCallbackRef` hooks are exported for convenience in TypeScript projects.
|
|
541
541
|
*/
|
|
542
542
|
export declare interface GroupImperativeHandle {
|
|
543
543
|
/**
|
|
@@ -595,14 +595,14 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
|
|
|
595
595
|
* - `getLayout(): Layout`
|
|
596
596
|
* - `setLayout(layout: Layout): Layout`
|
|
597
597
|
*
|
|
598
|
-
* ℹ️ The `useGroupRef` and `useGroupCallbackRef` hooks are exported for convenience
|
|
598
|
+
* ℹ️ The `useGroupRef` and `useGroupCallbackRef` hooks are exported for convenience in TypeScript projects.
|
|
599
599
|
*/
|
|
600
600
|
groupRef?: Ref<GroupImperativeHandle | null> | undefined;
|
|
601
601
|
/**
|
|
602
602
|
* Uniquely identifies this group within an application.
|
|
603
603
|
* Falls back to `useId` when not provided.
|
|
604
604
|
*
|
|
605
|
-
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes
|
|
605
|
+
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes (an explicit `data-testid` prop will take precedence).
|
|
606
606
|
*/
|
|
607
607
|
id?: string | number | undefined;
|
|
608
608
|
/**
|
|
@@ -615,8 +615,8 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
|
|
|
615
615
|
/**
|
|
616
616
|
* Called after the Group's layout has been changed.
|
|
617
617
|
*
|
|
618
|
-
* ℹ️ For layout changes caused by pointer events, this
|
|
619
|
-
* This
|
|
618
|
+
* ℹ️ For layout changes caused by pointer events, this callback is not called until the pointer has been released.
|
|
619
|
+
* This callback is recommended for saving layouts to storage.
|
|
620
620
|
*
|
|
621
621
|
* ℹ️ The second argument contains meta information about the layout change.
|
|
622
622
|
* The `isUserInteraction` attribute signals whether the resize was caused by direct user input.
|
|
@@ -805,7 +805,7 @@ declare type PanelConstraintProps = Pick<PanelProps, "collapsedSize" | "collapse
|
|
|
805
805
|
/**
|
|
806
806
|
* Imperative Panel API
|
|
807
807
|
*
|
|
808
|
-
* ℹ️ The `usePanelRef` and `usePanelCallbackRef` hooks are exported for convenience
|
|
808
|
+
* ℹ️ The `usePanelRef` and `usePanelCallbackRef` hooks are exported for convenience in TypeScript projects.
|
|
809
809
|
*/
|
|
810
810
|
export declare interface PanelImperativeHandle {
|
|
811
811
|
/**
|
|
@@ -930,7 +930,7 @@ export declare type PanelProps = BasePanelAttributes & {
|
|
|
930
930
|
*
|
|
931
931
|
* ℹ️ This prop is used to associate persisted group layouts with the original panel.
|
|
932
932
|
*
|
|
933
|
-
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes
|
|
933
|
+
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes (an explicit `data-testid` prop will take precedence).
|
|
934
934
|
*/
|
|
935
935
|
id?: string | number | undefined;
|
|
936
936
|
/**
|
|
@@ -971,7 +971,7 @@ export declare type PanelProps = BasePanelAttributes & {
|
|
|
971
971
|
* - `isCollapsed(): boolean`
|
|
972
972
|
* - `resize(size: number | string): void`
|
|
973
973
|
*
|
|
974
|
-
* ℹ️ The `usePanelRef` and `usePanelCallbackRef` hooks are exported for convenience
|
|
974
|
+
* ℹ️ The `usePanelRef` and `usePanelCallbackRef` hooks are exported for convenience in TypeScript projects.
|
|
975
975
|
*/
|
|
976
976
|
panelRef?: Ref<PanelImperativeHandle | null> | undefined;
|
|
977
977
|
/**
|
|
@@ -1285,7 +1285,7 @@ export declare type SeparatorProps = BaseSeparatorAttributes & {
|
|
|
1285
1285
|
* Uniquely identifies the separator within the parent group.
|
|
1286
1286
|
* Falls back to `useId` when not provided.
|
|
1287
1287
|
*
|
|
1288
|
-
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes
|
|
1288
|
+
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes (an explicit `data-testid` prop will take precedence).
|
|
1289
1289
|
*/
|
|
1290
1290
|
id?: string | number | undefined;
|
|
1291
1291
|
/**
|
|
@@ -2247,14 +2247,14 @@ export declare type WorkspaceProps<TabData = unknown, TabsetData = unknown> = Om
|
|
|
2247
2247
|
* Uniquely identifies this workspace within an application.
|
|
2248
2248
|
* Falls back to `useId` when not provided.
|
|
2249
2249
|
*
|
|
2250
|
-
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes
|
|
2250
|
+
* ℹ️ This value will also be assigned to the `id` and `data-testid` attributes (an explicit `data-testid` prop will take precedence).
|
|
2251
2251
|
*/
|
|
2252
2252
|
id?: string | number | undefined;
|
|
2253
2253
|
/**
|
|
2254
2254
|
* Called after the model has changed (e.g. a tab was moved, selected, or closed, or a tabset was resized).
|
|
2255
2255
|
*
|
|
2256
|
-
* ℹ️ For changes caused by pointer events, this
|
|
2257
|
-
* This
|
|
2256
|
+
* ℹ️ For changes caused by pointer events, this callback is not called until the pointer has been released.
|
|
2257
|
+
* This callback is recommended for saving models to storage.
|
|
2258
2258
|
*/
|
|
2259
2259
|
onModelChanged?: (model: WorkspaceModel<TabData, TabsetData>, meta: WorkspaceChangedMeta) => void;
|
|
2260
2260
|
/**
|
|
@@ -2425,7 +2425,7 @@ export declare type WorkspaceProps<TabData = unknown, TabsetData = unknown> = Om
|
|
|
2425
2425
|
/**
|
|
2426
2426
|
* Exposes the imperative API (see `WorkspaceImperativeHandle`).
|
|
2427
2427
|
*
|
|
2428
|
-
* ℹ️ The `useWorkspaceRef` and `useWorkspaceCallbackRef` hooks are exported for convenience
|
|
2428
|
+
* ℹ️ The `useWorkspaceRef` and `useWorkspaceCallbackRef` hooks are exported for convenience in TypeScript projects.
|
|
2429
2429
|
*/
|
|
2430
2430
|
workspaceRef?: Ref<WorkspaceImperativeHandle<TabData, TabsetData> | null> | undefined;
|
|
2431
2431
|
};
|