@sheetxl/utils-react 0.7.21 → 0.7.23-beta.2
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/C7jPCqFJNiWyD2pr.cjs +1 -0
- package/browser/cjs/CyWMySHsu-RvsIGs.cjs +1 -0
- package/browser/cjs/DZSvmqU8nRas1uz6.cjs +1 -0
- package/browser/cjs/index.cjs +5 -7
- package/browser/esm/BlY25fmBdmHNyBqo.mjs +139 -0
- package/browser/esm/CQUN3sZz7IrPMYIa.mjs +2171 -0
- package/browser/esm/DpI3aVOBON4B0xID.mjs +390 -0
- package/browser/esm/index.mjs +6127 -1795
- package/licenses/dependencies.txt +246 -39
- package/node/esm/B8EaqTMia4qMXy5z.mjs +139 -0
- package/node/esm/D9Xo9E4JB3ReeH-J.mjs +2171 -0
- package/node/esm/index.mjs +5140 -1763
- package/package.json +8 -5
- package/types/index.d.ts +2 -1969
- package/types/src/animation/AnimationModeContext.d.ts +10 -0
- package/types/src/animation/AnimationModeContext.d.ts.map +1 -0
- package/types/src/animation/index.d.ts +3 -0
- package/types/src/animation/index.d.ts.map +1 -0
- package/types/src/animation/useAnimatedMeasure.d.ts +39 -0
- package/types/src/animation/useAnimatedMeasure.d.ts.map +1 -0
- package/types/src/command/ActivationTracker.d.ts +53 -0
- package/types/src/command/ActivationTracker.d.ts.map +1 -0
- package/types/src/command/CommandAnchorProvider.d.ts +64 -0
- package/types/src/command/CommandAnchorProvider.d.ts.map +1 -0
- package/types/src/command/CommandButtonEntryLabel.d.ts +25 -0
- package/types/src/command/CommandButtonEntryLabel.d.ts.map +1 -0
- package/types/src/command/CommandButtonRegistry.d.ts +159 -0
- package/types/src/command/CommandButtonRegistry.d.ts.map +1 -0
- package/types/src/command/CommandButtonRegistryContext.d.ts +35 -0
- package/types/src/command/CommandButtonRegistryContext.d.ts.map +1 -0
- package/types/src/command/CommandCatalog.d.ts +155 -0
- package/types/src/command/CommandCatalog.d.ts.map +1 -0
- package/types/src/command/CommandCatalogResource.d.ts +7 -0
- package/types/src/command/CommandCatalogResource.d.ts.map +1 -0
- package/types/src/command/CommandCatalogService.d.ts +61 -0
- package/types/src/command/CommandCatalogService.d.ts.map +1 -0
- package/types/src/command/CommandChainContext.d.ts +32 -0
- package/types/src/command/CommandChainContext.d.ts.map +1 -0
- package/types/src/command/CommandFallbackContext.d.ts +30 -0
- package/types/src/command/CommandFallbackContext.d.ts.map +1 -0
- package/types/src/command/CommandFocusContext.d.ts +21 -0
- package/types/src/command/CommandFocusContext.d.ts.map +1 -0
- package/types/src/command/CommandRegistry.d.ts +164 -0
- package/types/src/command/CommandRegistry.d.ts.map +1 -0
- package/types/src/command/CommandRegistryContext.d.ts +16 -0
- package/types/src/command/CommandRegistryContext.d.ts.map +1 -0
- package/types/src/command/CommandResolver.d.ts +162 -0
- package/types/src/command/CommandResolver.d.ts.map +1 -0
- package/types/src/command/CommandScope.d.ts +343 -0
- package/types/src/command/CommandScope.d.ts.map +1 -0
- package/types/src/command/CommandScopeContext.d.ts +205 -0
- package/types/src/command/CommandScopeContext.d.ts.map +1 -0
- package/types/src/command/FocusActivation.d.ts +140 -0
- package/types/src/command/FocusActivation.d.ts.map +1 -0
- package/types/src/command/ICommand.d.ts +31 -0
- package/types/src/command/ICommand.d.ts.map +1 -0
- package/types/src/command/ICommandDefinition.d.ts +82 -0
- package/types/src/command/ICommandDefinition.d.ts.map +1 -0
- package/types/src/command/KeyBindingDispatcher.d.ts +150 -0
- package/types/src/command/KeyBindingDispatcher.d.ts.map +1 -0
- package/types/src/command/LayerActivation.d.ts +45 -0
- package/types/src/command/LayerActivation.d.ts.map +1 -0
- package/types/src/command/Types.d.ts +80 -0
- package/types/src/command/Types.d.ts.map +1 -0
- package/types/src/command/createResolvedCommand.d.ts +91 -0
- package/types/src/command/createResolvedCommand.d.ts.map +1 -0
- package/types/src/command/index.d.ts +26 -0
- package/types/src/command/index.d.ts.map +1 -0
- package/types/src/command/reduceDefinitions.d.ts +33 -0
- package/types/src/command/reduceDefinitions.d.ts.map +1 -0
- package/types/src/command/useCommands.d.ts +22 -0
- package/types/src/command/useCommands.d.ts.map +1 -0
- package/types/src/command/useContributeCommands.d.ts +18 -0
- package/types/src/command/useContributeCommands.d.ts.map +1 -0
- package/types/src/components/FocusKeyNavigation.d.ts +22 -0
- package/types/src/components/FocusKeyNavigation.d.ts.map +1 -0
- package/types/src/components/ITooltip.d.ts +38 -0
- package/types/src/components/ITooltip.d.ts.map +1 -0
- package/types/src/components/RoundedTab.d.ts +26 -0
- package/types/src/components/RoundedTab.d.ts.map +1 -0
- package/types/src/components/index.d.ts +4 -0
- package/types/src/components/index.d.ts.map +1 -0
- package/types/src/error/ErrorPanel.d.ts +14 -0
- package/types/src/error/ErrorPanel.d.ts.map +1 -0
- package/types/src/error/ReactErrorBoundary.d.ts +7 -0
- package/types/src/error/ReactErrorBoundary.d.ts.map +1 -0
- package/types/src/error/UncaughtErrorBoundary.d.ts +5 -0
- package/types/src/error/UncaughtErrorBoundary.d.ts.map +1 -0
- package/types/src/error/index.d.ts +4 -0
- package/types/src/error/index.d.ts.map +1 -0
- package/types/src/float/FloatPanel.d.ts +57 -0
- package/types/src/float/FloatPanel.d.ts.map +1 -0
- package/types/src/float/FloatPopper.d.ts +85 -0
- package/types/src/float/FloatPopper.d.ts.map +1 -0
- package/types/src/float/FloatPopup.d.ts +19 -0
- package/types/src/float/FloatPopup.d.ts.map +1 -0
- package/types/src/float/FloatProvider.d.ts +60 -0
- package/types/src/float/FloatProvider.d.ts.map +1 -0
- package/types/src/float/FloatStackContext.d.ts +25 -0
- package/types/src/float/FloatStackContext.d.ts.map +1 -0
- package/types/src/float/FloatTooltip.d.ts +22 -0
- package/types/src/float/FloatTooltip.d.ts.map +1 -0
- package/types/src/float/FloatUtils.d.ts +55 -0
- package/types/src/float/FloatUtils.d.ts.map +1 -0
- package/types/src/float/_FloatUtils.d.ts +51 -0
- package/types/src/float/_FloatUtils.d.ts.map +1 -0
- package/types/src/float/index.d.ts +9 -0
- package/types/src/float/index.d.ts.map +1 -0
- package/types/src/float/useFloatStack.d.ts +92 -0
- package/types/src/float/useFloatStack.d.ts.map +1 -0
- package/types/src/hooks/LanguageState.d.ts +15 -0
- package/types/src/hooks/LanguageState.d.ts.map +1 -0
- package/types/src/hooks/index.d.ts +19 -0
- package/types/src/hooks/index.d.ts.map +1 -0
- package/types/src/hooks/useBoundSyncExternalStore.d.ts +23 -0
- package/types/src/hooks/useBoundSyncExternalStore.d.ts.map +1 -0
- package/types/src/hooks/useCallbackRef.d.ts +11 -0
- package/types/src/hooks/useCallbackRef.d.ts.map +1 -0
- package/types/src/hooks/useDevicePixelRatio.d.ts +37 -0
- package/types/src/hooks/useDevicePixelRatio.d.ts.map +1 -0
- package/types/src/hooks/useEditMode.d.ts +66 -0
- package/types/src/hooks/useEditMode.d.ts.map +1 -0
- package/types/src/hooks/useGlobalClipboard.d.ts +7 -0
- package/types/src/hooks/useGlobalClipboard.d.ts.map +1 -0
- package/types/src/hooks/useId.d.ts +9 -0
- package/types/src/hooks/useId.d.ts.map +1 -0
- package/types/src/hooks/useImperativeElement.d.ts +3 -0
- package/types/src/hooks/useImperativeElement.d.ts.map +1 -0
- package/types/src/hooks/useLanguage.d.ts +13 -0
- package/types/src/hooks/useLanguage.d.ts.map +1 -0
- package/types/src/hooks/useMouseDownAndHoldListener.d.ts +13 -0
- package/types/src/hooks/useMouseDownAndHoldListener.d.ts.map +1 -0
- package/types/src/hooks/useNotifier.d.ts +330 -0
- package/types/src/hooks/useNotifier.d.ts.map +1 -0
- package/types/src/hooks/useOnClickOrFocusAway.d.ts +8 -0
- package/types/src/hooks/useOnClickOrFocusAway.d.ts.map +1 -0
- package/types/src/hooks/useOptionalBoundSyncExternalStore.d.ts +20 -0
- package/types/src/hooks/useOptionalBoundSyncExternalStore.d.ts.map +1 -0
- package/types/src/hooks/useOptionalSyncExternalStore.d.ts +18 -0
- package/types/src/hooks/useOptionalSyncExternalStore.d.ts.map +1 -0
- package/types/src/hooks/useSynchronizedPointerHandler.d.ts +54 -0
- package/types/src/hooks/useSynchronizedPointerHandler.d.ts.map +1 -0
- package/types/src/hooks/useTextareaCaretRect.d.ts +85 -0
- package/types/src/hooks/useTextareaCaretRect.d.ts.map +1 -0
- package/types/src/hooks/useTraceUpdate.d.ts +2 -0
- package/types/src/hooks/useTraceUpdate.d.ts.map +1 -0
- package/types/src/hooks/useTranslator.d.ts +32 -0
- package/types/src/hooks/useTranslator.d.ts.map +1 -0
- package/types/src/icons/DynamicIcon.d.ts +17 -0
- package/types/src/icons/DynamicIcon.d.ts.map +1 -0
- package/types/src/icons/DynamicIconService.d.ts +39 -0
- package/types/src/icons/DynamicIconService.d.ts.map +1 -0
- package/types/src/icons/ErrorIcon.d.ts +6 -0
- package/types/src/icons/ErrorIcon.d.ts.map +1 -0
- package/types/src/icons/Types.d.ts +81 -0
- package/types/src/icons/Types.d.ts.map +1 -0
- package/types/src/icons/WalkingIcon.d.ts +27 -0
- package/types/src/icons/WalkingIcon.d.ts.map +1 -0
- package/types/src/icons/_Utils.d.ts +3 -0
- package/types/src/icons/_Utils.d.ts.map +1 -0
- package/types/src/icons/index.d.ts +5 -0
- package/types/src/icons/index.d.ts.map +1 -0
- package/types/src/icons/packs/Base.d.ts +4 -0
- package/types/src/icons/packs/Base.d.ts.map +1 -0
- package/types/src/icons/packs/Conditional.d.ts +4 -0
- package/types/src/icons/packs/Conditional.d.ts.map +1 -0
- package/types/src/index.d.ts +18 -0
- package/types/src/index.d.ts.map +1 -0
- package/types/src/loading/LoadingPanel.d.ts +31 -0
- package/types/src/loading/LoadingPanel.d.ts.map +1 -0
- package/types/src/loading/index.d.ts +2 -0
- package/types/src/loading/index.d.ts.map +1 -0
- package/types/src/persistence/InMemoryStore.d.ts +12 -0
- package/types/src/persistence/InMemoryStore.d.ts.map +1 -0
- package/types/src/persistence/LocalStorageStore.d.ts +15 -0
- package/types/src/persistence/LocalStorageStore.d.ts.map +1 -0
- package/types/src/persistence/PersistenceStateProvider.d.ts +3 -0
- package/types/src/persistence/PersistenceStateProvider.d.ts.map +1 -0
- package/types/src/persistence/Types.d.ts +95 -0
- package/types/src/persistence/Types.d.ts.map +1 -0
- package/types/src/persistence/_Context.d.ts +9 -0
- package/types/src/persistence/_Context.d.ts.map +1 -0
- package/types/src/persistence/index.d.ts +6 -0
- package/types/src/persistence/index.d.ts.map +1 -0
- package/types/src/persistence/usePersistenceState.d.ts +33 -0
- package/types/src/persistence/usePersistenceState.d.ts.map +1 -0
- package/types/src/react-resizable/Resizable.d.ts +30 -0
- package/types/src/react-resizable/Resizable.d.ts.map +1 -0
- package/types/src/react-resizable/ResizableBox.d.ts +18 -0
- package/types/src/react-resizable/ResizableBox.d.ts.map +1 -0
- package/types/src/react-resizable/index.d.ts +11 -0
- package/types/src/react-resizable/index.d.ts.map +1 -0
- package/types/src/react-resizable/propTypes.d.ts +56 -0
- package/types/src/react-resizable/propTypes.d.ts.map +1 -0
- package/types/src/react-resizable/utils.d.ts +3 -0
- package/types/src/react-resizable/utils.d.ts.map +1 -0
- package/types/src/scroll/AxisViewport.d.ts +73 -0
- package/types/src/scroll/AxisViewport.d.ts.map +1 -0
- package/types/src/scroll/IScrollPane.d.ts +63 -0
- package/types/src/scroll/IScrollPane.d.ts.map +1 -0
- package/types/src/scroll/IScrollbar.d.ts +94 -0
- package/types/src/scroll/IScrollbar.d.ts.map +1 -0
- package/types/src/scroll/NativeScrollbar.d.ts +7 -0
- package/types/src/scroll/NativeScrollbar.d.ts.map +1 -0
- package/types/src/scroll/ScrollButton.d.ts +29 -0
- package/types/src/scroll/ScrollButton.d.ts.map +1 -0
- package/types/src/scroll/ScrollPane.d.ts +4 -0
- package/types/src/scroll/ScrollPane.d.ts.map +1 -0
- package/types/src/scroll/Scrollbar.d.ts +4 -0
- package/types/src/scroll/Scrollbar.d.ts.map +1 -0
- package/types/src/scroll/TouchThumbContext.d.ts +93 -0
- package/types/src/scroll/TouchThumbContext.d.ts.map +1 -0
- package/types/src/scroll/TouchThumbHandle.d.ts +64 -0
- package/types/src/scroll/TouchThumbHandle.d.ts.map +1 -0
- package/types/src/scroll/TrackDrag.d.ts +107 -0
- package/types/src/scroll/TrackDrag.d.ts.map +1 -0
- package/types/src/scroll/Utils.d.ts +8 -0
- package/types/src/scroll/Utils.d.ts.map +1 -0
- package/types/src/scroll/Viewport.d.ts +285 -0
- package/types/src/scroll/Viewport.d.ts.map +1 -0
- package/types/src/scroll/VirtualScrollbar.d.ts +49 -0
- package/types/src/scroll/VirtualScrollbar.d.ts.map +1 -0
- package/types/src/scroll/index.d.ts +14 -0
- package/types/src/scroll/index.d.ts.map +1 -0
- package/types/src/scroll/scrollbarTheming.d.ts +27 -0
- package/types/src/scroll/scrollbarTheming.d.ts.map +1 -0
- package/types/src/scroll/useWheelScroll.d.ts +27 -0
- package/types/src/scroll/useWheelScroll.d.ts.map +1 -0
- package/types/src/scroller/Scroller.d.ts +260 -0
- package/types/src/scroller/Scroller.d.ts.map +1 -0
- package/types/src/scroller/animate.d.ts +30 -0
- package/types/src/scroller/animate.d.ts.map +1 -0
- package/types/src/scroller/index.d.ts +2 -0
- package/types/src/scroller/index.d.ts.map +1 -0
- package/types/src/singletonHook/components/SingleItemContainer.d.ts +6 -0
- package/types/src/singletonHook/components/SingleItemContainer.d.ts.map +1 -0
- package/types/src/singletonHook/components/SingletonHooksContainer.d.ts +7 -0
- package/types/src/singletonHook/components/SingletonHooksContainer.d.ts.map +1 -0
- package/types/src/singletonHook/index.d.ts +11 -0
- package/types/src/singletonHook/index.d.ts.map +1 -0
- package/types/src/singletonHook/singletonHook.d.ts +6 -0
- package/types/src/singletonHook/singletonHook.d.ts.map +1 -0
- package/types/src/singletonHook/utils/env.d.ts +4 -0
- package/types/src/singletonHook/utils/env.d.ts.map +1 -0
- package/types/src/singletonHook/utils/env.native.d.ts +1 -0
- package/types/src/singletonHook/utils/env.native.d.ts.map +1 -0
- package/types/src/singletonHook/utils/warning.d.ts +2 -0
- package/types/src/singletonHook/utils/warning.d.ts.map +1 -0
- package/types/src/splitPane/SplitPane.d.ts +91 -0
- package/types/src/splitPane/SplitPane.d.ts.map +1 -0
- package/types/src/splitPane/SplitPaneResizer.d.ts +11 -0
- package/types/src/splitPane/SplitPaneResizer.d.ts.map +1 -0
- package/types/src/splitPane/index.d.ts +3 -0
- package/types/src/splitPane/index.d.ts.map +1 -0
- package/types/src/theme/TokenTheme.d.ts +196 -0
- package/types/src/theme/TokenTheme.d.ts.map +1 -0
- package/types/src/theme/TokenThemeProvider.d.ts +97 -0
- package/types/src/theme/TokenThemeProvider.d.ts.map +1 -0
- package/types/src/theme/buildThemeCSS.d.ts +54 -0
- package/types/src/theme/buildThemeCSS.d.ts.map +1 -0
- package/types/src/theme/createThemeVars.d.ts +15 -0
- package/types/src/theme/createThemeVars.d.ts.map +1 -0
- package/types/src/theme/defaultTheme.d.ts +15 -0
- package/types/src/theme/defaultTheme.d.ts.map +1 -0
- package/types/src/theme/index.d.ts +9 -0
- package/types/src/theme/index.d.ts.map +1 -0
- package/types/src/theme/resolveTokens.d.ts +21 -0
- package/types/src/theme/resolveTokens.d.ts.map +1 -0
- package/types/src/theme/themeAttrs.d.ts +32 -0
- package/types/src/theme/themeAttrs.d.ts.map +1 -0
- package/types/src/theme/useResolvedThemeMode.d.ts +17 -0
- package/types/src/theme/useResolvedThemeMode.d.ts.map +1 -0
- package/types/src/types/Types.d.ts +71 -0
- package/types/src/types/Types.d.ts.map +1 -0
- package/types/src/types/index.d.ts +2 -0
- package/types/src/types/index.d.ts.map +1 -0
- package/types/src/utils/FullScreenPortal.d.ts +6 -0
- package/types/src/utils/FullScreenPortal.d.ts.map +1 -0
- package/types/src/utils/PinchZoom.d.ts +3 -0
- package/types/src/utils/PinchZoom.d.ts.map +1 -0
- package/types/src/utils/ReactUtils.d.ts +134 -0
- package/types/src/utils/ReactUtils.d.ts.map +1 -0
- package/types/src/utils/index.d.ts +4 -0
- package/types/src/utils/index.d.ts.map +1 -0
- package/types/src/utils/useFullScreen.d.ts +47 -0
- package/types/src/utils/useFullScreen.d.ts.map +1 -0
- package/browser/cjs/BA9O-cekHrH5qrOm.cjs +0 -6
- package/browser/esm/DTq8GPy7DLZm2D6S.mjs +0 -12
- package/node/assets/style.css +0 -1
- package/node/esm/4mSSJ5fhNdMhHCE6.mjs +0 -12
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { IKeyStroke } from '../types';
|
|
2
|
+
import { ICommand } from './ICommand';
|
|
3
|
+
import { ReducedDefinition } from './reduceDefinitions';
|
|
4
|
+
/**
|
|
5
|
+
* The action a command runs. **`ARGS` is the per-invocation input** (`execute(args)`) —
|
|
6
|
+
* deliberately a *separate* type from `STATE` (the current model value the command
|
|
7
|
+
* *reflects*, read via `getState()`). They flow in opposite directions — `STATE` is output
|
|
8
|
+
* (command → UI, for display/enablement), `args` is input (UI → command) — and only
|
|
9
|
+
* coincidentally share a type (a font picker is `STATE = string` *and* `ARGS = string`). A
|
|
10
|
+
* toggle is `STATE = boolean, ARGS = void` (it just toggles). See design/COMMAND-DESIGN.md
|
|
11
|
+
* "arg vs state".
|
|
12
|
+
*/
|
|
13
|
+
export interface CommandCallback<STATE = any, CONTEXT = any, ARGS = void> {
|
|
14
|
+
(args?: ARGS, command?: ResolvedCommand<STATE, CONTEXT, ARGS>): void | boolean | Promise<void | boolean>;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Dispatch **middleware** registered on a scope via `CommandScope.use`. Onion-style: it
|
|
18
|
+
* receives the `next` callback and returns a wrapping callback, so the contributor's inner
|
|
19
|
+
* callback stays *pure* while cross-cutting infra (transaction batching / busy / edit-mode)
|
|
20
|
+
* lives in the wrapper. **Bound to the scope that authors the
|
|
21
|
+
* callback — not inherited** down the tree (see design/COMMAND-DESIGN.md "Dispatch middleware").
|
|
22
|
+
* First-registered is outermost. `next` (and `command`) carry through so a layer can read
|
|
23
|
+
* `command.getLabel()` etc.
|
|
24
|
+
*/
|
|
25
|
+
export type CommandMiddleware<STATE = any, CONTEXT = any, ARGS = void> = (next: CommandCallback<STATE, CONTEXT, ARGS>) => CommandCallback<STATE, CONTEXT, ARGS>;
|
|
26
|
+
/**
|
|
27
|
+
* The **read** surface of a resolved command — the *derived*, immutable view that
|
|
28
|
+
* `CommandButton`/toolbars/menus consume. Deliberately the read subset of the retired
|
|
29
|
+
* mutable `ICommand` interface (same `getLabel`/`getIcon`/`getShortcut`/`disabled`/`execute`
|
|
30
|
+
* signatures) so consumers didn't change during the port — the **one-sided-change**
|
|
31
|
+
* invariant (see design/COMMAND-DESIGN.md). The *authoring* side (mutation, listeners) is
|
|
32
|
+
* gone: you contribute {@link ICommandDefinition}s and re-derive, you don't mutate.
|
|
33
|
+
*
|
|
34
|
+
* Adds `disabledReasons()`; `disabled()` is derived from it (+ "no callback") for compat.
|
|
35
|
+
* Carries `contributedBy` for cascade introspection. `ARGS` (the `execute` payload) is split
|
|
36
|
+
* from `STATE` (the value the command reflects) — see {@link CommandCallback}.
|
|
37
|
+
*/
|
|
38
|
+
export interface ResolvedCommand<STATE = any, CONTEXT = any, ARGS = void> {
|
|
39
|
+
getKey(): string;
|
|
40
|
+
/**
|
|
41
|
+
* @param groupKey Where the command is being rendered (the parent panel/group key, e.g.
|
|
42
|
+
* `'contextMenu'`, `'cellStyle'`) — selects the matching `groupLabels` variant. Omit for
|
|
43
|
+
* the full label. This is the ONLY per-call flavor: dynamic (function) values evaluate
|
|
44
|
+
* against the definition's own `context` (where the model data lives), never a caller's.
|
|
45
|
+
*/
|
|
46
|
+
getLabel(groupKey?: string): string;
|
|
47
|
+
/** `groupKey` selects a pack's `desc@<groupKey>` variant, if any (no inline scoped field yet). */
|
|
48
|
+
getDescription(groupKey?: string): string;
|
|
49
|
+
getTags(): string[];
|
|
50
|
+
/** `groupKey` is accepted for signature symmetry — reserved for scoped icons. */
|
|
51
|
+
getIcon(groupKey?: string): React.ReactElement | string;
|
|
52
|
+
getShortcut(): IKeyStroke | readonly IKeyStroke[] | null;
|
|
53
|
+
/** The current model value the command reflects (output, for display/enablement). */
|
|
54
|
+
getState(): STATE;
|
|
55
|
+
getContext(): CONTEXT;
|
|
56
|
+
getTarget(): ICommand.ITarget;
|
|
57
|
+
/** Reasons the command is unavailable (empty when available). */
|
|
58
|
+
disabledReasons(): string[];
|
|
59
|
+
/** Derived: disabled if any reason is present OR there is no callback. */
|
|
60
|
+
disabled(): boolean;
|
|
61
|
+
/**
|
|
62
|
+
* **Dispatch** the command: fire the per-key {@link ExecuteHook}s (the registry injects a
|
|
63
|
+
* live accessor at creation) then run the callback. disabled / no-callback /
|
|
64
|
+
* `beforeExecute`-returns-false ⇒ `false`. This is what buttons and keystrokes call
|
|
65
|
+
* directly — it's the ripple/close path, no separate registry call needed. `args` is the
|
|
66
|
+
* per-invocation input (`ARGS`), distinct from `getState()`.
|
|
67
|
+
*/
|
|
68
|
+
execute(args?: ARGS): Promise<boolean>;
|
|
69
|
+
/** Cascade introspection: property name → contribution index that supplied it. */
|
|
70
|
+
readonly contributedBy: Readonly<Record<string, number>>;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Observe/intercept command execution. Registered on the registry **per command key** —
|
|
74
|
+
* because resolved commands are re-derived, the stable anchor is the registry, not the
|
|
75
|
+
* instance. Executions route through the registry, so this fires for keystrokes, clicks,
|
|
76
|
+
* and programmatic calls alike (the ripple/close + middleware path). `beforeExecute`
|
|
77
|
+
* returning `false` cancels. `args` is the invocation input (`ARGS`).
|
|
78
|
+
*/
|
|
79
|
+
export interface ExecuteHook<STATE = any, CONTEXT = any, ARGS = void> {
|
|
80
|
+
beforeExecute?(command: ResolvedCommand<STATE, CONTEXT, ARGS>, args?: ARGS): boolean | void | Promise<boolean | void>;
|
|
81
|
+
onExecute?(command: ResolvedCommand<STATE, CONTEXT, ARGS>, args?: ARGS): void;
|
|
82
|
+
onError?(command: ResolvedCommand<STATE, CONTEXT, ARGS>, error: unknown, args?: ARGS): void;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Build the read-only {@link ResolvedCommand} from a {@link ReducedDefinition}. Pure: the
|
|
86
|
+
* same reduction always yields the same command. Re-derivation (not mutation) is how the
|
|
87
|
+
* command "changes" — the registry re-reduces and re-creates when contributions or the
|
|
88
|
+
* active scope change.
|
|
89
|
+
*/
|
|
90
|
+
export declare function createResolvedCommand<STATE = any, CONTEXT = any, ARGS = void>(reduced: ReducedDefinition<STATE, CONTEXT, ARGS>, getExecuteHooks?: () => Iterable<ExecuteHook<any, any, any>> | undefined): ResolvedCommand<STATE, CONTEXT, ARGS>;
|
|
91
|
+
//# sourceMappingURL=createResolvedCommand.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createResolvedCommand.d.ts","sourceRoot":"","sources":["../../../../src/command/createResolvedCommand.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAItE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC;CAC1G;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI,IACnE,CAAC,IAAI,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAEzF;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IACtE,MAAM,IAAI,MAAM,CAAC;IACjB;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,kGAAkG;IAClG,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1C,OAAO,IAAI,MAAM,EAAE,CAAC;IACpB,iFAAiF;IACjF,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC;IACxD,WAAW,IAAI,UAAU,GAAG,SAAS,UAAU,EAAE,GAAG,IAAI,CAAC;IACzD,qFAAqF;IACrF,QAAQ,IAAI,KAAK,CAAC;IAClB,UAAU,IAAI,OAAO,CAAC;IACtB,SAAS,IAAI,QAAQ,CAAC,OAAO,CAAC;IAC9B,iEAAiE;IACjE,eAAe,IAAI,MAAM,EAAE,CAAC;IAC5B,0EAA0E;IAC1E,QAAQ,IAAI,OAAO,CAAC;IACpB;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,kFAAkF;IAClF,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC1D;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IAClE,aAAa,CAAC,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACtH,SAAS,CAAC,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC9E,OAAO,CAAC,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CAC7F;AAaD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI,EAC3E,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAEhD,eAAe,CAAC,EAAE,MAAM,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,GACvE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAwEvC"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
export * from './ICommand';
|
|
2
|
+
export * from './Types';
|
|
3
|
+
export * from './CommandButtonRegistry';
|
|
4
|
+
export * from './CommandButtonRegistryContext';
|
|
5
|
+
export * from './CommandButtonEntryLabel';
|
|
6
|
+
export * from './ICommandDefinition';
|
|
7
|
+
export * from './reduceDefinitions';
|
|
8
|
+
export * from './createResolvedCommand';
|
|
9
|
+
export * from './CommandCatalog';
|
|
10
|
+
export * from './CommandCatalogService';
|
|
11
|
+
export * from './CommandRegistry';
|
|
12
|
+
export * from './CommandRegistryContext';
|
|
13
|
+
export * from './CommandScope';
|
|
14
|
+
export * from './ActivationTracker';
|
|
15
|
+
export * from './FocusActivation';
|
|
16
|
+
export * from './LayerActivation';
|
|
17
|
+
export * from './CommandResolver';
|
|
18
|
+
export * from './KeyBindingDispatcher';
|
|
19
|
+
export * from './CommandScopeContext';
|
|
20
|
+
export * from './CommandChainContext';
|
|
21
|
+
export * from './CommandAnchorProvider';
|
|
22
|
+
export * from './CommandFallbackContext';
|
|
23
|
+
export * from './CommandFocusContext';
|
|
24
|
+
export * from './useCommands';
|
|
25
|
+
export * from './useContributeCommands';
|
|
26
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/command/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2BAA2B,CAAC;AAE1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { ICommandDefinition } from './ICommandDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* The result of reducing an ordered (**least → most specific**) list of
|
|
4
|
+
* {@link ICommandDefinition} for a single key.
|
|
5
|
+
*
|
|
6
|
+
* Merge rule: **override** for every property (the most-specific contribution wins),
|
|
7
|
+
* **except the {@link ACCUMULATE} fields** (`disabledReasons`, `tags`) which **accumulate**
|
|
8
|
+
* — concatenated, most-specific first — so reasons/tags from different scopes stack instead
|
|
9
|
+
* of clobbering. (Atomic handling of `shortcut` is still a deferred cleanup; see
|
|
10
|
+
* design/COMMAND-DESIGN.md.)
|
|
11
|
+
*
|
|
12
|
+
* `contributedBy` records which contribution index supplied each property — the cascade
|
|
13
|
+
* **introspection** hook (the "CSS devtools" requirement) that keeps the cascade debuggable.
|
|
14
|
+
*/
|
|
15
|
+
/** Fields that **accumulate** (concat) across the chain instead of overriding. */
|
|
16
|
+
export declare const ACCUMULATE: ReadonlySet<string>;
|
|
17
|
+
export interface ReducedDefinition<STATE = any, CONTEXT = any, ARGS = void> {
|
|
18
|
+
key: string;
|
|
19
|
+
/** The winning (most-specific) value for each contributed property. */
|
|
20
|
+
props: Partial<ICommandDefinition<STATE, CONTEXT, ARGS>>;
|
|
21
|
+
/** property name → index (in `defs`) of the contribution that supplied it. */
|
|
22
|
+
contributedBy: Record<string, number>;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Reduce all contributions for ONE command key into a {@link ReducedDefinition}.
|
|
26
|
+
* The heart of "reduce up the chain": the registry calls this with the contributions
|
|
27
|
+
* gathered along the active scope chain, ordered **least → most specific**.
|
|
28
|
+
*
|
|
29
|
+
* Cross-scope reduction lives here; within-scope merging (successive `updateCommand` calls
|
|
30
|
+
* on one provider) happens before this, so each `defs` entry is one scope's merged value.
|
|
31
|
+
*/
|
|
32
|
+
export declare function reduceDefinitions<STATE = any, CONTEXT = any, ARGS = void>(key: string, defs: readonly ICommandDefinition<STATE, CONTEXT, ARGS>[]): ReducedDefinition<STATE, CONTEXT, ARGS>;
|
|
33
|
+
//# sourceMappingURL=reduceDefinitions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reduceDefinitions.d.ts","sourceRoot":"","sources":["../../../../src/command/reduceDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;;;;;;;;;;;GAYG;AACH,kFAAkF;AAClF,eAAO,MAAM,UAAU,EAAE,WAAW,CAAC,MAAM,CAAwC,CAAC;AAEpF,MAAM,WAAW,iBAAiB,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI;IACxE,GAAG,EAAE,MAAM,CAAC;IACZ,uEAAuE;IACvE,KAAK,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACzD,8EAA8E;IAC9E,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI,EACvE,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,SAAS,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,GACxD,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CA2BzC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { ResolvedCommand, ExecuteHook } from './createResolvedCommand';
|
|
2
|
+
/**
|
|
3
|
+
* Per-key execute observation (ripple/close). `onExecute` fires for every dispatch of the
|
|
4
|
+
* command — `cmd.execute()`, a sibling, or a keystroke.
|
|
5
|
+
*/
|
|
6
|
+
export interface UseCommandsListener<STATE = any, CONTEXT = any, ARGS = any> extends ExecuteHook<STATE, CONTEXT, ARGS> {
|
|
7
|
+
/**
|
|
8
|
+
* Not invoked. The resolver already re-renders subscribers on any command property change
|
|
9
|
+
* (via its version); this member is retained for source compatibility only.
|
|
10
|
+
* @deprecated Rely on the re-render instead.
|
|
11
|
+
*/
|
|
12
|
+
onChange?(command: ResolvedCommand<STATE, CONTEXT, ARGS>): void;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Subscribe to one or more commands by key, resolved by the nearest container's
|
|
16
|
+
* {@link CommandResolver} (its anchor + cadence — set by {@link CommandAnchorProvider}, not
|
|
17
|
+
* here). Returns the **resolved** commands (re-rendering when the resolver re-emits), and
|
|
18
|
+
* wires `listener` for per-key execute observation (ripple/close), which fires **immediately**
|
|
19
|
+
* for every dispatch path. A button just calls `cmd.execute()`.
|
|
20
|
+
*/
|
|
21
|
+
export declare function useCommands<STATE = any, CONTEXT = any, ARGS = any>(commandIds: string | readonly string[], listener?: UseCommandsListener<STATE, CONTEXT, ARGS>): Array<ResolvedCommand<STATE, CONTEXT, ARGS> | undefined>;
|
|
22
|
+
//# sourceMappingURL=useCommands.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useCommands.d.ts","sourceRoot":"","sources":["../../../../src/command/useCommands.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,GAAG,CACzE,SAAQ,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC;IACzC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC;CACjE;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,GAAG,GAAG,EAChE,UAAU,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,EACtC,QAAQ,CAAC,EAAE,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GACnD,KAAK,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,SAAS,CAAC,CAuF1D"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { ICommandDefinition } from './ICommandDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Contribute a set of command definitions onto the **current (ambient) scope** for the lifetime of
|
|
4
|
+
* the calling component, removing them on unmount. The generic "drop a contributor" primitive (the
|
|
5
|
+
* model→scope adapter, design/COMMAND-DESIGN.md): a feature builds its definitions — chrome +
|
|
6
|
+
* callbacks bound to its live model — and hands them here; the **placement rule** decides which
|
|
7
|
+
* scope is ambient (e.g. a grid pane scope provided by `wrapPane`).
|
|
8
|
+
*
|
|
9
|
+
* @remarks
|
|
10
|
+
* Decoupled from any visual layer: a contributor is a **sibling that writes** to the shared scope,
|
|
11
|
+
* not a wrapper. Pass a **stable** `definitions` reference (memoize on the model) — a fresh array
|
|
12
|
+
* each render re-contributes. No-ops when there is no ambient scope (graceful when the grid isn't
|
|
13
|
+
* running commands).
|
|
14
|
+
*
|
|
15
|
+
* @param definitions The (callback-bearing) definitions to contribute. Memoize by the model.
|
|
16
|
+
*/
|
|
17
|
+
export declare function useContributeCommands(definitions: readonly ICommandDefinition[]): void;
|
|
18
|
+
//# sourceMappingURL=useContributeCommands.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useContributeCommands.d.ts","sourceRoot":"","sources":["../../../../src/command/useContributeCommands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAG/D;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,SAAS,kBAAkB,EAAE,GAAG,IAAI,CAYtF"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { Direction } from '@sheetxl/utils';
|
|
3
|
+
export interface FocusKeyNavigationProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
refFocusStart?: React.RefObject<HTMLElement>;
|
|
5
|
+
/**
|
|
6
|
+
* If tab and all tabIndices are the same which direction should the tab scan. Note - shift tab will go the opposite direction
|
|
7
|
+
*/
|
|
8
|
+
tabForward?: Direction;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Wrap around a div to allow. This will navigate through enabled divs with tabindex (but only one level deep)
|
|
12
|
+
* It uses the current layout to determine navigation
|
|
13
|
+
* TODO - we need to find an
|
|
14
|
+
* tab/shift-tab navigation
|
|
15
|
+
* arrow key navigation
|
|
16
|
+
*
|
|
17
|
+
* another option is to use rowindex/columnIndex attributes?
|
|
18
|
+
*
|
|
19
|
+
* default direction (for tab)
|
|
20
|
+
*/
|
|
21
|
+
export declare const FocusKeyNavigation: React.FC<FocusKeyNavigationProps>;
|
|
22
|
+
//# sourceMappingURL=FocusKeyNavigation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FocusKeyNavigation.d.ts","sourceRoot":"","sources":["../../../../src/components/FocusKeyNavigation.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,WAAW,uBAAwB,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IACnF,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;CAGxB;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAoD9D,CAAC"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export declare const ToolTipPlacement: {
|
|
3
|
+
readonly BottomEnd: "bottom-end";
|
|
4
|
+
readonly BottomStart: "bottom-start";
|
|
5
|
+
readonly Bottom: "bottom";
|
|
6
|
+
readonly LeftEnd: "left-end";
|
|
7
|
+
readonly LeftStart: "left-start";
|
|
8
|
+
readonly Left: "left";
|
|
9
|
+
readonly RightEnd: "right-end";
|
|
10
|
+
readonly RightStart: "right-start";
|
|
11
|
+
readonly Right: "right";
|
|
12
|
+
readonly TopEnd: "top-end";
|
|
13
|
+
readonly TopStart: "top-start";
|
|
14
|
+
readonly Top: "top";
|
|
15
|
+
};
|
|
16
|
+
export type ToolTipPlacement = typeof ToolTipPlacement[keyof typeof ToolTipPlacement];
|
|
17
|
+
export interface IShowToolTipProperties {
|
|
18
|
+
/**
|
|
19
|
+
* The anchor for the tooltip. x,y are required
|
|
20
|
+
* but width and height can also be provided.
|
|
21
|
+
*/
|
|
22
|
+
anchor: {
|
|
23
|
+
x: number;
|
|
24
|
+
y: number;
|
|
25
|
+
width?: number;
|
|
26
|
+
height?: number;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* The value to display. This is either a string or a react element
|
|
30
|
+
*/
|
|
31
|
+
display?: string | React.ReactElement;
|
|
32
|
+
/**
|
|
33
|
+
* Purely suggestion only
|
|
34
|
+
* If not specified then the consumer will determine
|
|
35
|
+
*/
|
|
36
|
+
placement?: ToolTipPlacement;
|
|
37
|
+
}
|
|
38
|
+
//# sourceMappingURL=ITooltip.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ITooltip.d.ts","sourceRoot":"","sources":["../../../../src/components/ITooltip.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;CAanB,CAAC;AACX,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEtF,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,EAAE;QACN,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IAEF;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IAEtC;;;OAGG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export interface RoundedTabProps extends React.HTMLAttributes<HTMLElement> {
|
|
3
|
+
radius?: number;
|
|
4
|
+
strokeWidth?: number;
|
|
5
|
+
strokeColor?: string;
|
|
6
|
+
/**
|
|
7
|
+
* The clip applied to the child (which also shapes any ripple drawn inside it).
|
|
8
|
+
* - `'tab'` — the inverted, open-top tab outline (Excel/Chrome style).
|
|
9
|
+
* - `'rounded'` — a plain rounded rectangle, optionally inset via {@link clipInset}
|
|
10
|
+
* so it can match an inset "pill" background.
|
|
11
|
+
* @defaultValue 'tab'
|
|
12
|
+
*/
|
|
13
|
+
variant?: 'tab' | 'rounded';
|
|
14
|
+
/**
|
|
15
|
+
* Inset (px) of the `'rounded'` clip from each edge of the container. Lets the clip
|
|
16
|
+
* line up with an inset pill so a ripple stays within the pill.
|
|
17
|
+
*/
|
|
18
|
+
clipInset?: {
|
|
19
|
+
top?: number;
|
|
20
|
+
right?: number;
|
|
21
|
+
bottom?: number;
|
|
22
|
+
left?: number;
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
export declare const RoundedTab: React.FC<RoundedTabProps>;
|
|
26
|
+
//# sourceMappingURL=RoundedTab.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RoundedTab.d.ts","sourceRoot":"","sources":["../../../../src/components/RoundedTab.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAsL/B,MAAM,WAAW,eAAgB,SAAQ,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;IACxE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAE9E;AAED,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAsH9C,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAE3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Props for an Error Panel
|
|
3
|
+
*/
|
|
4
|
+
export interface ErrorPanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
5
|
+
/**
|
|
6
|
+
* The error to show
|
|
7
|
+
*/
|
|
8
|
+
error: any;
|
|
9
|
+
/**
|
|
10
|
+
* Ref to the element.
|
|
11
|
+
*/
|
|
12
|
+
ref?: React.Ref<HTMLDivElement>;
|
|
13
|
+
}
|
|
14
|
+
//# sourceMappingURL=ErrorPanel.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ErrorPanel.d.ts","sourceRoot":"","sources":["../../../../src/error/ErrorPanel.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IAC3E;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;IACX;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;CACjC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export declare const ReactErrorBoundary: React.FC<{
|
|
3
|
+
children: React.ReactNode;
|
|
4
|
+
/** Rendered while the children are throwing. @defaultValue `null` */
|
|
5
|
+
fallback?: React.ReactNode;
|
|
6
|
+
}>;
|
|
7
|
+
//# sourceMappingURL=ReactErrorBoundary.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ReactErrorBoundary.d.ts","sourceRoot":"","sources":["../../../../src/error/ReactErrorBoundary.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AA+D/B,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,EAAE,CAAC;IACxC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,qEAAqE;IACrE,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B,CAeA,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"UncaughtErrorBoundary.d.ts","sourceRoot":"","sources":["../../../../src/error/UncaughtErrorBoundary.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAgE/B,eAAO,MAAM,qBAAqB,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,CAYzE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/error/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FloatPopperProps, FloatPopperPosition, FloatPopperAnchor } from './FloatPopper';
|
|
3
|
+
import { FloatPopupPanelProps } from './FloatPopup';
|
|
4
|
+
import { FloatReference } from './useFloatStack';
|
|
5
|
+
/**
|
|
6
|
+
* Props for {@link FloatPanel}.
|
|
7
|
+
*/
|
|
8
|
+
export interface FloatPanelProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
|
|
9
|
+
open: boolean;
|
|
10
|
+
floatReference?: FloatReference;
|
|
11
|
+
anchorEl?: FloatPopperAnchor;
|
|
12
|
+
anchorPosition?: FloatPopperPosition;
|
|
13
|
+
label?: string;
|
|
14
|
+
children?: React.ReactNode;
|
|
15
|
+
createPopupPanel?: (props: FloatPopupPanelProps) => React.ReactElement | null;
|
|
16
|
+
propsPopper?: Partial<FloatPopperProps>;
|
|
17
|
+
onClosing?: () => void;
|
|
18
|
+
onClose?: () => void;
|
|
19
|
+
onMount?: (element: HTMLDivElement, instance: any) => void;
|
|
20
|
+
onOpening?: () => void;
|
|
21
|
+
onOpen?: () => void;
|
|
22
|
+
ref?: React.Ref<any>;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* A floating, anchored surface for transient content such as menus, dropdowns,
|
|
26
|
+
* popovers and context menus.
|
|
27
|
+
*
|
|
28
|
+
* `FloatPanel` pairs a {@link FloatPopper} (which positions content next to an
|
|
29
|
+
* anchor element or point, renders it in a portal, flips it to stay on screen
|
|
30
|
+
* and animates it in) with a styled, scrollable "card" surface. The content of
|
|
31
|
+
* that card is supplied by {@link FloatPanelProps.createPopupPanel}.
|
|
32
|
+
*
|
|
33
|
+
* @remarks
|
|
34
|
+
* Most consumers do not render `FloatPanel` directly — {@link useFloatStack}
|
|
35
|
+
* manages instances for you, adding open/close timing, nested stacking, focus
|
|
36
|
+
* handling and click-away dismissal. Reach for `FloatPanel` directly only when
|
|
37
|
+
* you need a single, self-managed floating surface.
|
|
38
|
+
*
|
|
39
|
+
* When to use which:
|
|
40
|
+
* - {@link FloatPopper} — you only need raw positioning + portal (no card chrome).
|
|
41
|
+
* - {@link FloatTooltip} — a small, controlled hint anchored to a point.
|
|
42
|
+
* - `FloatPanel` / {@link useFloatStack} — interactive floating content (menus, popovers).
|
|
43
|
+
*
|
|
44
|
+
* The surface is theme-aware via CSS variables (e.g. `--sxl-color-base-100`),
|
|
45
|
+
* so it adopts the surrounding theme without a UI-framework dependency.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```tsx
|
|
49
|
+
* <FloatPanel
|
|
50
|
+
* open={open}
|
|
51
|
+
* anchorEl={anchorRef.current}
|
|
52
|
+
* createPopupPanel={() => <MyMenu />}
|
|
53
|
+
* />
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
export declare const FloatPanel: React.NamedExoticComponent<Omit<FloatPanelProps, "ref"> & React.RefAttributes<any>>;
|
|
57
|
+
//# sourceMappingURL=FloatPanel.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FloatPanel.d.ts","sourceRoot":"","sources":["../../../../src/float/FloatPanel.tsx"],"names":[],"mappings":"AAAA,OAAO,KAEN,MAAM,OAAO,CAAC;AAMf,OAAO,EACQ,KAAK,gBAAgB,EAAE,KAAK,mBAAmB,EAAE,KAAK,iBAAiB,EACrF,MAAM,eAAe,CAAC;AACvB,OAAO,EACyB,KAAK,oBAAoB,EACxD,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAItD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC;IAC7F,IAAI,EAAE,OAAO,CAAC;IAEd,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAE7B,cAAc,CAAC,EAAE,mBAAmB,CAAC;IAErC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAE3B,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE9E,WAAW,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAExC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IAEvB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAErB,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IAE3D,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IAEvB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IAEpB,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,UAAU,qFAoEpB,CAAC"}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { Placement } from '@floating-ui/react-dom';
|
|
3
|
+
export interface FloatPopperPosition {
|
|
4
|
+
top: number;
|
|
5
|
+
left: number;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Minimal imperative handle to the underlying Floating UI positioner.
|
|
9
|
+
*
|
|
10
|
+
* Historically this returned a popper.js `Instance`; nothing actually consumed
|
|
11
|
+
* it, so it is reduced to the one operation that is meaningful — forcing a
|
|
12
|
+
* reposition.
|
|
13
|
+
*/
|
|
14
|
+
export interface FloatPopperInstance {
|
|
15
|
+
/** Force the floating element to recompute its position. */
|
|
16
|
+
update: () => void;
|
|
17
|
+
}
|
|
18
|
+
export interface FloatPopperRef {
|
|
19
|
+
instance: () => FloatPopperInstance | null;
|
|
20
|
+
element: () => HTMLElement | null;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Virtual or real element used to anchor the popper.
|
|
24
|
+
*/
|
|
25
|
+
export type FloatPopperAnchor = HTMLElement | {
|
|
26
|
+
getBoundingClientRect: () => DOMRect;
|
|
27
|
+
} | (() => HTMLElement) | (() => {
|
|
28
|
+
getBoundingClientRect: () => DOMRect;
|
|
29
|
+
});
|
|
30
|
+
export interface FloatPopperProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
|
|
31
|
+
/**
|
|
32
|
+
* Whether the popper should be shown (drives the enter/exit transition).
|
|
33
|
+
*/
|
|
34
|
+
open: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* The element (or virtual element) the popper is positioned against.
|
|
37
|
+
*/
|
|
38
|
+
anchorEl?: FloatPopperAnchor;
|
|
39
|
+
/**
|
|
40
|
+
* Explicit position. Takes precedence over `anchorEl`.
|
|
41
|
+
*/
|
|
42
|
+
anchorPosition?: FloatPopperPosition;
|
|
43
|
+
/**
|
|
44
|
+
* @defaultValue 'bottom-start'
|
|
45
|
+
*/
|
|
46
|
+
placement?: Placement;
|
|
47
|
+
/**
|
|
48
|
+
* `[skidding, distance]` offset (popper.js convention, preserved for
|
|
49
|
+
* compatibility). `skidding` shifts along the anchor edge, `distance` pushes
|
|
50
|
+
* away from it.
|
|
51
|
+
* @defaultValue [0, 2]
|
|
52
|
+
*/
|
|
53
|
+
offsets?: number[];
|
|
54
|
+
/**
|
|
55
|
+
* If the panel can resize on overflow. Otherwise it will try to fit.
|
|
56
|
+
* @defaultValue true
|
|
57
|
+
*/
|
|
58
|
+
resizeOnOverflow?: boolean;
|
|
59
|
+
/**
|
|
60
|
+
* Poll the anchor's position every animation frame while open (Floating UI
|
|
61
|
+
* `autoUpdate({ animationFrame: true })`). Needed when the anchor is a VIRTUAL element that MOVES with no
|
|
62
|
+
* scroll/resize event to observe — e.g. a caret-following formula hint whose rect changes as the caret
|
|
63
|
+
* moves by click or arrow. Off by default: the per-frame poll has a cost, so only anchors that track a
|
|
64
|
+
* moving point should enable it (a normal element/point anchor repositions fine on scroll/resize alone).
|
|
65
|
+
* @defaultValue false
|
|
66
|
+
*/
|
|
67
|
+
followAnchor?: boolean;
|
|
68
|
+
label?: string;
|
|
69
|
+
children?: React.ReactNode;
|
|
70
|
+
onMount?: (element: HTMLDivElement, instance: FloatPopperInstance) => void;
|
|
71
|
+
onOpening?: () => void;
|
|
72
|
+
onOpen?: () => void;
|
|
73
|
+
onClosing?: () => void;
|
|
74
|
+
onClose?: () => void;
|
|
75
|
+
ref?: React.Ref<FloatPopperRef>;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Popper built directly on [Floating UI](https://floating-ui.com)
|
|
79
|
+
* (`@floating-ui/react-dom`).
|
|
80
|
+
*
|
|
81
|
+
* A popper has 3 lifecycle states: mounted, visible, open.
|
|
82
|
+
*/
|
|
83
|
+
declare const FloatPopper: React.FC<FloatPopperProps>;
|
|
84
|
+
export { FloatPopper };
|
|
85
|
+
//# sourceMappingURL=FloatPopper.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FloatPopper.d.ts","sourceRoot":"","sources":["../../../../src/float/FloatPopper.tsx"],"names":[],"mappings":"AAAA,OAAO,KAEN,MAAM,OAAO,CAAC;AAMf,OAAO,EAEL,KAAK,SAAS,EACf,MAAM,wBAAwB,CAAC;AAYhC,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,4DAA4D;IAC5D,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,mBAAmB,GAAG,IAAI,CAAC;IAC3C,OAAO,EAAE,MAAM,WAAW,GAAG,IAAI,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAC3B,WAAW,GACT;IAAE,qBAAqB,EAAE,MAAM,OAAO,CAAA;CAAE,GACxC,CAAC,MAAM,WAAW,CAAC,GACnB,CAAC,MAAM;IAAE,qBAAqB,EAAE,MAAM,OAAO,CAAA;CAAE,CAAC,CAAC;AAErD,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC;IAC9F;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B;;OAEG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAE3B,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC3E,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAErB,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;CACjC;AAID;;;;;GAKG;AACH,QAAA,MAAM,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,gBAAgB,CAsRzC,CAAC;AAIJ,OAAO,EAAE,WAAW,EAAE,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FloatReference } from './useFloatStack';
|
|
3
|
+
/**
|
|
4
|
+
* Props passed to the panel rendered inside a float.
|
|
5
|
+
*/
|
|
6
|
+
export interface FloatPopupPanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
7
|
+
popupContainer?: HTMLElement;
|
|
8
|
+
floatReference?: FloatReference;
|
|
9
|
+
/**
|
|
10
|
+
* When the popup panel initiates a close
|
|
11
|
+
*/
|
|
12
|
+
closeFloat?: () => void;
|
|
13
|
+
closeFloatAll?: () => void;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Default popup panel (a simple flex column container).
|
|
17
|
+
*/
|
|
18
|
+
export declare const defaultCreateFloatPopupPanel: (props: FloatPopupPanelProps) => React.ReactElement;
|
|
19
|
+
//# sourceMappingURL=FloatPopup.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FloatPopup.d.ts","sourceRoot":"","sources":["../../../../src/float/FloatPopup.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAItD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IAChF,cAAc,CAAC,EAAE,WAAW,CAAC;IAE7B,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IAExB,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,eAAO,MAAM,4BAA4B,GAAI,OAAO,oBAAoB,KAAG,KAAK,CAAC,YAkBhF,CAAC"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ThemeMode } from '../theme';
|
|
3
|
+
import { FloatReference, RenderFloatPanel } from './useFloatStack';
|
|
4
|
+
import { FloatPanelProps } from './FloatPanel';
|
|
5
|
+
import { FloatPopupPanelProps } from './FloatPopup';
|
|
6
|
+
/** The built-in neutral surface (the "floor") used when nothing else provides one. */
|
|
7
|
+
export declare const defaultRenderFloatPanel: RenderFloatPanel;
|
|
8
|
+
export interface FloatProviderProps {
|
|
9
|
+
/**
|
|
10
|
+
* The floating surface for descendants. When omitted, the surface is
|
|
11
|
+
* inherited from an outer provider (and ultimately the neutral `FloatPanel`).
|
|
12
|
+
*/
|
|
13
|
+
renderFloatPanel?: RenderFloatPanel;
|
|
14
|
+
/** Default panel-content factory for descendants. Inherited when omitted. */
|
|
15
|
+
createPopupPanel?: (props: FloatPopupPanelProps) => any;
|
|
16
|
+
/** Extra props merged into the rendered panel. Inherited when omitted. */
|
|
17
|
+
propsFloatPanel?: Partial<FloatPanelProps>;
|
|
18
|
+
/**
|
|
19
|
+
* Add a per-instance scope class to the theme floats in this subtree carry (see {@link FloatThemeScope}).
|
|
20
|
+
* Accumulates onto any inherited scope classes, so a float resolves every ancestor instance's scoped
|
|
21
|
+
* tokens. An app/instance sets this to its own scope class (e.g. `sheetxl-studio-<id>`).
|
|
22
|
+
*/
|
|
23
|
+
themeScopeClass?: string;
|
|
24
|
+
/** The `data-sxl-theme-surface` floats in this subtree open with (nearest provider wins). App sets `app`. */
|
|
25
|
+
themeSurface?: string;
|
|
26
|
+
/** The `data-sxl-theme-mode` floats in this subtree open with (nearest provider wins). App sets its mode. */
|
|
27
|
+
themeMode?: ThemeMode;
|
|
28
|
+
/**
|
|
29
|
+
* Establish an isolated state root for this subtree (its own open-tree,
|
|
30
|
+
* focus/click-away coordination and debounce), independent of other roots on
|
|
31
|
+
* the page. Mount on the boundary that should coordinate as a unit (e.g. an
|
|
32
|
+
* app or split-view container). Without it, a nested provider inherits the
|
|
33
|
+
* enclosing root — but a *top-level* provider (no enclosing float) still
|
|
34
|
+
* auto-roots, so `isolate` is only needed to force a NEW root when nested.
|
|
35
|
+
*/
|
|
36
|
+
isolate?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* Receives the root float in effect for this subtree, so an owner *outside*
|
|
39
|
+
* the subtree can drive it imperatively (e.g. `rootRef.current.closeAll()` on
|
|
40
|
+
* webview focus loss). `isolate` *creates* a root; this only *exposes* it.
|
|
41
|
+
*
|
|
42
|
+
* Set with or without `isolate`: the owned root when this provider roots
|
|
43
|
+
* (isolating, or top of the tree), otherwise the inherited root. Always set to
|
|
44
|
+
* a root (never null) while mounted.
|
|
45
|
+
*/
|
|
46
|
+
rootRef?: React.Ref<FloatReference>;
|
|
47
|
+
children?: React.ReactNode;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Configures the float system for a subtree.
|
|
51
|
+
*
|
|
52
|
+
* - `renderFloatPanel`/`propsFloatPanel` set the surface, overriding only when
|
|
53
|
+
* given (otherwise the outer surface flows through unchanged), so the
|
|
54
|
+
* nearest explicit surface wins.
|
|
55
|
+
* - The top provider in a tree (no enclosing float) automatically owns a fresh
|
|
56
|
+
* coordinating root; nested providers inherit it. `isolate` forces a *new*
|
|
57
|
+
* root even when nested (a sub-scope).
|
|
58
|
+
*/
|
|
59
|
+
export declare const FloatProvider: (props: FloatProviderProps) => React.ReactElement;
|
|
60
|
+
//# sourceMappingURL=FloatProvider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FloatProvider.d.ts","sourceRoot":"","sources":["../../../../src/float/FloatProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAiD,MAAM,OAAO,CAAC;AAEtE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAE7E,OAAO,EAAc,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAMzD,sFAAsF;AACtF,eAAO,MAAM,uBAAuB,EAAE,gBAErC,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,6EAA6E;IAC7E,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,GAAG,CAAC;IACxD,0EAA0E;IAC1E,eAAe,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3C;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6GAA6G;IAC7G,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACpC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,kBAAkB,KAAG,KAAK,CAAC,YAyE/D,CAAC"}
|