UEA-PRODEM
This commit is contained in:
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+87
-10
@@ -23,7 +23,7 @@ declare type BaseSeparatorAttributes = Omit<HTMLAttributes<HTMLDivElement>, "rol
|
||||
*
|
||||
* ℹ️ [Test id](https://testing-library.com/docs/queries/bytestid/) can be used to narrow selection when unit testing.
|
||||
*/
|
||||
export declare function Group({ children, className, defaultLayout, disableCursor, disabled, elementRef: elementRefProp, groupRef, id: idProp, onLayoutChange: onLayoutChangeUnstable, orientation, style, ...rest }: GroupProps): JSX.Element;
|
||||
export declare function Group({ children, className, defaultLayout, disableCursor, disabled, elementRef: elementRefProp, groupRef, id: idProp, onLayoutChange: onLayoutChangeUnstable, onLayoutChanged: onLayoutChangedUnstable, orientation, resizeTargetMinimumSize, style, ...rest }: GroupProps): JSX.Element;
|
||||
|
||||
export declare namespace Group {
|
||||
var displayName: string;
|
||||
@@ -68,7 +68,8 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
|
||||
*
|
||||
* ℹ️ This value allows layouts to be remembered between page reloads.
|
||||
*
|
||||
* ⚠️ Refer to the documentation for how to avoid layout shift when using server components.
|
||||
* ⚠️ Slight layout shift may occur when server-rendering panels with percentage-based default sizes.
|
||||
* Refer to the documentation for suggestions on how to minimize the impact of this.
|
||||
*/
|
||||
defaultLayout?: Layout | undefined;
|
||||
/**
|
||||
@@ -83,7 +84,7 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
|
||||
/**
|
||||
* Ref attached to the root `HTMLDivElement`.
|
||||
*/
|
||||
elementRef?: Ref<HTMLDivElement> | undefined;
|
||||
elementRef?: Ref<HTMLDivElement | null> | undefined;
|
||||
/**
|
||||
* Exposes the following imperative API:
|
||||
* - `getLayout(): Layout`
|
||||
@@ -91,7 +92,7 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
|
||||
*
|
||||
* ℹ️ The `useGroupRef` and `useGroupCallbackRef` hooks are exported for convenience use in TypeScript projects.
|
||||
*/
|
||||
groupRef?: Ref<GroupImperativeHandle> | undefined;
|
||||
groupRef?: Ref<GroupImperativeHandle | null> | undefined;
|
||||
/**
|
||||
* Uniquely identifies this group within an application.
|
||||
* Falls back to `useId` when not provided.
|
||||
@@ -100,9 +101,34 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
|
||||
*/
|
||||
id?: string | number | undefined;
|
||||
/**
|
||||
* Called when panel sizes change; receives a map of Panel id to size.
|
||||
* Called when the Group's layout is changing.
|
||||
*
|
||||
* ⚠️ For layout changes caused by pointer events, this method is called each time the pointer is moved.
|
||||
* For most cases, it is recommended to use the `onLayoutChanged` callback instead.
|
||||
*/
|
||||
onLayoutChange?: (layout: Layout) => void | undefined;
|
||||
/**
|
||||
* Called after the Group's layout has been changed.
|
||||
*
|
||||
* ℹ️ For layout changes caused by pointer events, this method is not called until the pointer has been released.
|
||||
* This method is recommended when saving layouts to some storage api.
|
||||
*/
|
||||
onLayoutChanged?: (layout: Layout) => void | undefined;
|
||||
/**
|
||||
* Minimum size of the resizable hit target area (either `Separator` or `Panel` edge)
|
||||
* This threshold ensures are large enough to avoid mis-clicks.
|
||||
*
|
||||
* - Coarse inputs (typically a finger on a touchscreen) have reduced accuracy;
|
||||
* to ensure accessibility and ease of use, hit targets should be larger to prevent mis-clicks.
|
||||
* - Fine inputs (typically a mouse) can be smaller
|
||||
*
|
||||
* ℹ️ [Apple interface guidelines](https://developer.apple.com/design/human-interface-guidelines/accessibility) suggest `20pt` (`27px`) on desktops and `28pt` (`37px`) for touch devices
|
||||
* In practice this seems to be much larger than many of their own applications use though.
|
||||
*/
|
||||
resizeTargetMinimumSize?: {
|
||||
coarse: number;
|
||||
fine: number;
|
||||
};
|
||||
/**
|
||||
* Specifies the resizable orientation ("horizontal" or "vertical"); defaults to "horizontal"
|
||||
*/
|
||||
@@ -115,6 +141,11 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
|
||||
style?: CSSProperties | undefined;
|
||||
};
|
||||
|
||||
/**
|
||||
* Caches and returns matchMedia()'s computed value for "pointer:coarse"
|
||||
*/
|
||||
export declare function isCoarsePointer(): boolean;
|
||||
|
||||
/**
|
||||
* Map of Panel id to flexGrow value;
|
||||
*/
|
||||
@@ -156,8 +187,10 @@ export declare type Orientation = "horizontal" | "vertical";
|
||||
* ```
|
||||
*
|
||||
* ℹ️ [Test id](https://testing-library.com/docs/queries/bytestid/) can be used to narrow selection when unit testing.
|
||||
*
|
||||
* ⚠️ Panel elements must be direct DOM children of their parent Group elements.
|
||||
*/
|
||||
export declare function Panel({ children, className, collapsedSize, collapsible, defaultSize, elementRef: elementRefProp, id: idProp, maxSize, minSize, onResize: onResizeUnstable, panelRef, style, ...rest }: PanelProps): JSX.Element;
|
||||
export declare function Panel({ children, className, collapsedSize, collapsible, defaultSize, disabled, elementRef: elementRefProp, groupResizeBehavior, id: idProp, maxSize, minSize, onResize: onResizeUnstable, panelRef, style, ...rest }: PanelProps): JSX.Element;
|
||||
|
||||
export declare namespace Panel {
|
||||
var displayName: string;
|
||||
@@ -234,12 +267,31 @@ export declare type PanelProps = BasePanelAttributes & {
|
||||
collapsible?: boolean | undefined;
|
||||
/**
|
||||
* Default size of Panel within its parent group; default is auto-assigned based on the total number of Panels.
|
||||
*
|
||||
* ⚠️ Percentage based sizes may cause slight layout shift when server-rendering.
|
||||
* For more information see the documentation.
|
||||
*/
|
||||
defaultSize?: number | string | undefined;
|
||||
/**
|
||||
* When disabled, a panel cannot be resized either directly or indirectly (by resizing another panel).
|
||||
*/
|
||||
disabled?: boolean | undefined;
|
||||
/**
|
||||
* Ref attached to the root `HTMLDivElement`.
|
||||
*/
|
||||
elementRef?: Ref<HTMLDivElement> | undefined;
|
||||
elementRef?: Ref<HTMLDivElement | null> | undefined;
|
||||
/**
|
||||
* How should this Panel behave if the parent Group is resized?
|
||||
* Defaults to `preserve-relative-size`.
|
||||
*
|
||||
* - `preserve-relative-size`: Retain the current relative size (as a percentage of the Group)
|
||||
* - `preserve-pixel-size`: Retain its current size (in pixels)
|
||||
*
|
||||
* ℹ️ Panel min/max size constraints may impact this behavior.
|
||||
*
|
||||
* ⚠️ A Group must contain at least one Panel with `preserve-relative-size` resize behavior.
|
||||
*/
|
||||
groupResizeBehavior?: "preserve-relative-size" | "preserve-pixel-size" | undefined;
|
||||
/**
|
||||
* Uniquely identifies this panel within the parent group.
|
||||
* Falls back to `useId` when not provided.
|
||||
@@ -275,7 +327,7 @@ export declare type PanelProps = BasePanelAttributes & {
|
||||
*
|
||||
* ℹ️ The `usePanelRef` and `usePanelCallbackRef` hooks are exported for convenience use in TypeScript projects.
|
||||
*/
|
||||
panelRef?: Ref<PanelImperativeHandle> | undefined;
|
||||
panelRef?: Ref<PanelImperativeHandle | null> | undefined;
|
||||
/**
|
||||
* CSS properties.
|
||||
*
|
||||
@@ -292,7 +344,7 @@ export declare type PanelSize = {
|
||||
/**
|
||||
* Separators are not _required_ but they are _recommended_ as they improve keyboard accessibility.
|
||||
*
|
||||
* Separators should be rendered as the direct child of a Group component.
|
||||
* ⚠️ Separator elements must be direct DOM children of their parent Group elements.
|
||||
*
|
||||
* Separator elements always include the following attributes:
|
||||
*
|
||||
@@ -304,7 +356,7 @@ export declare type PanelSize = {
|
||||
*
|
||||
* ℹ️ In addition to the attributes shown above, separator also renders all required [WAI-ARIA properties](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/separator_role#associated_wai-aria_roles_states_and_properties).
|
||||
*/
|
||||
export declare function Separator({ children, className, elementRef: elementRefProp, id: idProp, style, ...rest }: SeparatorProps): JSX.Element;
|
||||
export declare function Separator({ children, className, disabled, disableDoubleClick, elementRef: elementRefProp, id: idProp, style, ...rest }: SeparatorProps): JSX.Element;
|
||||
|
||||
export declare namespace Separator {
|
||||
var displayName: string;
|
||||
@@ -319,6 +371,17 @@ export declare type SeparatorProps = BaseSeparatorAttributes & {
|
||||
* ⚠️ The following properties cannot be overridden: `flex-grow`, `flex-shrink`
|
||||
*/
|
||||
className?: string | undefined;
|
||||
/**
|
||||
* When disabled, the separator cannot be used to resize its neighboring panels.
|
||||
*
|
||||
* ℹ️ The panels may still be resized indirectly (while other panels are being resized).
|
||||
* To prevent a panel from being resized at all, it needs to also be disabled.
|
||||
*/
|
||||
disabled?: boolean | undefined;
|
||||
/**
|
||||
* When true, double-clicking this `Separator` will not reset its `Panel` to its default size.
|
||||
*/
|
||||
disableDoubleClick?: boolean;
|
||||
/**
|
||||
* Ref attached to the root `HTMLDivElement`.
|
||||
*/
|
||||
@@ -349,6 +412,8 @@ export declare type SizeUnit = "px" | "%" | "em" | "rem" | "vh" | "vw";
|
||||
export declare function useDefaultLayout({ debounceSaveMs, panelIds, storage, ...rest }: {
|
||||
/**
|
||||
* Debounce save operation by the specified number of milliseconds; defaults to 100ms
|
||||
*
|
||||
* @deprecated Use the {@link onLayoutChanged} callback instead; it does not require debouncing
|
||||
*/
|
||||
debounceSaveMs?: number;
|
||||
/**
|
||||
@@ -377,8 +442,20 @@ export declare function useDefaultLayout({ debounceSaveMs, panelIds, storage, ..
|
||||
*/
|
||||
id: string;
|
||||
})): {
|
||||
/**
|
||||
* Pass this value to `Group` as the `defaultLayout` prop.
|
||||
*/
|
||||
defaultLayout: Layout | undefined;
|
||||
/**
|
||||
* Attach this callback on the `Group` as the `onLayoutChange` prop.
|
||||
*
|
||||
* @deprecated Use the {@link onLayoutChanged} prop instead.
|
||||
*/
|
||||
onLayoutChange: (layout: Layout) => void | undefined;
|
||||
/**
|
||||
* Attach this callback on the `Group` as the `onLayoutChanged` prop.
|
||||
*/
|
||||
onLayoutChanged: (layout: Layout) => void | undefined;
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
+1646
-1259
File diff suppressed because it is too large
Load Diff
+1
-1
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user