@sheetxl/react 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/Bo9Kx3L_XQkGPBJ5.cjs +1 -0
- package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +156 -0
- package/browser/cjs/index.cjs +24 -24
- package/browser/esm/D_suN0U6XvrHxTak.mjs +6286 -0
- package/browser/esm/index.mjs +19258 -4911
- package/licenses/dependencies.txt +42 -214
- package/node/esm/CH084kteEgVy0a8H.mjs +9 -0
- package/node/esm/index.mjs +17035 -3691
- package/package.json +10 -11
- package/resources/contents.json +60 -0
- package/resources/locales/contents.json +114 -0
- package/resources/locales/de/clipboard.cmd.json +36 -0
- package/resources/locales/de/editor.cmd.json +128 -0
- package/resources/locales/de/movable.cmd.json +123 -0
- package/resources/locales/de/selection.cmd.json +373 -0
- package/resources/locales/de/sheet.cmd.json +1563 -0
- package/resources/locales/de/table.cmd.json +83 -0
- package/resources/locales/de/ui.msg.json +166 -0
- package/resources/locales/de/workbook.cmd.json +282 -0
- package/resources/locales/en/clipboard.cmd.json +36 -0
- package/resources/locales/en/editor.cmd.json +128 -0
- package/resources/locales/en/movable.cmd.json +123 -0
- package/resources/locales/en/selection.cmd.json +373 -0
- package/resources/locales/en/sheet.cmd.json +1563 -0
- package/resources/locales/en/table.cmd.json +83 -0
- package/resources/locales/en/ui.msg.json +166 -0
- package/resources/locales/en/workbook.cmd.json +282 -0
- package/types/index.d.ts +2 -1767
- package/types/src/border/StaticBorderRenderer.d.ts +32 -0
- package/types/src/border/StyledStrokePath.d.ts +14 -0
- package/types/src/border/index.d.ts +4 -0
- package/types/src/border/useBorders.d.ts +87 -0
- package/types/src/cell/ColumnButton.d.ts +45 -0
- package/types/src/cell/CornerTriangle.d.ts +27 -0
- package/types/src/cell/FormulaCellRenderer.d.ts +34 -0
- package/types/src/cell/SheetCellRenderer.d.ts +52 -0
- package/types/src/cell/SheetHeaderRenderer.d.ts +37 -0
- package/types/src/cell/index.d.ts +7 -0
- package/types/src/cell/useFormulaViewAnchor.d.ts +42 -0
- package/types/src/chart/ChartEditor.d.ts +17 -0
- package/types/src/chart/PresetChartTypeDescriptors.d.ts +35 -0
- package/types/src/chart/index.d.ts +3 -0
- package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +10 -0
- package/types/src/chart/templates/area-stacked-template.json.d.ts +10 -0
- package/types/src/chart/templates/area-template.json.d.ts +9 -0
- package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +10 -0
- package/types/src/chart/templates/bar-stacked-template.json.d.ts +10 -0
- package/types/src/chart/templates/bar-template.json.d.ts +9 -0
- package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +10 -0
- package/types/src/chart/templates/column-stacked-template.json.d.ts +10 -0
- package/types/src/chart/templates/column-template.json.d.ts +9 -0
- package/types/src/chart/templates/line-markers-template.json.d.ts +10 -0
- package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +11 -0
- package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +11 -0
- package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +10 -0
- package/types/src/chart/templates/line-stacked-template.json.d.ts +10 -0
- package/types/src/chart/templates/line-template.json.d.ts +9 -0
- package/types/src/chart/templates/pie-doughnut-template.json.d.ts +10 -0
- package/types/src/chart/templates/pie-template.json.d.ts +9 -0
- package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +10 -0
- package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +10 -0
- package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +10 -0
- package/types/src/chart/templates/scatter-lines-template.json.d.ts +10 -0
- package/types/src/chart/templates/scatter-markers-template.json.d.ts +10 -0
- package/types/src/clipboard/ClipboardCommands.d.ts +68 -0
- package/types/src/clipboard/SheetClipboardLayer.d.ts +22 -0
- package/types/src/clipboard/index.d.ts +3 -0
- package/types/src/commands/Catalog.d.ts +8 -0
- package/types/src/commands/CommandRootProvider.d.ts +36 -0
- package/types/src/commands/InputClipboardCommands.d.ts +41 -0
- package/types/src/commands/InputClipboardInjector.d.ts +16 -0
- package/types/src/commands/MainFocusContext.d.ts +13 -0
- package/types/src/commands/PaneScopeProvider.d.ts +40 -0
- package/types/src/commands/createTransactionalMiddleware.d.ts +49 -0
- package/types/src/commands/index.d.ts +7 -0
- package/types/src/context/SheetContext.d.ts +18 -0
- package/types/src/context/WorkbookContext.d.ts +20 -0
- package/types/src/context/index.d.ts +3 -0
- package/types/src/editableLabel/EditableLabel.d.ts +28 -0
- package/types/src/editableLabel/index.d.ts +2 -0
- package/types/src/editor/EditorCommands.d.ts +98 -0
- package/types/src/editor/FunctionPreviewPanel.d.ts +166 -0
- package/types/src/editor/NamedHintPanel.d.ts +38 -0
- package/types/src/editor/NamedItemsPanel.d.ts +59 -0
- package/types/src/editor/SheetCellEditorLayer.d.ts +40 -0
- package/types/src/editor/SheetCellInput.d.ts +99 -0
- package/types/src/editor/SheetEditable.d.ts +53 -0
- package/types/src/editor/SheetReferenceHeaderLayer.d.ts +46 -0
- package/types/src/editor/SheetReferenceLayer.d.ts +55 -0
- package/types/src/editor/formulaCaret.d.ts +84 -0
- package/types/src/editor/formulaEval.d.ts +202 -0
- package/types/src/editor/formulaPresentation.d.ts +136 -0
- package/types/src/editor/formulaText.d.ts +80 -0
- package/types/src/editor/functionArgs.d.ts +111 -0
- package/types/src/editor/functionHint.d.ts +37 -0
- package/types/src/editor/index.d.ts +18 -0
- package/types/src/editor/referencePointNav.d.ts +39 -0
- package/types/src/editor/useFormulaHints.d.ts +126 -0
- package/types/src/editor/useFormulaInput.d.ts +326 -0
- package/types/src/editor/useProtectedEditNotice.d.ts +14 -0
- package/types/src/editor/useReferenceMode.d.ts +177 -0
- package/types/src/form/FormulaInput.d.ts +86 -0
- package/types/src/form/FormulaInputParts.d.ts +94 -0
- package/types/src/form/index.d.ts +5 -0
- package/types/src/form/useEditCommit.d.ts +174 -0
- package/types/src/form/useInputField.d.ts +86 -0
- package/types/src/frame/CommandContext.d.ts +179 -0
- package/types/src/frame/IFrame.d.ts +17 -0
- package/types/src/frame/index.d.ts +3 -0
- package/types/src/icons/LogoNoPaddingIcon.d.ts +3 -0
- package/types/src/icons/LogoTextNoPaddingIcon.d.ts +4 -0
- package/types/src/icons/WaterMark.d.ts +12 -0
- package/types/src/icons/chart/ChartAreaIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartAreaStackedIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartAreaStackedPercentIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBarIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBarStackedIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBarStackedPercentIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBubble3DIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartBubbleIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartColumnIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartColumnStackedIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartColumnStackedPercentIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineStackedIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineStackedMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineStackedPercentIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartLineStackedPercentMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartPieDoughnutIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartPieIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterLinesIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterLinesMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterLinesMarkersSmoothIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterLinesSmoothIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartScatterMarkersIcon.d.ts +5 -0
- package/types/src/icons/chart/ChartWaterfallIcon.d.ts +5 -0
- package/types/src/icons/chart/ThemedChartIcon.d.ts +20 -0
- package/types/src/icons/chart/index.d.ts +50 -0
- package/types/src/icons/index.d.ts +4 -0
- package/types/src/index.d.ts +27 -0
- package/types/src/io/WorkbookIO.d.ts +50 -0
- package/types/src/io/index.d.ts +2 -0
- package/types/src/layer/BorderLayer.d.ts +14 -0
- package/types/src/layer/CellErrorLayer.d.ts +49 -0
- package/types/src/layer/CellFillLayer.d.ts +15 -0
- package/types/src/layer/ConditionalBarLayer.d.ts +41 -0
- package/types/src/layer/ConditionalIcons.d.ts +34 -0
- package/types/src/layer/ConditionalIconsLayer.d.ts +31 -0
- package/types/src/layer/ContextMenuLayer.d.ts +27 -0
- package/types/src/layer/HeaderResizerLayer.d.ts +28 -0
- package/types/src/layer/HeaderSelectionLayer.d.ts +89 -0
- package/types/src/layer/ResizeIndicator.d.ts +19 -0
- package/types/src/layer/SheetBackgroundLayer.d.ts +22 -0
- package/types/src/layer/SheetCellLayer.d.ts +49 -0
- package/types/src/layer/SheetColumnButtonLayer.d.ts +23 -0
- package/types/src/layer/SheetGridLineLayer.d.ts +22 -0
- package/types/src/layer/SheetHeaderCellLayer.d.ts +30 -0
- package/types/src/layer/SheetMovableLayer.d.ts +26 -0
- package/types/src/layer/SheetTableCommandLayer.d.ts +16 -0
- package/types/src/layer/SpillLayer.d.ts +22 -0
- package/types/src/layer/TableLayer.d.ts +22 -0
- package/types/src/layer/ValidationIndicatorLayer.d.ts +41 -0
- package/types/src/layer/index.d.ts +25 -0
- package/types/src/layer/resizeIndicatorState.d.ts +26 -0
- package/types/src/layer/useSheetFeatureRegions.d.ts +21 -0
- package/types/src/layer/useSheetVisibleCells.d.ts +60 -0
- package/types/src/layer/useSheetVisibleDecorations.d.ts +42 -0
- package/types/src/layer/useTableHeaderCells.d.ts +22 -0
- package/types/src/layer/useVisibleTables.d.ts +27 -0
- package/types/src/listener/index.d.ts +3 -0
- package/types/src/listener/useModelListener.d.ts +67 -0
- package/types/src/listener/useRangeListener.d.ts +15 -0
- package/types/src/movable/EmptyFrame.d.ts +16 -0
- package/types/src/movable/IMovableArea.d.ts +34 -0
- package/types/src/movable/MovableCommands.d.ts +22 -0
- package/types/src/movable/MovableFrame.d.ts +48 -0
- package/types/src/movable/MovableLayer.d.ts +77 -0
- package/types/src/movable/MoveableBundle.d.ts +4 -0
- package/types/src/movable/index.d.ts +4 -0
- package/types/src/picture/IPictureEditor.d.ts +39 -0
- package/types/src/picture/PictureEditor.d.ts +4 -0
- package/types/src/picture/index.d.ts +3 -0
- package/types/src/selection/SelectionCommands.d.ts +23 -0
- package/types/src/selection/SheetSelection.d.ts +53 -0
- package/types/src/selection/SheetSelectionLayer.d.ts +30 -0
- package/types/src/selection/index.d.ts +4 -0
- package/types/src/shape/ShapeEditor.d.ts +16 -0
- package/types/src/shape/index.d.ts +2 -0
- package/types/src/sheet/ConditionalFormatPresets.d.ts +56 -0
- package/types/src/sheet/ISheetElement.d.ts +233 -0
- package/types/src/sheet/ISheetHeaderElement.d.ts +138 -0
- package/types/src/sheet/NotImplemented.d.ts +3 -0
- package/types/src/sheet/SheetCommandProvider.d.ts +57 -0
- package/types/src/sheet/SheetCommands.d.ts +75 -0
- package/types/src/sheet/SheetElement.d.ts +15 -0
- package/types/src/sheet/SheetHeaderElement.d.ts +4 -0
- package/types/src/sheet/SheetScrollbar.d.ts +28 -0
- package/types/src/sheet/TopLeftCorner.d.ts +17 -0
- package/types/src/sheet/index.d.ts +7 -0
- package/types/src/slicer/SlicerEditor.d.ts +16 -0
- package/types/src/slicer/index.d.ts +2 -0
- package/types/src/tabStrip/SheetTab.d.ts +41 -0
- package/types/src/tabStrip/Sortable.d.ts +66 -0
- package/types/src/tabStrip/Tab.d.ts +19 -0
- package/types/src/tabStrip/TabStrip.d.ts +41 -0
- package/types/src/tabStrip/TabStripItem.d.ts +36 -0
- package/types/src/tabStrip/TabStripRow.d.ts +9 -0
- package/types/src/tabStrip/index.d.ts +7 -0
- package/types/src/table/TableCommands.d.ts +16 -0
- package/types/src/taskPane/ITaskPane.d.ts +72 -0
- package/types/src/taskPane/TaskPaneArea.d.ts +144 -0
- package/types/src/taskPane/TaskPaneFrame.d.ts +48 -0
- package/types/src/taskPane/TaskPaneRegistry.d.ts +108 -0
- package/types/src/taskPane/TaskPaneStrip.d.ts +33 -0
- package/types/src/taskPane/TaskPaneTitle.d.ts +24 -0
- package/types/src/taskPane/index.d.ts +7 -0
- package/types/src/taskPane/useTaskPane.d.ts +29 -0
- package/types/src/theme/DocThemesContext.d.ts +3 -0
- package/types/src/theme/DocThemesProvider.d.ts +15 -0
- package/types/src/theme/ThemeState.d.ts +19 -0
- package/types/src/theme/buildDocThemeCSS.d.ts +16 -0
- package/types/src/theme/buildOOXMLThemeCSS.d.ts +13 -0
- package/types/src/theme/createCSSSystemLookup.d.ts +51 -0
- package/types/src/theme/index.d.ts +11 -0
- package/types/src/theme/useAppColorScheme.d.ts +15 -0
- package/types/src/theme/useDocThemes.d.ts +3 -0
- package/types/src/theme/useGridColorScheme.d.ts +20 -0
- package/types/src/theme/useSystemColors.d.ts +44 -0
- package/types/src/undo/UndoCommands.d.ts +28 -0
- package/types/src/undo/UndoManagerContext.d.ts +14 -0
- package/types/src/undo/index.d.ts +3 -0
- package/types/src/workbook/DefaultRenderers.d.ts +14 -0
- package/types/src/workbook/GlobalWorkbookElement.d.ts +10 -0
- package/types/src/workbook/IWorkbookElement.d.ts +178 -0
- package/types/src/workbook/WindowChrome.d.ts +61 -0
- package/types/src/workbook/WorkbookCommandContributor.d.ts +24 -0
- package/types/src/workbook/WorkbookCommands.d.ts +97 -0
- package/types/src/workbook/WorkbookElement.d.ts +9 -0
- package/types/src/workbook/WorkbookStrip.d.ts +73 -0
- package/types/src/workbook/index.d.ts +17 -0
- package/types/src/workbook/resolveWorkbookInput.d.ts +27 -0
- package/types/src/workbook/useResolvedWorkbook.d.ts +31 -0
- package/types/src/workbook/useWindowChrome.d.ts +24 -0
- package/types/src/workbook/useWorkbookApp.d.ts +47 -0
- package/types/src/workbook/useWorkbookEncrypted.d.ts +15 -0
- package/types/src/workbook/useWorkbookFormat.d.ts +18 -0
- package/types/src/workbook/useWorkbookName.d.ts +13 -0
- package/types/src/workbook/useWorkbookSaveState.d.ts +29 -0
- package/browser/cjs/BmyiATwwabIijIcx.cjs +0 -16
- package/browser/cjs/gi7H7UxDWl1xhmpB.cjs +0 -7
- package/browser/cjs/riAg15J7Fxjibjpd.cjs +0 -161
- package/browser/esm/BLxDzg_nC0uvkabr.mjs +0 -1377
- package/browser/esm/CL0VCEG7SV6dsMf0.mjs +0 -3905
- package/browser/esm/CwNJi9uj-WfxZwSI.mjs +0 -394
- package/node/assets/style.css +0 -1
- package/node/esm/CX0U5emV8bnYBcK6.mjs +0 -11
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { CollisionDetection, DragStartEvent, DropAnimation, KeyboardCoordinateGetter, Modifiers, MeasuringConfiguration, PointerActivationConstraint, UniqueIdentifier } from '@dnd-kit/core';
|
|
3
|
+
import { arrayMove, SortingStrategy, AnimateLayoutChanges, NewIndexGetter } from '@dnd-kit/sortable';
|
|
4
|
+
export interface SortableProps {
|
|
5
|
+
className?: string;
|
|
6
|
+
activationConstraint?: PointerActivationConstraint;
|
|
7
|
+
animateLayoutChanges?: AnimateLayoutChanges;
|
|
8
|
+
adjustScale?: boolean;
|
|
9
|
+
collisionDetection?: CollisionDetection;
|
|
10
|
+
coordinateGetter?: KeyboardCoordinateGetter;
|
|
11
|
+
dropAnimation?: DropAnimation | null;
|
|
12
|
+
getNewIndex?: NewIndexGetter;
|
|
13
|
+
handle?: boolean;
|
|
14
|
+
items: string[];
|
|
15
|
+
onMove?: (indexFrom: number, indexTo: number) => void;
|
|
16
|
+
measuring?: MeasuringConfiguration;
|
|
17
|
+
modifiers?: Modifiers;
|
|
18
|
+
renderItem?: any;
|
|
19
|
+
removable?: boolean;
|
|
20
|
+
renderDivider?: (props: React.HTMLAttributes<HTMLElement> & {
|
|
21
|
+
key: string;
|
|
22
|
+
}) => React.ReactElement;
|
|
23
|
+
reorderItems?: typeof arrayMove;
|
|
24
|
+
strategy?: SortingStrategy;
|
|
25
|
+
style?: React.CSSProperties;
|
|
26
|
+
useDragOverlay?: boolean;
|
|
27
|
+
onDragStart?(event: DragStartEvent): void;
|
|
28
|
+
getItemStyles?(args: {
|
|
29
|
+
id: UniqueIdentifier;
|
|
30
|
+
index: number;
|
|
31
|
+
isSorting: boolean;
|
|
32
|
+
isDragOverlay: boolean;
|
|
33
|
+
overIndex: number;
|
|
34
|
+
isDragging: boolean;
|
|
35
|
+
}): React.CSSProperties;
|
|
36
|
+
wrapperStyle?(args: {
|
|
37
|
+
index: number;
|
|
38
|
+
isDragging: boolean;
|
|
39
|
+
id: string;
|
|
40
|
+
}): React.CSSProperties;
|
|
41
|
+
isDisabled?(id: UniqueIdentifier): boolean;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* NOTE - This currently only supports horizontal layout.
|
|
45
|
+
*/
|
|
46
|
+
export declare const Sortable: React.NamedExoticComponent<SortableProps & React.RefAttributes<HTMLDivElement>>;
|
|
47
|
+
interface SortableItemProps {
|
|
48
|
+
animateLayoutChanges?: AnimateLayoutChanges;
|
|
49
|
+
disabled?: boolean;
|
|
50
|
+
getNewIndex?: NewIndexGetter;
|
|
51
|
+
id: string;
|
|
52
|
+
index: number;
|
|
53
|
+
handle: boolean;
|
|
54
|
+
useDragOverlay?: boolean;
|
|
55
|
+
onRemove?(id: string): void;
|
|
56
|
+
style(values: any): React.CSSProperties;
|
|
57
|
+
renderItem?(args: any): React.ReactElement;
|
|
58
|
+
wrapperStyle({ index, isDragging, id, }: {
|
|
59
|
+
index: number;
|
|
60
|
+
isDragging: boolean;
|
|
61
|
+
id: string;
|
|
62
|
+
}): React.CSSProperties;
|
|
63
|
+
}
|
|
64
|
+
export declare function SortableItem({ disabled, animateLayoutChanges, getNewIndex, handle, id, index, onRemove, style, renderItem, useDragOverlay, wrapperStyle, }: SortableItemProps): React.JSX.Element;
|
|
65
|
+
export {};
|
|
66
|
+
//# sourceMappingURL=Sortable.d.ts.map
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export interface TabProps extends Omit<React.HTMLAttributes<HTMLElement>, "onSubmit" | "onChange"> {
|
|
3
|
+
value: any;
|
|
4
|
+
index: number;
|
|
5
|
+
editing: boolean;
|
|
6
|
+
editable: boolean;
|
|
7
|
+
disabled: boolean;
|
|
8
|
+
selectedIndex: number;
|
|
9
|
+
/** CSS color for the tab background. */
|
|
10
|
+
background: string;
|
|
11
|
+
/** CSS color for the selected-tab accent. */
|
|
12
|
+
activeColor?: string;
|
|
13
|
+
/** CSS color for the tab border/notch. */
|
|
14
|
+
borderColor?: string;
|
|
15
|
+
borderWidth?: number;
|
|
16
|
+
dragging: boolean;
|
|
17
|
+
}
|
|
18
|
+
export declare const Tab: React.NamedExoticComponent<TabProps & React.RefAttributes<HTMLDivElement>>;
|
|
19
|
+
//# sourceMappingURL=Tab.d.ts.map
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ScrollButtonProps } from '@sheetxl/utils-react';
|
|
3
|
+
import { EditableLabelProps } from '../editableLabel';
|
|
4
|
+
import { TabProps } from './Tab';
|
|
5
|
+
export interface TabStripRef extends HTMLDivElement {
|
|
6
|
+
startEdit(index: number): void;
|
|
7
|
+
cancel(index: number): void;
|
|
8
|
+
}
|
|
9
|
+
export interface TabStripProps extends Omit<React.HTMLAttributes<HTMLDivElement>, "onSubmit" | "onChange"> {
|
|
10
|
+
selectedTabIndex: number;
|
|
11
|
+
tabNames: string[];
|
|
12
|
+
onSelectedTabIndexChange?: (index: number) => void;
|
|
13
|
+
onTabNameChange?: (index: number, tabName: string) => void;
|
|
14
|
+
onTabMove?: (indexFrom: number, indexTo: number) => void;
|
|
15
|
+
renderScrollButtonStart?: ((props: ScrollButtonProps) => React.ReactElement) | null;
|
|
16
|
+
renderScrollButtonEnd?: ((props: ScrollButtonProps) => React.ReactElement) | null;
|
|
17
|
+
renderScrollButtonEdge?: ((props: ScrollButtonProps) => React.ReactElement) | null;
|
|
18
|
+
renderTabButton?: (props: TabProps) => React.ReactElement<any>;
|
|
19
|
+
renderTabDivider?: (props: React.HTMLAttributes<HTMLElement> & React.Attributes) => React.ReactElement;
|
|
20
|
+
propsEditLabel?: EditableLabelProps;
|
|
21
|
+
disabled?: boolean;
|
|
22
|
+
disableDrag?: boolean;
|
|
23
|
+
/**
|
|
24
|
+
* Default background color of tabs
|
|
25
|
+
*/
|
|
26
|
+
background?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Currently '2022' css does not allow for scrollPanes to be hidden in one axis and overflow in another.
|
|
29
|
+
* To support tab scrolling and create a visual notch for the selected tab
|
|
30
|
+
* We create a border/divider for all elements except the selected.
|
|
31
|
+
*/
|
|
32
|
+
borderWidth?: number;
|
|
33
|
+
borderColor?: string;
|
|
34
|
+
/** CSS color for the selected-tab accent. */
|
|
35
|
+
activeColor?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* TabStrip component for displaying and managing tabs.
|
|
39
|
+
*/
|
|
40
|
+
export declare const TabStrip: React.NamedExoticComponent<TabStripProps & React.RefAttributes<TabStripRef>>;
|
|
41
|
+
//# sourceMappingURL=TabStrip.d.ts.map
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { DraggableSyntheticListeners } from '@dnd-kit/core';
|
|
3
|
+
import { Transform } from '@dnd-kit/utilities';
|
|
4
|
+
export interface TabStripItemProps {
|
|
5
|
+
dragOverlay?: boolean;
|
|
6
|
+
color?: string;
|
|
7
|
+
disabled?: boolean;
|
|
8
|
+
dragging?: boolean;
|
|
9
|
+
handle?: boolean;
|
|
10
|
+
height?: number;
|
|
11
|
+
index?: number;
|
|
12
|
+
fadeIn?: boolean;
|
|
13
|
+
transform?: Transform | null;
|
|
14
|
+
listeners?: DraggableSyntheticListeners;
|
|
15
|
+
sorting?: boolean;
|
|
16
|
+
style?: React.CSSProperties;
|
|
17
|
+
transition?: string | null;
|
|
18
|
+
wrapperStyle?: React.CSSProperties;
|
|
19
|
+
value: React.ReactNode;
|
|
20
|
+
onRemove?(): void;
|
|
21
|
+
renderItem?(args: {
|
|
22
|
+
dragOverlay: boolean;
|
|
23
|
+
dragging: boolean;
|
|
24
|
+
sorting: boolean;
|
|
25
|
+
index: number | undefined;
|
|
26
|
+
fadeIn: boolean;
|
|
27
|
+
listeners: DraggableSyntheticListeners;
|
|
28
|
+
ref: React.Ref<HTMLElement>;
|
|
29
|
+
style: React.CSSProperties | undefined;
|
|
30
|
+
transform: TabStripItemProps['transform'];
|
|
31
|
+
transition: TabStripItemProps['transition'];
|
|
32
|
+
value: TabStripItemProps['value'];
|
|
33
|
+
}): React.ReactElement;
|
|
34
|
+
}
|
|
35
|
+
export declare const TabStripItem: React.NamedExoticComponent<TabStripItemProps & React.RefAttributes<HTMLDivElement>>;
|
|
36
|
+
//# sourceMappingURL=TabStripItem.d.ts.map
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export interface TabStripRowProps {
|
|
3
|
+
children: React.ReactNode;
|
|
4
|
+
columns?: number;
|
|
5
|
+
style?: React.CSSProperties;
|
|
6
|
+
horizontal?: boolean;
|
|
7
|
+
}
|
|
8
|
+
export declare const TabStripRow: React.NamedExoticComponent<TabStripRowProps & React.RefAttributes<HTMLDivElement>>;
|
|
9
|
+
//# sourceMappingURL=TabStripRow.d.ts.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export * from './TabStrip';
|
|
2
|
+
export type { TabStripProps } from './TabStrip';
|
|
3
|
+
export { Tab } from './Tab';
|
|
4
|
+
export type { TabProps } from './Tab';
|
|
5
|
+
export { SheetTab } from './SheetTab';
|
|
6
|
+
export type { SheetTabProps, SheetTabSurfaceProps } from './SheetTab';
|
|
7
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { RemoveListener, UndoManager } from '@sheetxl/utils';
|
|
2
|
+
import { ISheet } from '@sheetxl/sdk';
|
|
3
|
+
import { Command, IReactNotifier } from '@sheetxl/utils-react';
|
|
4
|
+
/** Options for {@link contributeTableCommands}. */
|
|
5
|
+
export interface ContributeTableCommandsOptions {
|
|
6
|
+
/** Busy + error UI for the transactional middleware. */
|
|
7
|
+
notifier?: IReactNotifier;
|
|
8
|
+
/** Undo manager the sheet records into — enables F4 / redo-as-repeat (see the transactional middleware). */
|
|
9
|
+
manager?: UndoManager;
|
|
10
|
+
}
|
|
11
|
+
/** The single `data` bundle {@link contributeTableCommands} takes (the `DynamicCommandContributor` shape). */
|
|
12
|
+
export interface TableCommandData extends ContributeTableCommandsOptions {
|
|
13
|
+
sheet: ISheet | null;
|
|
14
|
+
}
|
|
15
|
+
export declare function contributeTableCommands(contribution: Command.CommandContribution, data: TableCommandData): RemoveListener;
|
|
16
|
+
//# sourceMappingURL=TableCommands.d.ts.map
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { IFrame } from '../frame';
|
|
2
|
+
/**
|
|
3
|
+
* Props passed to a registered task pane component.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* Task panes are real React components (rendered as `<Component {...props}/>`), so they may use
|
|
7
|
+
* hooks freely. The host's `ref` arrives as a regular prop (React 19 style); forward it to the
|
|
8
|
+
* pane's root element. Extends HTML attributes because hosts may inject presentation props
|
|
9
|
+
* (`propsPane`) that the pane is expected to spread onto its root.
|
|
10
|
+
*
|
|
11
|
+
* @typeParam T - The model (the workbook, for the built-in panes).
|
|
12
|
+
* @typeParam A - The activation argument, if the pane accepts one — see {@link args}.
|
|
13
|
+
*/
|
|
14
|
+
export interface TaskPaneProps<T = any, A = any> extends React.HTMLAttributes<HTMLElement> {
|
|
15
|
+
/**
|
|
16
|
+
* The key used to register the taskPane.
|
|
17
|
+
*/
|
|
18
|
+
entryKey: string;
|
|
19
|
+
model?: T;
|
|
20
|
+
/**
|
|
21
|
+
* What the activating call asked this pane to show — `ActivateFrameOptions.args`, delivered
|
|
22
|
+
* verbatim.
|
|
23
|
+
*
|
|
24
|
+
* @remarks
|
|
25
|
+
* The pane defines the shape; the area only carries it. It is scoped to one activation rather
|
|
26
|
+
* than to the pane's lifetime: activating again without it clears it, and re-delivering the same
|
|
27
|
+
* payload means passing it again. So a pane treats an arriving value as an EVENT — react to it
|
|
28
|
+
* changing, not to its presence, or a re-render replays it.
|
|
29
|
+
*
|
|
30
|
+
* `undefined` is the ordinary case: opened from the ribbon, a pane is asked for nothing in
|
|
31
|
+
* particular.
|
|
32
|
+
*/
|
|
33
|
+
args?: A;
|
|
34
|
+
frame?: IFrame;
|
|
35
|
+
/**
|
|
36
|
+
* Ref to the task pane's root element (React 19 ref-as-prop).
|
|
37
|
+
*/
|
|
38
|
+
ref?: React.Ref<any>;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* The activation argument the built-in list panes (conditional formats, data validations,
|
|
42
|
+
* protected ranges) understand.
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* Threaded from a command through `activateTaskPane(key, { args })` — see
|
|
46
|
+
* `ItemsDescriptor.createSeededDraft` in `@sheetxl/studio-mui` for the receiving end.
|
|
47
|
+
*/
|
|
48
|
+
export interface ItemsPaneArgs<P = any> {
|
|
49
|
+
/**
|
|
50
|
+
* Open the pane editing a NEW, uncommitted item seeded with these properties, rather than on its
|
|
51
|
+
* list.
|
|
52
|
+
*
|
|
53
|
+
* @remarks
|
|
54
|
+
* The pane mints the draft itself (anchored to the current selection, like its own add button):
|
|
55
|
+
* this is the feature's properties shape, not a model object, so it survives being handed across
|
|
56
|
+
* a workbook the caller does not hold.
|
|
57
|
+
*
|
|
58
|
+
* Nothing is written until the user saves — which is the point of seeding a draft rather than
|
|
59
|
+
* adding a rule and opening the pane on top of it.
|
|
60
|
+
*/
|
|
61
|
+
draft?: P;
|
|
62
|
+
/**
|
|
63
|
+
* Open the pane on a NEW, uncommitted item — precisely what its own add button mints — rather
|
|
64
|
+
* than on its list. What a "New Rule…" command asks for.
|
|
65
|
+
*
|
|
66
|
+
* @remarks
|
|
67
|
+
* The same request as {@link draft}, with nothing to seed; a `draft` wins when both are given.
|
|
68
|
+
* Ignored by a pane whose list is read-only, which shows no add button either.
|
|
69
|
+
*/
|
|
70
|
+
insert?: boolean;
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=ITaskPane.d.ts.map
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { RemoveListener } from '@sheetxl/utils';
|
|
3
|
+
import { FocusWindowOptions } from '@sheetxl/utils-react';
|
|
4
|
+
import { ITaskPaneRegistry } from './TaskPaneRegistry';
|
|
5
|
+
import { TaskPaneStripProps } from './TaskPaneStrip';
|
|
6
|
+
import { TaskPaneTitleProps } from './TaskPaneTitle';
|
|
7
|
+
export interface TaskPaneAreaProps<T = any> extends React.HTMLAttributes<HTMLDivElement> {
|
|
8
|
+
/**
|
|
9
|
+
* The model to pass to taskpane
|
|
10
|
+
*/
|
|
11
|
+
model?: T;
|
|
12
|
+
/**
|
|
13
|
+
* Called when the task pane is should open.
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* This is called when the first task pane is activated but it does not actually open.
|
|
17
|
+
*/
|
|
18
|
+
onOpen?: () => void;
|
|
19
|
+
/**
|
|
20
|
+
* Called when the task pane is closed.
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* This is called when the last task pane is deactivated but it does not actually close.
|
|
24
|
+
*/
|
|
25
|
+
onClose?: () => void;
|
|
26
|
+
/**
|
|
27
|
+
* Props that can be injected to pane
|
|
28
|
+
*/
|
|
29
|
+
propsPane?: React.HTMLAttributes<HTMLDivElement>;
|
|
30
|
+
/**
|
|
31
|
+
* Allows users to Wrap pane children in Top level Context.
|
|
32
|
+
*
|
|
33
|
+
* @remarks
|
|
34
|
+
* Rendered as `<WrapperPane>{pane}</WrapperPane>` — a real component, hooks are allowed.
|
|
35
|
+
*/
|
|
36
|
+
wrapperPane?: React.ComponentType<{
|
|
37
|
+
children?: React.ReactNode;
|
|
38
|
+
}>;
|
|
39
|
+
/**
|
|
40
|
+
* Wrap frame in a context.
|
|
41
|
+
*
|
|
42
|
+
* @remarks
|
|
43
|
+
* Rendered as `<WrapperFrame>{frame}</WrapperFrame>` — a real component, hooks are allowed.
|
|
44
|
+
*/
|
|
45
|
+
wrapperFrame?: React.ComponentType<{
|
|
46
|
+
children?: React.ReactNode;
|
|
47
|
+
}>;
|
|
48
|
+
/**
|
|
49
|
+
* Props that can be injected to the frame
|
|
50
|
+
*/
|
|
51
|
+
propsFrame?: React.HTMLAttributes<HTMLDivElement>;
|
|
52
|
+
/**
|
|
53
|
+
* Override the default title component.
|
|
54
|
+
*
|
|
55
|
+
* @remarks
|
|
56
|
+
* If the registry also provides a custom title component that will be used instead.
|
|
57
|
+
*/
|
|
58
|
+
componentTitle?: React.ComponentType<TaskPaneTitleProps>;
|
|
59
|
+
/**
|
|
60
|
+
* Override the default task pane strip component.
|
|
61
|
+
*/
|
|
62
|
+
componentStrip?: React.ComponentType<TaskPaneStripProps>;
|
|
63
|
+
/**
|
|
64
|
+
* Allow for custom registry of task panes.
|
|
65
|
+
*/
|
|
66
|
+
registry?: ITaskPaneRegistry;
|
|
67
|
+
/**
|
|
68
|
+
* If true always show the strip even with one pane.
|
|
69
|
+
*/
|
|
70
|
+
alwaysShowStrip?: boolean;
|
|
71
|
+
/**
|
|
72
|
+
* Whether the layout should be right to left. This will flip the order of the panes and the direction of the split.
|
|
73
|
+
*
|
|
74
|
+
* @defaultValue 'right'
|
|
75
|
+
*/
|
|
76
|
+
side?: 'left' | 'right';
|
|
77
|
+
/**
|
|
78
|
+
* Reference to the underlying element.
|
|
79
|
+
*/
|
|
80
|
+
ref?: React.Ref<ITaskPaneAreaElement>;
|
|
81
|
+
}
|
|
82
|
+
export interface ActivateFrameOptions<A = any> {
|
|
83
|
+
/**
|
|
84
|
+
* If not provided then will drive autoFocus
|
|
85
|
+
*/
|
|
86
|
+
autoFocus?: boolean | string | FocusWindowOptions;
|
|
87
|
+
/**
|
|
88
|
+
* An opaque value bag for the pane being activated, delivered as {@link TaskPaneProps.args}.
|
|
89
|
+
*
|
|
90
|
+
* @remarks
|
|
91
|
+
* How an activation says *what to show*, as opposed to merely *show yourself* — a conditional
|
|
92
|
+
* format preset ("Greater Than…") opens the rules pane already editing a new rule seeded with its
|
|
93
|
+
* condition. The area does not read it; only the pane registered under `key` knows its shape (see
|
|
94
|
+
* {@link ItemsPaneArgs} for the built-in list panes).
|
|
95
|
+
*
|
|
96
|
+
* It belongs to ONE activation. Activating the same pane again without it clears it — otherwise a
|
|
97
|
+
* pane that unmounts on tab switch would re-consume the last one every time it came back — so a
|
|
98
|
+
* caller that wants it delivered again passes it again.
|
|
99
|
+
*/
|
|
100
|
+
args?: A;
|
|
101
|
+
}
|
|
102
|
+
export interface ITaskPaneAreaListener {
|
|
103
|
+
/**
|
|
104
|
+
* Called when the active pane or open panes change.
|
|
105
|
+
*/
|
|
106
|
+
onChange?: () => void;
|
|
107
|
+
}
|
|
108
|
+
export interface ITaskPaneArea {
|
|
109
|
+
/**
|
|
110
|
+
* This will show and focus a task pane by key.
|
|
111
|
+
*
|
|
112
|
+
* @param key The task pane key.
|
|
113
|
+
*/
|
|
114
|
+
activate: <A = any>(key: string, options?: ActivateFrameOptions<A>) => void;
|
|
115
|
+
/**
|
|
116
|
+
* Return the key for the currently active task pane.
|
|
117
|
+
*/
|
|
118
|
+
getActive: () => string | null;
|
|
119
|
+
/**
|
|
120
|
+
* Returns the list of currently open task panes.
|
|
121
|
+
*/
|
|
122
|
+
getOpen: () => readonly string[];
|
|
123
|
+
/**
|
|
124
|
+
* Will close the task pane with the given key.
|
|
125
|
+
* @param key The task pane key.
|
|
126
|
+
*/
|
|
127
|
+
close: (key: string) => Promise<void>;
|
|
128
|
+
/**
|
|
129
|
+
* Add a listener for task pane state changes.
|
|
130
|
+
*/
|
|
131
|
+
addListener: (listener: ITaskPaneAreaListener) => RemoveListener;
|
|
132
|
+
}
|
|
133
|
+
export interface ITaskPaneAreaElement extends HTMLDivElement, ITaskPaneArea {
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* The TaskPaneArea is a React component that renders multiple task panes.
|
|
137
|
+
*
|
|
138
|
+
* Container component implements 2 interfaces. If
|
|
139
|
+
* implements the ITaskPaneArea interface to be given to the TaskPaneProvider
|
|
140
|
+
* and it implement the ITaskPaneParent to be given to the TaskPane component.
|
|
141
|
+
* This provides a simple implementation but can be swapped out later.
|
|
142
|
+
*/
|
|
143
|
+
export declare const TaskPaneArea: React.NamedExoticComponent<Omit<TaskPaneAreaProps<any>, "ref"> & React.RefAttributes<ITaskPaneAreaElement>>;
|
|
144
|
+
//# sourceMappingURL=TaskPaneArea.d.ts.map
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { RemoveListener } from '@sheetxl/utils';
|
|
3
|
+
import { IFrameContainerListener } from '../frame';
|
|
4
|
+
import { TaskPaneEntry } from './TaskPaneRegistry';
|
|
5
|
+
import { TaskPaneTitleProps } from './TaskPaneTitle';
|
|
6
|
+
export interface TaskPaneFrameProps extends React.HTMLAttributes<HTMLElement> {
|
|
7
|
+
entry: TaskPaneEntry;
|
|
8
|
+
model?: any;
|
|
9
|
+
/** The activating call's value bag — see {@link ActivateFrameOptions.args}. */
|
|
10
|
+
args?: any;
|
|
11
|
+
close?: () => void;
|
|
12
|
+
listenerContainer?: (listener: IFrameContainerListener) => RemoveListener;
|
|
13
|
+
/**
|
|
14
|
+
* If the values can be modified
|
|
15
|
+
*/
|
|
16
|
+
readOnly?: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* Allows for component to be autoFocused.
|
|
19
|
+
*
|
|
20
|
+
* @remarks
|
|
21
|
+
* If a string is provided this will be used as a querySelector to find the initial focusable component.
|
|
22
|
+
*/
|
|
23
|
+
autoFocusSel?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Props that can be injected to pane
|
|
26
|
+
*/
|
|
27
|
+
propsPane?: React.HTMLAttributes<HTMLDivElement>;
|
|
28
|
+
/**
|
|
29
|
+
* Allows users to Wrap pane children in Top level Context.
|
|
30
|
+
*
|
|
31
|
+
* @remarks
|
|
32
|
+
* Rendered as `<WrapperPane>{pane}</WrapperPane>` — a real component, hooks are allowed.
|
|
33
|
+
*/
|
|
34
|
+
wrapperPane?: React.ComponentType<{
|
|
35
|
+
children?: React.ReactNode;
|
|
36
|
+
}>;
|
|
37
|
+
/**
|
|
38
|
+
* Override the default title component.
|
|
39
|
+
*
|
|
40
|
+
* @remarks
|
|
41
|
+
* If the registry also provides a custom title component that will be used instead.
|
|
42
|
+
*/
|
|
43
|
+
componentTitle?: React.ComponentType<TaskPaneTitleProps>;
|
|
44
|
+
onMounted?: (entry: TaskPaneEntry) => void;
|
|
45
|
+
onUnmounted?: (entry: TaskPaneEntry) => void;
|
|
46
|
+
}
|
|
47
|
+
export declare const TaskPaneFrame: React.NamedExoticComponent<TaskPaneFrameProps & React.RefAttributes<HTMLDivElement>>;
|
|
48
|
+
//# sourceMappingURL=TaskPaneFrame.d.ts.map
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { ICommandDefinition, CommandButtonProps } from '@sheetxl/utils-react';
|
|
2
|
+
import { TaskPaneProps } from './ITaskPane';
|
|
3
|
+
import { TaskPaneTitleProps } from './TaskPaneTitle';
|
|
4
|
+
import { ITaskPaneArea } from './TaskPaneArea';
|
|
5
|
+
export interface TaskPaneEntry {
|
|
6
|
+
/**
|
|
7
|
+
* The unique key for the task pane.
|
|
8
|
+
*
|
|
9
|
+
* @remarks
|
|
10
|
+
* * Must not change.
|
|
11
|
+
*/
|
|
12
|
+
readonly key: string;
|
|
13
|
+
/**
|
|
14
|
+
* The command paths to use to open the task pane.
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* * Must not change.
|
|
18
|
+
* If this is not provided the task pane can only be opened programmatically.
|
|
19
|
+
*/
|
|
20
|
+
readonly contributionPoints?: string[];
|
|
21
|
+
/**
|
|
22
|
+
* The title to display to identify the task pane.
|
|
23
|
+
*/
|
|
24
|
+
getTitle(): string;
|
|
25
|
+
/**
|
|
26
|
+
* The icon to display to identify the task pane.
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
* This can be either a string (iconKey) or a React element.
|
|
30
|
+
*/
|
|
31
|
+
getIcon?(): React.ReactElement | string | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* The task pane component.
|
|
34
|
+
*
|
|
35
|
+
* @remarks
|
|
36
|
+
* This is rendered as a React element (`<Component {...props}/>`), so it is a real component:
|
|
37
|
+
* hooks are allowed, and it participates in reconciliation like any other component. The host's
|
|
38
|
+
* `ref` is delivered as a regular prop ({@link TaskPaneProps.ref}, React 19 style) — forward it
|
|
39
|
+
* to the pane's root element.
|
|
40
|
+
*/
|
|
41
|
+
component: React.ComponentType<TaskPaneProps>;
|
|
42
|
+
/**
|
|
43
|
+
* If `true`, the pane stays mounted (hidden with `display: none`) while another pane is active,
|
|
44
|
+
* instead of unmounting on switch. Opt in for panes that are expensive or fragile to (re)mount —
|
|
45
|
+
* the script editor, whose Monaco/CDN-loader/worker setup is built around a single mount lifecycle
|
|
46
|
+
* (remounting it re-runs the AMD loader shim + global juggling and re-creates the language workers,
|
|
47
|
+
* which fails on the way back). Leave unset for ordinary panes so they keep the default
|
|
48
|
+
* unmount-on-hide behavior (state resets, memory freed).
|
|
49
|
+
*
|
|
50
|
+
* @defaultValue false
|
|
51
|
+
*/
|
|
52
|
+
readonly keepMounted?: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* Optional component to render a custom title for the task pane.
|
|
55
|
+
*
|
|
56
|
+
* @remarks
|
|
57
|
+
* Rendered as a React element — hooks are allowed.
|
|
58
|
+
*/
|
|
59
|
+
componentTitle?: React.ComponentType<TaskPaneTitleProps>;
|
|
60
|
+
createCommand?(taskPaneArea: ITaskPaneArea): ICommandDefinition;
|
|
61
|
+
/**
|
|
62
|
+
* Optional component for a button that can be placed in the command bar.
|
|
63
|
+
*
|
|
64
|
+
* @remarks
|
|
65
|
+
* If not provided a default button will be created.
|
|
66
|
+
* Rendered as a React element — hooks are allowed.
|
|
67
|
+
*/
|
|
68
|
+
componentCommandButton?: React.ComponentType<CommandButtonProps>;
|
|
69
|
+
}
|
|
70
|
+
export interface ITaskPaneRegistry {
|
|
71
|
+
/**
|
|
72
|
+
* Registers a task pane container.
|
|
73
|
+
* @param entry The task pane entry.
|
|
74
|
+
* @param replace Whether to replace an existing task pane. Default is false.
|
|
75
|
+
*/
|
|
76
|
+
registerTaskPane(entry: TaskPaneEntry, replace?: boolean): void;
|
|
77
|
+
/**
|
|
78
|
+
* Unregister a task pane container.
|
|
79
|
+
*
|
|
80
|
+
* @param key The unique key for the task pane.
|
|
81
|
+
*/
|
|
82
|
+
unregisterTaskPane(key: string): void;
|
|
83
|
+
/**
|
|
84
|
+
* Gets a registered task pane container.
|
|
85
|
+
*
|
|
86
|
+
* @param key The unique key for the task pane.
|
|
87
|
+
* @returns The registered task pane or null if not found.
|
|
88
|
+
*/
|
|
89
|
+
getRegisteredTaskPane(key: string): TaskPaneEntry | null;
|
|
90
|
+
/**
|
|
91
|
+
* Finds contributions for a specific entry.
|
|
92
|
+
* @param contributionKey
|
|
93
|
+
*/
|
|
94
|
+
findContributions(contributionKey: string): TaskPaneEntry[];
|
|
95
|
+
}
|
|
96
|
+
declare class TaskPaneRegistry implements ITaskPaneRegistry {
|
|
97
|
+
protected _taskPanes: Map<string, TaskPaneEntry>;
|
|
98
|
+
/** @inheritdoc ITaskPaneRegistry.registerTaskPane */
|
|
99
|
+
registerTaskPane(entry: TaskPaneEntry, replace?: boolean): void;
|
|
100
|
+
/** @inheritdoc ITaskPaneRegistry.unregisterTaskPane */
|
|
101
|
+
unregisterTaskPane(key: string): void;
|
|
102
|
+
/** @inheritdoc ITaskPaneRegistry.getRegisteredTaskPane */
|
|
103
|
+
getRegisteredTaskPane(key: string): TaskPaneEntry | null;
|
|
104
|
+
findContributions(contributionKey: string): TaskPaneEntry[];
|
|
105
|
+
}
|
|
106
|
+
export declare const DefaultTaskPaneRegistry: TaskPaneRegistry;
|
|
107
|
+
export {};
|
|
108
|
+
//# sourceMappingURL=TaskPaneRegistry.d.ts.map
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ITaskPaneRegistry } from './TaskPaneRegistry';
|
|
3
|
+
export interface TaskPaneStripProps extends Omit<React.HTMLAttributes<HTMLElement>, 'onSelect' | 'selected'> {
|
|
4
|
+
taskPanes: readonly string[];
|
|
5
|
+
onSelect(key: string): void;
|
|
6
|
+
/** The active task-pane key, or `undefined` when none is active. */
|
|
7
|
+
selected?: string;
|
|
8
|
+
/**
|
|
9
|
+
* Allow for custom registry of task panes.
|
|
10
|
+
*/
|
|
11
|
+
registry?: ITaskPaneRegistry;
|
|
12
|
+
/**
|
|
13
|
+
* If true, only show icons in the strip (no text).
|
|
14
|
+
*/
|
|
15
|
+
iconsOnly?: boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Whether the layout should be right to left. This will flip the order of the panes and the direction of the split.
|
|
18
|
+
*
|
|
19
|
+
* @defaultValue 'left'
|
|
20
|
+
*/
|
|
21
|
+
side?: 'left' | 'right';
|
|
22
|
+
/**
|
|
23
|
+
* Ref to the task pane strip element.
|
|
24
|
+
*/
|
|
25
|
+
ref?: React.Ref<ITaskPaneStrip>;
|
|
26
|
+
}
|
|
27
|
+
export interface TaskPaneStripAttributes {
|
|
28
|
+
isTaskPaneStrip: () => true;
|
|
29
|
+
}
|
|
30
|
+
export interface ITaskPaneStrip extends HTMLDivElement, TaskPaneStripAttributes {
|
|
31
|
+
}
|
|
32
|
+
export declare const TaskPaneStrip: React.NamedExoticComponent<Omit<TaskPaneStripProps, "ref"> & React.RefAttributes<ITaskPaneStrip>>;
|
|
33
|
+
//# sourceMappingURL=TaskPaneStrip.d.ts.map
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export interface TaskPaneTitleProps extends Omit<React.HTMLAttributes<HTMLElement>, 'title'> {
|
|
3
|
+
title: React.ReactNode;
|
|
4
|
+
icon: React.ReactNode;
|
|
5
|
+
onClose: () => void;
|
|
6
|
+
readOnly: boolean;
|
|
7
|
+
/**
|
|
8
|
+
* If the task pane is focused
|
|
9
|
+
*/
|
|
10
|
+
focused: boolean;
|
|
11
|
+
/**
|
|
12
|
+
* Whether the layout should be right to left. This will flip the order of the panes and the direction of the split.
|
|
13
|
+
*
|
|
14
|
+
* @defaultValue 'left'
|
|
15
|
+
*/
|
|
16
|
+
side?: 'left' | 'right';
|
|
17
|
+
/**
|
|
18
|
+
* Reference to the underlying element.
|
|
19
|
+
*/
|
|
20
|
+
ref?: React.Ref<HTMLDivElement>;
|
|
21
|
+
}
|
|
22
|
+
declare const TaskPaneTitle: React.NamedExoticComponent<Omit<TaskPaneTitleProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
|
|
23
|
+
export { TaskPaneTitle };
|
|
24
|
+
//# sourceMappingURL=TaskPaneTitle.d.ts.map
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ITaskPaneArea, ITaskPaneAreaElement, TaskPaneAreaProps } from './TaskPaneArea';
|
|
3
|
+
import { ITaskPaneRegistry } from './TaskPaneRegistry';
|
|
4
|
+
/**
|
|
5
|
+
* Context provider for task panes. Allows custom task pane manager
|
|
6
|
+
* to be provided to components within the provider tree.
|
|
7
|
+
*
|
|
8
|
+
* ```tsx
|
|
9
|
+
* <TaskPaneProvider
|
|
10
|
+
* renderArea={(props) => <TaskPaneArea {...props} />}
|
|
11
|
+
* onUpdateArea={(area) => { }}
|
|
12
|
+
* >
|
|
13
|
+
* <App />
|
|
14
|
+
* </TaskPaneProvider>
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
export interface TaskPaneProviderProps {
|
|
18
|
+
children: React.ReactNode;
|
|
19
|
+
renderArea: (props: TaskPaneAreaProps) => React.ReactElement<ITaskPaneAreaElement>;
|
|
20
|
+
onUpdateArea: (area: React.ReactElement<ITaskPaneAreaElement> | null) => void;
|
|
21
|
+
registry?: ITaskPaneRegistry;
|
|
22
|
+
}
|
|
23
|
+
export declare const TaskPaneProvider: React.FC<TaskPaneProviderProps>;
|
|
24
|
+
/**
|
|
25
|
+
* Hook to get the task pane manager directly.
|
|
26
|
+
* Useful for registering new task panes or managing instances.
|
|
27
|
+
*/
|
|
28
|
+
export declare const useTaskPaneArea: (ignoreUpdates?: boolean) => ITaskPaneArea;
|
|
29
|
+
//# sourceMappingURL=useTaskPane.d.ts.map
|