@sheetxl/utils-mui 0.7.26 → 0.7.28-beta.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.
- package/browser/cjs/CMDyOaq_TZmhbR3R.cjs +1 -0
- package/browser/cjs/GeHQP4M_1ydWv9v4.cjs +3 -0
- package/browser/cjs/index.cjs +4 -7
- package/browser/esm/CS_JzxfpVf9TlNsZ.mjs +96 -0
- package/browser/esm/DTtDTwN0K4atO3Er.mjs +2544 -0
- package/browser/esm/index.mjs +2688 -72
- package/licenses/dependencies.txt +60 -198
- package/node/esm/CbmHouxoPCCNwqGT.mjs +97 -0
- package/node/esm/index.mjs +3354 -981
- package/package.json +12 -14
- package/resources/contents.json +18 -0
- package/resources/locales/contents.json +16 -0
- package/resources/locales/de/ui.msg.json +22 -0
- package/resources/locales/en/ui.msg.json +22 -0
- package/types/index.d.ts +2 -1068
- package/types/src/button/ButtonContent.d.ts +17 -0
- package/types/src/button/ExhibitIconButton.d.ts +31 -0
- package/types/src/button/ExhibitMenuHeader.d.ts +15 -0
- package/types/src/button/ExhibitMenuItem.d.ts +24 -0
- package/types/src/button/ExhibitOptionButton.d.ts +16 -0
- package/types/src/button/ExhibitPopupIconButton.d.ts +18 -0
- package/types/src/button/ExhibitPopupMenuItem.d.ts +8 -0
- package/types/src/button/ExhibitTooltip.d.ts +26 -0
- package/types/src/button/OverflowPalette.d.ts +29 -0
- package/types/src/button/SelectedIcon.d.ts +18 -0
- package/types/src/button/index.d.ts +11 -0
- package/types/src/command/CommandButton.d.ts +4 -0
- package/types/src/command/CommandGroup.d.ts +71 -0
- package/types/src/command/CommandPopupButton.d.ts +34 -0
- package/types/src/command/CommandToolbar.d.ts +51 -0
- package/types/src/command/CommandTooltip.d.ts +22 -0
- package/types/src/command/InputCommandButton.d.ts +20 -0
- package/types/src/command/ToggleGroupButton.d.ts +33 -0
- package/types/src/command/index.d.ts +8 -0
- package/types/src/command/useManagedRipple.d.ts +23 -0
- package/types/src/components/AnimatedLoadingPanel.d.ts +45 -0
- package/types/src/components/ChipStrip.d.ts +9 -0
- package/types/src/components/ContextMenu.d.ts +32 -0
- package/types/src/components/ExhibitDivider.d.ts +6 -0
- package/types/src/components/NestingPopupButton.d.ts +11 -0
- package/types/src/components/ScrollButtons.d.ts +7 -0
- package/types/src/components/SimpleTooltip.d.ts +15 -0
- package/types/src/components/StackTrace.d.ts +20 -0
- package/types/src/components/StackTraceErrorPanel.d.ts +28 -0
- package/types/src/components/index.d.ts +10 -0
- package/types/src/dialog/InputDialog.d.ts +8 -0
- package/types/src/dialog/InternalWindow.d.ts +142 -0
- package/types/src/dialog/OptionsDialog.d.ts +19 -0
- package/types/src/dialog/index.d.ts +10 -0
- package/types/src/dialog/useInputDialog.d.ts +6 -0
- package/types/src/dialog/useLazyWindow.d.ts +14 -0
- package/types/src/dialog/useOptionsDialog.d.ts +8 -0
- package/types/src/float/ExhibitFloatPanel.d.ts +22 -0
- package/types/src/float/ExhibitFloatProvider.d.ts +17 -0
- package/types/src/float/ExhibitPopup.d.ts +97 -0
- package/types/src/float/index.d.ts +4 -0
- package/types/src/index.d.ts +8 -0
- package/types/src/locales/index.d.ts +3 -0
- package/types/src/theme/ExhibitTheme.d.ts +71 -0
- package/types/src/theme/IconSupport.d.ts +11 -0
- package/types/src/theme/ScrollbarTheming.d.ts +12 -0
- package/types/src/theme/index.d.ts +4 -0
- package/browser/cjs/Buzj_RuBZDULt78F.cjs +0 -11
- package/browser/cjs/DvRQUuQp6BSo_oUy.cjs +0 -6
- package/browser/esm/BNnvsy-BNmkD2vU1.mjs +0 -44
- package/browser/esm/D1zL4el7EI4boIdP.mjs +0 -2891
- package/node/assets/style.css +0 -1
- package/node/esm/DACH-8zNFkXeTBDb.mjs +0 -45
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export interface StackTraceProps {
|
|
3
|
+
/**
|
|
4
|
+
* The error object containing the stack trace.
|
|
5
|
+
*/
|
|
6
|
+
error: Error;
|
|
7
|
+
/**
|
|
8
|
+
* Maximum number of stack trace lines to show.
|
|
9
|
+
*
|
|
10
|
+
* If not provided, all lines will be shown.
|
|
11
|
+
*/
|
|
12
|
+
maxLines?: number;
|
|
13
|
+
/**
|
|
14
|
+
* Whether to show line numbers
|
|
15
|
+
*/
|
|
16
|
+
hideLineNumbers?: boolean;
|
|
17
|
+
}
|
|
18
|
+
/** Basic StackTrace component */
|
|
19
|
+
export declare const StackTrace: React.FC<StackTraceProps>;
|
|
20
|
+
//# sourceMappingURL=StackTrace.d.ts.map
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { BoxProps } from '@mui/material';
|
|
3
|
+
import { ErrorPanelProps } from '@sheetxl/utils-react';
|
|
4
|
+
export interface StackTraceErrorPanelProps extends ErrorPanelProps, Omit<BoxProps, 'color' | 'ref'> {
|
|
5
|
+
/**
|
|
6
|
+
* Whether to hide the stack trace.
|
|
7
|
+
*
|
|
8
|
+
* @defaultValue false
|
|
9
|
+
*/
|
|
10
|
+
hideStackTrace?: boolean;
|
|
11
|
+
/**
|
|
12
|
+
* Whether the stack trace should be expanded by default
|
|
13
|
+
*
|
|
14
|
+
* @defaultValue false
|
|
15
|
+
*/
|
|
16
|
+
stackTraceExpanded?: boolean;
|
|
17
|
+
fullscreen?: boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Optional icon to show
|
|
20
|
+
*/
|
|
21
|
+
icon?: React.ReactNode;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Error Panel with a StackTrace.
|
|
25
|
+
* Todo - allow for action flag
|
|
26
|
+
*/
|
|
27
|
+
export declare const StackTraceErrorPanel: React.NamedExoticComponent<Omit<StackTraceErrorPanelProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
|
|
28
|
+
//# sourceMappingURL=StackTraceErrorPanel.d.ts.map
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export * from './ScrollButtons';
|
|
2
|
+
export * from './ExhibitDivider';
|
|
3
|
+
export * from './AnimatedLoadingPanel';
|
|
4
|
+
export * from './StackTraceErrorPanel';
|
|
5
|
+
export * from './StackTrace';
|
|
6
|
+
export * from './ChipStrip';
|
|
7
|
+
export * from './NestingPopupButton';
|
|
8
|
+
export * from './ContextMenu';
|
|
9
|
+
export * from './SimpleTooltip';
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ShowInputOptions } from '@sheetxl/utils-react';
|
|
3
|
+
import { OptionsDialogProps } from './useOptionsDialog';
|
|
4
|
+
export interface InputDialogProps<T = any, C = any> extends ShowInputOptions<T, C>, Omit<OptionsDialogProps<T, C>, 'initialValue' | 'style' | 'onInput' | 'autoFocus' | 'onKeyDown'> {
|
|
5
|
+
}
|
|
6
|
+
declare const InputDialog: React.NamedExoticComponent<Omit<InputDialogProps<any, any>, "ref"> & React.RefAttributes<HTMLDivElement>>;
|
|
7
|
+
export default InputDialog;
|
|
8
|
+
//# sourceMappingURL=InputDialog.d.ts.map
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { DialogSlots, Backdrop, ModalProps, DialogProps, PaperProps } from '@mui/material';
|
|
3
|
+
import { TransitionProps } from '@mui/material/transitions';
|
|
4
|
+
import { DraggableEventHandler } from 'react-draggable';
|
|
5
|
+
import { Point, Size } from '@sheetxl/utils';
|
|
6
|
+
export interface DraggablePaperProps extends PaperProps {
|
|
7
|
+
onDragStop?: DraggableEventHandler;
|
|
8
|
+
PaperComponent?: React.JSXElementConstructor<PaperProps>;
|
|
9
|
+
titleSize?: Size;
|
|
10
|
+
rootSize?: Size;
|
|
11
|
+
handleSel?: string;
|
|
12
|
+
rootSel?: string;
|
|
13
|
+
defaultPosition?: Point;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* If the x or y is a string it is assumed to be a percentage of available space before.
|
|
17
|
+
*/
|
|
18
|
+
export interface RelativePoint {
|
|
19
|
+
x?: number | string;
|
|
20
|
+
y?: number | string;
|
|
21
|
+
}
|
|
22
|
+
export interface InternalWindowProps<T = any, R = any> extends Omit<DialogProps, 'open'> {
|
|
23
|
+
open?: ModalProps['open'];
|
|
24
|
+
/**
|
|
25
|
+
* The dialog title
|
|
26
|
+
*/
|
|
27
|
+
title?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Query selector for the element to focus on show.
|
|
30
|
+
*
|
|
31
|
+
* @remarks
|
|
32
|
+
* It would be better to honor autoFocus attribute but React is 'hiding' it
|
|
33
|
+
*/
|
|
34
|
+
autoFocusSel?: string;
|
|
35
|
+
onCancel?: () => void;
|
|
36
|
+
onDone?: (results?: any) => void;
|
|
37
|
+
onShow?: () => void;
|
|
38
|
+
onShown?: (internalWindow: IInternalWindowElement) => void;
|
|
39
|
+
onHide?: () => void;
|
|
40
|
+
/**
|
|
41
|
+
* If true show a backdrop.
|
|
42
|
+
*
|
|
43
|
+
* @remarks
|
|
44
|
+
* Our movable menu achieves modality without a background by listens to global clicks (and focus)
|
|
45
|
+
* @defaultValue false
|
|
46
|
+
*/
|
|
47
|
+
isModal?: boolean;
|
|
48
|
+
/**
|
|
49
|
+
* Temporarily SUSPEND the modality of an `isModal` window: the backdrop is not rendered, so the
|
|
50
|
+
* application behind stays clickable, while the window itself remains open, visible and draggable.
|
|
51
|
+
* The focus trap is already soft (it only enforces while the window has focus), so focus may move
|
|
52
|
+
* to the application and back freely.
|
|
53
|
+
*
|
|
54
|
+
* @remarks
|
|
55
|
+
* The Excel "RefEdit" pattern: a dialog hosting a reference field flips this on while the field is
|
|
56
|
+
* PICKING (reference point mode), so a grid/header click reaches the sheet instead of the backdrop
|
|
57
|
+
* (which would otherwise swallow — and cancel on — the click), and off again when the pick ends.
|
|
58
|
+
* @defaultValue false
|
|
59
|
+
*/
|
|
60
|
+
suspendModal?: boolean;
|
|
61
|
+
/**
|
|
62
|
+
* Whether closing returns the keyboard to whatever held it when the window opened.
|
|
63
|
+
*
|
|
64
|
+
* @remarks
|
|
65
|
+
* `false` leaves focus alone — for a window whose OUTCOME moves the keyboard itself (Insert
|
|
66
|
+
* Function seeds `=NAME(` and puts the user in the cell's editor). The restore is a queued frame,
|
|
67
|
+
* so it lands *after* the new owner has taken focus and quietly takes it away again.
|
|
68
|
+
*
|
|
69
|
+
* A **thunk** is read as the window exits, which is what a window whose answer depends on how it
|
|
70
|
+
* was dismissed needs — cancel restores, an insert that starts an edit does not. A boolean would
|
|
71
|
+
* have to be in state, and there is no guaranteed render between the option being taken and the
|
|
72
|
+
* exit transition starting.
|
|
73
|
+
* @defaultValue true
|
|
74
|
+
*/
|
|
75
|
+
restoreFocus?: boolean | (() => boolean);
|
|
76
|
+
/**
|
|
77
|
+
* When true this window is kept mounted after it closes so it can be reused (re-shown by bumping
|
|
78
|
+
* {@link InternalWindowProps.revealToken}) instead of destroyed and rebuilt. This both makes
|
|
79
|
+
* re-open instant and preserves position + content state.
|
|
80
|
+
*
|
|
81
|
+
* @remarks
|
|
82
|
+
* `mui-modal-provider@2.4.6` wires `TransitionProps.onExited -> destroy` whenever `destroyOnClose`
|
|
83
|
+
* is false (its issue #78), so a keep-alive window would otherwise be destroyed on the exit
|
|
84
|
+
* transition anyway. When this is set we skip forwarding `onExited` to that destroyer.
|
|
85
|
+
* @defaultValue false
|
|
86
|
+
*/
|
|
87
|
+
disableAutoDestroy?: boolean;
|
|
88
|
+
/**
|
|
89
|
+
* Monotonic token bumped by the host each time a keep-alive window should re-show. An effect
|
|
90
|
+
* re-reveals the window whenever this changes. Prop-based (not imperative on the DOM element,
|
|
91
|
+
* whose identity is fragile across re-renders/StrictMode) and survives `updateModal` (which only
|
|
92
|
+
* strips `open`). Ignored on first mount.
|
|
93
|
+
*/
|
|
94
|
+
revealToken?: number;
|
|
95
|
+
/**
|
|
96
|
+
* Mount hidden and suppress the initial auto-reveal (used for prewarming — mounting + positioning a
|
|
97
|
+
* keep-alive window ahead of its first real open). The window stays hidden until {@link revealToken}
|
|
98
|
+
* is bumped (or this flips false). Needed because `mui-modal-provider`'s SHOW force-sets `open:true`,
|
|
99
|
+
* so `open` alone can't keep a prewarmed window hidden.
|
|
100
|
+
* @defaultValue false
|
|
101
|
+
*/
|
|
102
|
+
startHidden?: boolean;
|
|
103
|
+
/**
|
|
104
|
+
* A default position for the window. The default is center at %50, %50.
|
|
105
|
+
*/
|
|
106
|
+
initialPosition?: RelativePoint;
|
|
107
|
+
/**
|
|
108
|
+
* The components used for each slot inside.
|
|
109
|
+
* @default {}
|
|
110
|
+
*/
|
|
111
|
+
slots?: DialogSlots & {
|
|
112
|
+
transition?: React.ComponentType<TransitionProps>;
|
|
113
|
+
paper?: React.ComponentType<PaperProps>;
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* The extra props for the slot components.
|
|
117
|
+
* You can override the existing props or add new ones.
|
|
118
|
+
* @default {}
|
|
119
|
+
*/
|
|
120
|
+
slotProps?: {
|
|
121
|
+
backdrop?: React.ComponentProps<typeof Backdrop>;
|
|
122
|
+
paper?: PaperProps;
|
|
123
|
+
transition?: TransitionProps;
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* @deprecated v9 removed `TransitionProps` from `DialogProps`. Retained here
|
|
127
|
+
* only because `useModal` (mui-modal-provider) still injects it; it is mapped
|
|
128
|
+
* onto `slotProps.transition` internally.
|
|
129
|
+
*/
|
|
130
|
+
TransitionProps?: TransitionProps;
|
|
131
|
+
}
|
|
132
|
+
export interface InternalWindowAttributes {
|
|
133
|
+
focus: (options?: FocusOptions) => void;
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Type returned via ref property
|
|
137
|
+
*/
|
|
138
|
+
export interface IInternalWindowElement extends InternalWindowAttributes, HTMLElement {
|
|
139
|
+
}
|
|
140
|
+
export declare const InternalWindow: React.NamedExoticComponent<Omit<InternalWindowProps<any, any>, "ref"> & React.RefAttributes<IInternalWindowElement>>;
|
|
141
|
+
export default InternalWindow;
|
|
142
|
+
//# sourceMappingURL=InternalWindow.d.ts.map
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { OptionInput } from '@sheetxl/utils-react';
|
|
3
|
+
import { OptionsDialogProps } from './useOptionsDialog';
|
|
4
|
+
/**
|
|
5
|
+
* The stable, language-free IDENTITY of an option — its `id` if given, else the `string` form, else the
|
|
6
|
+
* {@link InputOption} object itself. This is what crosses the notifier boundary as `results.option` and
|
|
7
|
+
* what `defaultOption`/`cancelOption` are matched against.
|
|
8
|
+
*
|
|
9
|
+
* @remarks
|
|
10
|
+
* Exported for a host that takes an option's action from somewhere OTHER than the action row — a
|
|
11
|
+
* list's double-click "that one", a keyboard shortcut. `options`/`defaultOption` hold the rich form,
|
|
12
|
+
* `onOption` receives the identity, and a shortcut that forwards what it was given hands its own
|
|
13
|
+
* handler an object where every button hands it a string. Every `option === 'Next'` comparison in that
|
|
14
|
+
* handler then silently answers `false`.
|
|
15
|
+
*/
|
|
16
|
+
export declare const optionIdentity: (option: OptionInput) => OptionInput;
|
|
17
|
+
export declare const OptionsDialog: React.NamedExoticComponent<Omit<OptionsDialogProps<any, any>, "ref"> & React.RefAttributes<HTMLDivElement>>;
|
|
18
|
+
export default OptionsDialog;
|
|
19
|
+
//# sourceMappingURL=OptionsDialog.d.ts.map
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { default as ModalProvider } from 'mui-modal-provider';
|
|
2
|
+
export * from './useLazyWindow';
|
|
3
|
+
export * from './InternalWindow';
|
|
4
|
+
export * from './OptionsDialog';
|
|
5
|
+
export type { InputDialogProps } from './InputDialog';
|
|
6
|
+
export * from './useOptionsDialog';
|
|
7
|
+
export * from './useInputDialog';
|
|
8
|
+
export * from 'mui-modal-provider';
|
|
9
|
+
export { ModalProvider };
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { InputResults } from '@sheetxl/utils-react';
|
|
2
|
+
import { InputDialogProps } from './InputDialog';
|
|
3
|
+
declare const useInputDialog: (propsDefault?: InputDialogProps) => (props: InputDialogProps) => Promise<InputResults>;
|
|
4
|
+
export default useInputDialog;
|
|
5
|
+
export { useInputDialog };
|
|
6
|
+
//# sourceMappingURL=useInputDialog.d.ts.map
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { ShowWindowOptions } from '@sheetxl/utils-react';
|
|
2
|
+
import { InternalWindowProps } from './InternalWindow';
|
|
3
|
+
/**
|
|
4
|
+
* Creates a single instance given the type and import function
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* This relays on the onHide prop working
|
|
8
|
+
*/
|
|
9
|
+
declare function useLazyWindow<P extends InternalWindowProps>(propsDefault?: P): (type: string, importFunc: () => Promise<{
|
|
10
|
+
default: any;
|
|
11
|
+
}>, options: ShowWindowOptions, props?: P) => Promise<HTMLElement | null>;
|
|
12
|
+
export default useLazyWindow;
|
|
13
|
+
export { useLazyWindow };
|
|
14
|
+
//# sourceMappingURL=useLazyWindow.d.ts.map
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { ShowOptionsOptions, OptionInput } from '@sheetxl/utils-react';
|
|
2
|
+
import { InternalWindowProps } from './InternalWindow';
|
|
3
|
+
export interface OptionsDialogProps<T = any, C = any> extends ShowOptionsOptions<T, C>, Omit<InternalWindowProps<T, C>, 'style' | 'onInput' | 'autoFocus' | 'onKeyDown'> {
|
|
4
|
+
}
|
|
5
|
+
declare const useOptionsDialog: (propsDefault?: OptionsDialogProps) => (options: OptionsDialogProps) => Promise<OptionInput>;
|
|
6
|
+
export default useOptionsDialog;
|
|
7
|
+
export { useOptionsDialog };
|
|
8
|
+
//# sourceMappingURL=useOptionsDialog.d.ts.map
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { BoxProps } from '@mui/material';
|
|
3
|
+
import { ExhibitPopupPanelProps } from './ExhibitPopup';
|
|
4
|
+
import { FloatPopperProps, FloatPopperPosition, FloatPanelProps } from '@sheetxl/utils-react';
|
|
5
|
+
/**
|
|
6
|
+
* The MUI floating surface: a {@link FloatPopper} (a positioned portal)
|
|
7
|
+
* wrapping a themed {@link Paper}. This is the surface installed by
|
|
8
|
+
* `ExhibitFloatProvider`; `useFloatStack` renders content into it via its
|
|
9
|
+
* `renderFloatPanel`.
|
|
10
|
+
*
|
|
11
|
+
* Mirrors the neutral {@link FloatPanelProps}, swapping the HTML base for MUI's
|
|
12
|
+
* {@link BoxProps} and re-typing the surface-specific fields
|
|
13
|
+
* (`createPopupPanel`/`propsPopper`/`anchor*`) against the MUI surface.
|
|
14
|
+
*/
|
|
15
|
+
export type ExhibitFloatPanelProps = Omit<FloatPanelProps, keyof React.HTMLAttributes<HTMLDivElement> | 'anchorEl' | 'anchorPosition' | 'createPopupPanel' | 'propsPopper'> & BoxProps & {
|
|
16
|
+
anchorEl?: any;
|
|
17
|
+
anchorPosition?: FloatPopperPosition;
|
|
18
|
+
createPopupPanel?: (props: ExhibitPopupPanelProps) => React.ReactElement<any>;
|
|
19
|
+
propsPopper?: Partial<FloatPopperProps>;
|
|
20
|
+
};
|
|
21
|
+
export declare const ExhibitFloatPanel: React.NamedExoticComponent<Omit<ExhibitFloatPanelProps, "ref"> & React.RefAttributes<any>>;
|
|
22
|
+
//# sourceMappingURL=ExhibitFloatPanel.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FloatProviderProps } from '@sheetxl/utils-react';
|
|
3
|
+
/**
|
|
4
|
+
* A {@link FloatProvider} preconfigured with the MUI floating surface
|
|
5
|
+
* ({@link ExhibitFloatPanel} + the MUI popup-panel default).
|
|
6
|
+
*
|
|
7
|
+
* The MUI surface is required (not just preferred): floats render in a portal,
|
|
8
|
+
* and the neutral `FloatPanel` themes via `--sxl-*` CSS variables which do not
|
|
9
|
+
* reach the portal container, so it renders unthemed there. The MUI `Paper`
|
|
10
|
+
* surface carries the theme into the portal. (See the parked experiment to drop
|
|
11
|
+
* the MUI surface — blocked on CSS-variable propagation into portals.)
|
|
12
|
+
*
|
|
13
|
+
* Mount once near a MUI app root so every float below renders on the MUI
|
|
14
|
+
* surface. Other {@link FloatProviderProps} (e.g. `isolate`) pass through.
|
|
15
|
+
*/
|
|
16
|
+
export declare const ExhibitFloatProvider: (props: Omit<FloatProviderProps, "renderFloatPanel" | "createPopupPanel">) => React.ReactElement;
|
|
17
|
+
//# sourceMappingURL=ExhibitFloatProvider.d.ts.map
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { BoxProps, TooltipProps, IconButtonProps } from '@mui/material';
|
|
3
|
+
import { FloatReference, FloatPopupPanelProps } from '@sheetxl/utils-react';
|
|
4
|
+
import { ExhibitFloatPanelProps } from './ExhibitFloatPanel';
|
|
5
|
+
/**
|
|
6
|
+
* The {@link FloatPopupPanelProps} content fields on the MUI {@link BoxProps}
|
|
7
|
+
* surface (so the default MUI panel can read `sx`/`className`/etc.). We drop the
|
|
8
|
+
* neutral HTML base from `FloatPopupPanelProps` (BoxProps supplies the element
|
|
9
|
+
* props, with incompatible types e.g. `color`) and keep just its content fields.
|
|
10
|
+
*/
|
|
11
|
+
export type ExhibitPopupPanelProps = Omit<FloatPopupPanelProps, keyof React.HTMLAttributes<HTMLDivElement>> & BoxProps;
|
|
12
|
+
export interface ExhibitQuickButtonProps extends IconButtonProps {
|
|
13
|
+
/**
|
|
14
|
+
* Tooltip title. Zero-length titles string are never displayed.
|
|
15
|
+
*/
|
|
16
|
+
tooltip?: NonNullable<React.ReactNode>;
|
|
17
|
+
/**
|
|
18
|
+
* Allows for custom tooltip creation
|
|
19
|
+
*/
|
|
20
|
+
createTooltip?: (props: TooltipProps, disabled: boolean) => React.JSX.Element;
|
|
21
|
+
}
|
|
22
|
+
export declare const PopupAutoFocus: {
|
|
23
|
+
readonly Popup: "popup";
|
|
24
|
+
readonly Anchor: "anchor";
|
|
25
|
+
};
|
|
26
|
+
export type PopupAutoFocus = typeof PopupAutoFocus[keyof typeof PopupAutoFocus];
|
|
27
|
+
export declare const ClosingReason: {
|
|
28
|
+
readonly ByPopup: "popupDone";
|
|
29
|
+
readonly Cancel: "popupCancel";
|
|
30
|
+
readonly ClickAway: "clickAway";
|
|
31
|
+
};
|
|
32
|
+
export type ClosingReason = typeof ClosingReason[keyof typeof ClosingReason];
|
|
33
|
+
export declare const PopupButtonType: {
|
|
34
|
+
/**
|
|
35
|
+
* Suitable for toolbars. Click to open, click to close, generally disabled as icon
|
|
36
|
+
*/
|
|
37
|
+
readonly Toolbar: "toolbar";
|
|
38
|
+
/**
|
|
39
|
+
* Suitable for menus. HoverIn to open, hover leave to close, generally disabled as icon and text
|
|
40
|
+
*/
|
|
41
|
+
readonly Menuitem: "menuitem";
|
|
42
|
+
};
|
|
43
|
+
export type PopupButtonType = typeof PopupButtonType[keyof typeof PopupButtonType];
|
|
44
|
+
/**
|
|
45
|
+
* TODO - allow popper and popup customizations similar to @mui/tooltip
|
|
46
|
+
*/
|
|
47
|
+
export interface ExhibitPopupButtonProps extends BoxProps {
|
|
48
|
+
icon?: React.ReactNode | (() => React.ReactNode);
|
|
49
|
+
label?: React.ReactNode;
|
|
50
|
+
/**
|
|
51
|
+
* Render the `label` as visible button content (alongside any icon / split-toggle checkmark) rather
|
|
52
|
+
* than as tooltip-only. Toolbar (icon) buttons are icon-only by default. Menu items always show the
|
|
53
|
+
* label regardless.
|
|
54
|
+
* @defaultValue false
|
|
55
|
+
*/
|
|
56
|
+
showLabel?: boolean;
|
|
57
|
+
/**
|
|
58
|
+
* Render as selected,
|
|
59
|
+
*/
|
|
60
|
+
selected?: boolean;
|
|
61
|
+
parentFloat?: FloatReference;
|
|
62
|
+
createPopupPanel?: (props: ExhibitPopupPanelProps) => React.ReactElement<any>;
|
|
63
|
+
onPopupOpen?: () => void;
|
|
64
|
+
onPopupClose?: () => void;
|
|
65
|
+
propsPopup?: Partial<ExhibitFloatPanelProps>;
|
|
66
|
+
/**
|
|
67
|
+
* Tooltip title. Zero-length titles string are never displayed.
|
|
68
|
+
*/
|
|
69
|
+
tooltip?: NonNullable<React.ReactNode>;
|
|
70
|
+
/**
|
|
71
|
+
* Allows for custom tooltip creation
|
|
72
|
+
*/
|
|
73
|
+
createTooltip?: (props: TooltipProps, disabled: boolean) => React.JSX.Element;
|
|
74
|
+
/**
|
|
75
|
+
* If this set then the popup becomes a split button.
|
|
76
|
+
*/
|
|
77
|
+
onQuickClick?: (e: React.MouseEvent<Element>) => void;
|
|
78
|
+
propsQuickButton?: ExhibitQuickButtonProps;
|
|
79
|
+
renderQuickButton?: (props: ExhibitQuickButtonProps) => React.ReactNode;
|
|
80
|
+
disabled?: boolean;
|
|
81
|
+
/**
|
|
82
|
+
* If the icon button is a primary icon button.
|
|
83
|
+
* This may change the color of the text and icon.
|
|
84
|
+
* @defaultValue false
|
|
85
|
+
*/
|
|
86
|
+
primary?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* A ripple surface rendered inside the executing (quick) button. Supplied by `CommandPopupButton`
|
|
89
|
+
* via `useManagedRipple` — an always-mounted `TouchRipple` that can flash on any command dispatch
|
|
90
|
+
* (MUI's built-in ripple is lazy-mounted and can't fire for remote executes). When set, the quick
|
|
91
|
+
* button disables its own ripple and hosts this one instead.
|
|
92
|
+
*/
|
|
93
|
+
ripple?: React.ReactNode;
|
|
94
|
+
}
|
|
95
|
+
export declare const defaultCreatePopupPanel: (props: ExhibitPopupPanelProps) => React.ReactElement<any>;
|
|
96
|
+
export declare const createDownArrow: (isSplit: boolean, dense: boolean, rotate: boolean) => React.JSX.Element;
|
|
97
|
+
//# sourceMappingURL=ExhibitPopup.d.ts.map
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { Theme, ThemeOptions, Components, ComponentsProps, ComponentsOverrides, ComponentsVariants, ComponentsPropsList, Interpolation } from '@mui/material';
|
|
2
|
+
export declare const hexToRGB: (hex: string, alpha?: number | null) => string;
|
|
3
|
+
export declare const elevateColor: (color: string, coefficient?: number, mode?: "light" | "dark") => string;
|
|
4
|
+
export declare const overlayAlpha: (elevation: number) => number;
|
|
5
|
+
/**
|
|
6
|
+
* The raised-surface wash — the ONE `backgroundImage` chrome surfaces (toolbar palette, formula
|
|
7
|
+
* bar, name box, border swatches, script panels) use to sit "above" the base background in dark
|
|
8
|
+
* mode; light mode is flat (the borders carry the structure — a white-on-white wash would be
|
|
9
|
+
* invisible anyway). Sized to Material elevation ~2.
|
|
10
|
+
*
|
|
11
|
+
* Resolved through the `--sxl-surface-raised` CSS variable so a host embedding Studio in a FLAT
|
|
12
|
+
* design language (the VS Code extension) can kill the wash everywhere at once: set
|
|
13
|
+
* `--sxl-surface-raised: none` on the document root — portaled popups inherit it too. Without the
|
|
14
|
+
* variable the mode-appropriate fallback applies.
|
|
15
|
+
*
|
|
16
|
+
* Text inputs deliberately do NOT take this wash — fields keep the stock MUI background so custom
|
|
17
|
+
* fields (`InputField`/`FormulaField`) and plain `TextField`s always match side by side.
|
|
18
|
+
*
|
|
19
|
+
* Usage: `sx={{ backgroundImage: raisedSurface }}` (sx resolves the theme callback).
|
|
20
|
+
*/
|
|
21
|
+
export declare const raisedSurfaceAt: (elevation: number) => (theme: Theme) => string;
|
|
22
|
+
export declare const raisedSurface: (theme: Theme) => string;
|
|
23
|
+
/**
|
|
24
|
+
* The same wash at the elevation MUI gives a **popup** (`elevation={8}`).
|
|
25
|
+
*
|
|
26
|
+
* @remarks
|
|
27
|
+
* Rarely needed directly: the `MuiPaper` root override in {@link createExhibitTheme} already routes every
|
|
28
|
+
* Paper's per-elevation wash through `--sxl-surface-raised`. Use this only for a surface that paints its
|
|
29
|
+
* own `background-image` and still wants to match a popup.
|
|
30
|
+
*/
|
|
31
|
+
export declare const elevatedSurface: (theme: Theme) => string;
|
|
32
|
+
export interface SmartInputFieldProps {
|
|
33
|
+
automatic?: any;
|
|
34
|
+
}
|
|
35
|
+
export interface ExhibitComponentPropsList extends ComponentsPropsList {
|
|
36
|
+
SmartInputField?: SmartInputFieldProps;
|
|
37
|
+
}
|
|
38
|
+
export interface ExhibitComponentProps extends ComponentsProps {
|
|
39
|
+
SmartInputField: SmartInputFieldProps;
|
|
40
|
+
}
|
|
41
|
+
export interface ExhibitComponentsOverrides<Theme = unknown> extends ComponentsOverrides<Theme> {
|
|
42
|
+
SmartInputField?: any;
|
|
43
|
+
}
|
|
44
|
+
export interface ExhibitComponentsVariants extends ComponentsVariants {
|
|
45
|
+
SmartInputField?: Array<{
|
|
46
|
+
props: Partial<ExhibitComponentPropsList['SmartInputField']>;
|
|
47
|
+
style: Interpolation<{
|
|
48
|
+
theme: Theme;
|
|
49
|
+
}>;
|
|
50
|
+
}>;
|
|
51
|
+
}
|
|
52
|
+
export interface ExhibitComponents extends Components<Omit<Theme, 'components'>> {
|
|
53
|
+
SmartInputField?: {
|
|
54
|
+
defaultProps?: ExhibitComponentProps['SmartInputField'];
|
|
55
|
+
styleOverrides?: ExhibitComponentsOverrides<Theme>['SmartInputField'];
|
|
56
|
+
variants?: ExhibitComponentsVariants['SmartInputField'];
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
export interface ExhibitThemeOptions extends ThemeOptions {
|
|
60
|
+
components?: ExhibitComponents;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* This creates a Theme that has Exhibit Widget extensions.
|
|
65
|
+
* It is based on the MUI createTheme() function.
|
|
66
|
+
*
|
|
67
|
+
* @see
|
|
68
|
+
* https://mui.com/customization/how-to-customize/#state-classes
|
|
69
|
+
*/
|
|
70
|
+
export declare const createExhibitTheme: (isDark: boolean, customizations?: ExhibitThemeOptions) => Theme;
|
|
71
|
+
//# sourceMappingURL=ExhibitTheme.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DynamicIconProps } from '@sheetxl/utils-react';
|
|
2
|
+
import { Theme } from '@mui/material';
|
|
3
|
+
/**
|
|
4
|
+
* Useful for contrasting colors
|
|
5
|
+
* @param theme - The theme
|
|
6
|
+
*/
|
|
7
|
+
export declare const strokeShadowFilter: (theme: Theme) => string | undefined;
|
|
8
|
+
export declare const createStrokeShadowFilter: (shadowRadius?: number) => (theme: Theme) => string | undefined;
|
|
9
|
+
export declare const ArrowDownIcon: (props: DynamicIconProps) => import("react").JSX.Element;
|
|
10
|
+
export declare const ArrowRightIcon: (props: DynamicIconProps) => import("react").JSX.Element;
|
|
11
|
+
//# sourceMappingURL=IconSupport.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Theme } from '@mui/material';
|
|
2
|
+
export interface ScrollbarThemingOptions {
|
|
3
|
+
track?: string;
|
|
4
|
+
thumb?: string;
|
|
5
|
+
button?: string;
|
|
6
|
+
active?: string;
|
|
7
|
+
corner?: string;
|
|
8
|
+
outline?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export declare function getScrollbarCssVariables(theme: Theme, options?: ScrollbarThemingOptions): Record<string, string>;
|
|
11
|
+
export declare function scrollbarTheming(theme: Theme, options?: ScrollbarThemingOptions): Record<string, any>;
|
|
12
|
+
//# sourceMappingURL=ScrollbarTheming.d.ts.map
|