@sheetxl/studio-mui 0.8.0-beta.1 → 0.8.0-beta.10
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/esm/{Cd6n1XUgF0VItpkH.mjs → 5cbK03T_Oh3tNdR7.mjs} +7 -5
- package/browser/esm/{Bz5LiUe3SZ8g42Ia.mjs → 9eKCkvqpMQwqcXiw.mjs} +1 -1
- package/browser/esm/B1Yp_uy1vFHcJB3U.mjs +13 -0
- package/browser/esm/Biy7bhzzzPb5sfRN.mjs +152 -0
- package/browser/esm/Blaj2R5hYxtLAW__.mjs +117 -0
- package/browser/esm/{ChwS_ougBsogOEsP.mjs → ByeL_BZuJ2kl8gtf.mjs} +46 -47
- package/browser/esm/{BUGepznywvV0tUjW.mjs → C1Rp2hZrApo5MUc8.mjs} +2 -2
- package/browser/esm/{DMLXV4EKl1NCp_jk.mjs → CEvZe2cZK-voZTif.mjs} +5 -5
- package/browser/esm/{BZBJG2tDdD3-VujP.mjs → CIu1bjPJe_x31Oww.mjs} +195 -174
- package/browser/esm/COv-m-c2byCgvU3M.mjs +14861 -0
- package/browser/esm/CjznclrKqJRi7u9O.mjs +77 -0
- package/browser/esm/{Cj2pgCNqBCGl4rTX.mjs → CoSiOS-og0zFw4Ws.mjs} +587 -556
- package/browser/esm/{rU8xNPVQtDSnujM-.mjs → CtEFHbzYNvYjDYvi.mjs} +7 -7
- package/browser/esm/D6S8kVTzOjCn0-SK.mjs +627 -0
- package/browser/esm/{DNDrQKMTzKzNMjl-.mjs → D8al_cJ4U-NgzwoK.mjs} +1 -1
- package/browser/esm/DBtc4lku0uHVcqWn.mjs +71 -0
- package/browser/esm/{BoLxSRdEWt-Yg2RI.mjs → DHY19rkSiiRZxShC.mjs} +130 -103
- package/browser/esm/{zWTZ8BvT4hjgC2ua.mjs → DU3J8Gcf-WpBxNYg.mjs} +11 -10
- package/browser/esm/Die9NXVFveHvcCT-.mjs +4205 -0
- package/browser/esm/{CVfuCNRpODUw04IH.mjs → DmCQbW4zwkT_Rq88.mjs} +1 -1
- package/browser/esm/IQLeaAbtGTipUsOD.mjs +516 -0
- package/browser/esm/{3ydDykDMtDYbfVVn.mjs → X1Db3b_7b_7OuCk6.mjs} +178 -129
- package/browser/esm/fb126BNj3F8URR19.mjs +225 -0
- package/browser/esm/index.mjs +418 -135
- package/browser/esm/sFOAxZpxXo-qvDSp.mjs +293 -0
- package/browser/esm/sam1KGQZ59B_fADz.mjs +1941 -0
- package/browser/esm/xKiLJKiLxto8SayF.mjs +256 -0
- package/browser/esm/yZxC4qUENOlMhVUH.mjs +68 -0
- package/licenses/dependencies.txt +58 -311
- package/node/esm/B8SQfjKjzYHLxzZR.mjs +632 -0
- package/node/esm/{DM7K7-284z-PczVz.mjs → BYVLi0md4AYuDsB_.mjs} +1 -1
- package/node/esm/BYsG3KYVmxSe_CIQ.mjs +294 -0
- package/node/esm/BYwXhrEwkRAt9nJS.mjs +71 -0
- package/node/esm/B_jRGdwGFkudwmL-.mjs +68 -0
- package/node/esm/Bb1sLMqXWKjdve23.mjs +77 -0
- package/node/esm/{BwZcoHDBmLPIVOT5.mjs → BcwMb6CyVfvEwbHn.mjs} +69 -70
- package/node/esm/{BhqI3pQFkV8K_612.mjs → CKu1AtRgyltyEdEN.mjs} +1 -1
- package/node/esm/Cmt8Wv806N7NmE4Y.mjs +3344 -0
- package/node/esm/{DXZrzWee8K5FPOW1.mjs → D6oQL8knsPpgdXuk.mjs} +2 -2
- package/node/esm/{BA7VzUQ2sKRLTZ5c.mjs → D9rzScOA9pEYFrtz.mjs} +1 -1
- package/node/esm/DNSjK5DAH3M14Qbc.mjs +521 -0
- package/node/esm/{CUMKTjYv6VTkcWYi.mjs → DZzvTQxIKr9LbEsA.mjs} +1 -1
- package/node/esm/{Qpuqm6xBr_da38Ht.mjs → ETK6T6G0SIcFXDe5.mjs} +163 -135
- package/node/esm/ah3CUg4-VmNstGk_.mjs +256 -0
- package/node/esm/{CHi3AuWEwEPOg9IZ.mjs → ci8d-mF1H9wnYzix.mjs} +1 -1
- package/node/esm/cqzp431iNSLWictb.mjs +116 -0
- package/node/esm/index.mjs +14783 -6793
- package/package.json +15 -18
- package/resources/locales/de/groups.cmd.json +29 -16
- package/resources/locales/de/studio.cmd.json +18 -1
- package/resources/locales/de/ui.msg.json +350 -40
- package/resources/locales/en/groups.cmd.json +39 -17
- package/resources/locales/en/studio.cmd.json +18 -1
- package/resources/locales/en/ui.msg.json +306 -40
- package/types/src/anchorItems/AnchorItemsDescriptor.d.ts +17 -1
- package/types/src/anchorItems/AnchorItemsPanel.d.ts +14 -0
- package/types/src/anchorItems/AnchoredRangeField.d.ts +40 -0
- package/types/src/anchorItems/index.d.ts +1 -0
- package/types/src/border/BorderPopupButton.d.ts +6 -6
- package/types/src/border/BorderStylePopupButton.d.ts +3 -3
- package/types/src/border/BorderTemplateIcon.d.ts +24 -0
- package/types/src/border/index.d.ts +1 -0
- package/types/src/color/ColorPanel.d.ts +8 -2
- package/types/src/color/ColorPopupButton.d.ts +2 -1
- package/types/src/command/NumberFormatQuickButtons.d.ts +32 -0
- package/types/src/command/PresetCellStylesCommandButton.d.ts +3 -3
- package/types/src/command/SheetZoomCommandButton.d.ts +4 -3
- package/types/src/comments/CommentCard.d.ts +41 -0
- package/types/src/comments/CommentsPlugin.d.ts +6 -0
- package/types/src/comments/CommentsTaskPane.d.ts +23 -0
- package/types/src/comments/index.d.ts +4 -0
- package/types/src/conditionalFormat/ConditionalFormatStylePicker.d.ts +4 -4
- package/types/src/conditionalFormat/IconPickerPopupButton.d.ts +2 -2
- package/types/src/conditionalFormat/IconSetRulePanel.d.ts +1 -1
- package/types/src/conditions/BetweenOption.d.ts +6 -1
- package/types/src/conditions/CombinatorOption.d.ts +7 -0
- package/types/src/conditions/ConditionEditor.d.ts +61 -4
- package/types/src/conditions/ConditionUtils.d.ts +65 -6
- package/types/src/conditions/ExpressionOption.d.ts +12 -6
- package/types/src/conditions/MembershipOption.d.ts +67 -0
- package/types/src/conditions/OperatorAndParamEditor.d.ts +36 -1
- package/types/src/conditions/ScalarOption.d.ts +25 -6
- package/types/src/conditions/SelectorSelect.d.ts +16 -7
- package/types/src/conditions/index.d.ts +1 -1
- package/types/src/conditions/useFormulaOption.d.ts +54 -0
- package/types/src/dataValidation/DataValidationDetailsPanel.d.ts +7 -1
- package/types/src/dataValidation/DataValidationDetailsTaskPane.d.ts +3 -2
- package/types/src/dataValidation/DataValidationEditorPanel.d.ts +13 -2
- package/types/src/dataValidation/DataValidationIcon.d.ts +22 -0
- package/types/src/dataValidation/DataValidationTitle.d.ts +13 -0
- package/types/src/dialog/FillSeriesDialog.d.ts +16 -0
- package/types/src/dialog/OutlineSettingsDialog.d.ts +12 -0
- package/types/src/dialog/TableNewDialog.d.ts +1 -4
- package/types/src/dialog/_ShortcutSearch.d.ts +26 -0
- package/types/src/dialog/index.d.ts +0 -2
- package/types/src/externalLink/ExternalLinkCardBody.d.ts +9 -0
- package/types/src/externalLink/ExternalLinkChip.d.ts +18 -0
- package/types/src/externalLink/ExternalLinkLocation.d.ts +18 -0
- package/types/src/externalLink/ExternalLinkSettingsTab.d.ts +18 -0
- package/types/src/externalLink/ExternalLinksPanel.d.ts +11 -0
- package/types/src/externalLink/ExternalLinksPlugin.d.ts +5 -0
- package/types/src/externalLink/ExternalLinksTaskPane.d.ts +19 -0
- package/types/src/externalLink/index.d.ts +8 -0
- package/types/src/fill/GradientEditor.d.ts +41 -0
- package/types/src/fill/GradientStopsBar.d.ts +43 -0
- package/types/src/fill/PatternPopupButton.d.ts +26 -0
- package/types/src/fill/PatternSwatch.d.ts +53 -0
- package/types/src/fill/index.d.ts +5 -0
- package/types/src/filter/ColumnMenu.d.ts +31 -1
- package/types/src/filter/index.d.ts +0 -1
- package/types/src/form/FormulaField.d.ts +35 -6
- package/types/src/form/InputField.d.ts +35 -5
- package/types/src/format/AlignmentPanel.d.ts +13 -0
- package/types/src/format/BorderPanel.d.ts +22 -0
- package/types/src/format/BorderPreview.d.ts +94 -0
- package/types/src/format/FillPanel.d.ts +65 -0
- package/types/src/format/FontPanel.d.ts +12 -0
- package/types/src/format/FormatCellPreview.d.ts +35 -0
- package/types/src/format/FormatPanelParts.d.ts +85 -0
- package/types/src/format/FormatPlugin.d.ts +11 -0
- package/types/src/format/FormatTaskPane.d.ts +39 -0
- package/types/src/format/LinePanel.d.ts +53 -0
- package/types/src/format/LinePreviews.d.ts +71 -0
- package/types/src/format/NumberFormatOption.d.ts +43 -0
- package/types/src/{numberFormat → format}/NumberFormatPanel.d.ts +20 -0
- package/types/src/format/index.d.ts +14 -0
- package/types/src/format/useFormatSelection.d.ts +93 -0
- package/types/src/formulaBar/IFormulaBar.d.ts +11 -0
- package/types/src/formulaBar/MobileFormulaBar.d.ts +21 -0
- package/types/src/formulaBar/MobileInputToolbar.d.ts +37 -0
- package/types/src/formulaBar/index.d.ts +3 -0
- package/types/src/formulaBar/useFormulaBarSession.d.ts +65 -0
- package/types/src/index.d.ts +7 -1
- package/types/src/itemsPanel/EditorCommit.d.ts +32 -0
- package/types/src/itemsPanel/EditorPanel.d.ts +4 -1
- package/types/src/itemsPanel/ItemCard.d.ts +60 -8
- package/types/src/itemsPanel/ItemsDescriptor.d.ts +68 -19
- package/types/src/itemsPanel/ItemsPanel.d.ts +9 -0
- package/types/src/itemsPanel/ItemsSearchField.d.ts +17 -0
- package/types/src/itemsPanel/index.d.ts +2 -0
- package/types/src/named/NamedDetailsPanel.d.ts +9 -2
- package/types/src/named/NamedDetailsTaskPane.d.ts +3 -2
- package/types/src/named/NamedEditorPanel.d.ts +1 -1
- package/types/src/named/NamedExpressionField.d.ts +32 -0
- package/types/src/named/NamedKindChip.d.ts +38 -0
- package/types/src/picture/PicturePlugin.d.ts +6 -0
- package/types/src/picture/index.d.ts +2 -0
- package/types/src/protectedRange/ProtectedRangeDetailsPanel.d.ts +6 -0
- package/types/src/protectedRange/ProtectedRangeDraft.d.ts +22 -0
- package/types/src/protectedRange/ProtectedRangeEditorPanel.d.ts +0 -14
- package/types/src/protectedRange/index.d.ts +2 -1
- package/types/src/protection/ManageProtectionTaskPane.d.ts +29 -0
- package/types/src/protection/PasswordDialog.d.ts +32 -0
- package/types/src/protection/PasswordField.d.ts +35 -0
- package/types/src/protection/ProtectedCellsPanel.d.ts +20 -0
- package/types/src/protection/ProtectionPlugin.d.ts +11 -0
- package/types/src/protection/SheetProtectionPanel.d.ts +35 -0
- package/types/src/protection/WorkbookProtectionPanel.d.ts +34 -15
- package/types/src/protection/WorkbookProtectionTab.d.ts +22 -0
- package/types/src/protection/index.d.ts +7 -1
- package/types/src/shape/InsertShapeCommandButton.d.ts +20 -0
- package/types/src/shape/ShapeFormatPanel.d.ts +11 -0
- package/types/src/shape/ShapePlugin.d.ts +6 -0
- package/types/src/shape/index.d.ts +3 -0
- package/types/src/slicer/PresetSlicerStylesCommandButton.d.ts +18 -0
- package/types/src/slicer/SlicerPlugin.d.ts +6 -0
- package/types/src/slicer/index.d.ts +3 -0
- package/types/src/statusBar/SheetZoomScale.d.ts +6 -0
- package/types/src/studio/CommandsWrapper.d.ts +5 -0
- package/types/src/studio/EagerStudio.d.ts +14 -1
- package/types/src/studio/StudioCommandProvider.d.ts +10 -0
- package/types/src/studio/StudioCommands.d.ts +40 -4
- package/types/src/studio/StudioProps.d.ts +64 -2
- package/types/src/studio/StudioSplitPane.d.ts +1 -1
- package/types/src/studio/formulaBarPlacement.d.ts +35 -0
- package/types/src/studio/splitStudioProps.d.ts +7 -0
- package/types/src/studio/useStudioApp.d.ts +31 -18
- package/types/src/template/TemplateCommands.d.ts +29 -0
- package/types/src/template/TemplateDialog.d.ts +19 -0
- package/types/src/template/TemplatePanel.d.ts +50 -0
- package/types/src/template/TemplateSearchField.d.ts +29 -0
- package/types/src/template/WelcomeDialog.d.ts +29 -0
- package/types/src/template/categoryColor.d.ts +8 -0
- package/types/src/template/index.d.ts +3 -0
- package/types/src/template/useTemplateCatalog.d.ts +71 -0
- package/types/src/toolbar/WorkbookToolbars.d.ts +1 -1
- package/types/src/workbook/DefaultRenderers.d.ts +15 -1
- package/types/src/workbook/FillMenu.d.ts +21 -0
- package/types/src/workbook/OutlineButtons.d.ts +11 -0
- package/types/src/workbook/WorkbookElement.d.ts +1 -1
- package/types/src/workbook/index.d.ts +1 -0
- package/browser/cjs/BQJKf40kttQWOzLw.cjs +0 -20
- package/browser/cjs/BTZ5uzK0wHzpiZGC.cjs +0 -1
- package/browser/cjs/B_D3JKseVvpRyX-E.cjs +0 -1
- package/browser/cjs/BeKpqOx8It0RD0Rf.cjs +0 -2
- package/browser/cjs/Bj-EvSYeDfqmU0V6.cjs +0 -2
- package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
- package/browser/cjs/Bte6P3MhSjajJmmY.cjs +0 -7
- package/browser/cjs/C97KHSuikAbr1qVM.cjs +0 -1
- package/browser/cjs/CJLwX_A3y3TQUmzj.cjs +0 -1
- package/browser/cjs/CPSc2VSYZeZ1B9mi.cjs +0 -1
- package/browser/cjs/CPcBvw4ZPwHVTUZF.cjs +0 -1
- package/browser/cjs/CYxc8vnRi8dNpDPk.cjs +0 -1
- package/browser/cjs/CZm1jVZaHQ246prW.cjs +0 -1
- package/browser/cjs/CdDYyAfccXme8w6m.cjs +0 -1
- package/browser/cjs/Cm1APq2MraYNNhyI.cjs +0 -1
- package/browser/cjs/DO8V31Z1ewgMA1di.cjs +0 -5
- package/browser/cjs/Djsiad0Qha1Y-YaS.cjs +0 -1
- package/browser/cjs/IASAYG6qgv7lJY7y.cjs +0 -1
- package/browser/cjs/KZvriGbhEOVkQD0b.cjs +0 -1
- package/browser/cjs/UnMhi28mbvLiOXQe.cjs +0 -1
- package/browser/cjs/Vbigo0kFP3PFfmeA.cjs +0 -1
- package/browser/cjs/iMWEL01eC83oU-YY.cjs +0 -1
- package/browser/cjs/index.cjs +0 -2
- package/browser/cjs/w2GjebPlOFv3pCbm.cjs +0 -1
- package/browser/cjs/z0rB4fK6X1M6PpVD.cjs +0 -11
- package/browser/cjs/zQsyZpeXAvcVXJMs.cjs +0 -1
- package/browser/esm/BuY3uV47Bwbqpasq.mjs +0 -219
- package/browser/esm/CAs1MWvJTcRfJy26.mjs +0 -217
- package/browser/esm/CBU3LgLYmqtQjJbu.mjs +0 -1150
- package/browser/esm/CDU0rqpLNVtMLI-f.mjs +0 -52
- package/browser/esm/CVBub6pgTsJzCc5m.mjs +0 -5429
- package/browser/esm/C_XvSsQ9BVdHffCO.mjs +0 -47
- package/browser/esm/FT29q8yNwsEpVZjt.mjs +0 -9257
- package/browser/esm/Hb1rlHT4tE5hLcjM.mjs +0 -82
- package/browser/esm/UJOXCQv6KrG1gY3l.mjs +0 -105
- package/browser/esm/s46El7mT6oKLSnYB.mjs +0 -411
- package/node/esm/9FY82fj1R1c-AczW.mjs +0 -47
- package/node/esm/C-boHCnJditFzng3.mjs +0 -106
- package/node/esm/DxXM8qHi0Oz4Zovl.mjs +0 -4575
- package/node/esm/sQt2wWGTRLzqeJdG.mjs +0 -82
- package/node/esm/yCHAZKxJR7qY_ySy.mjs +0 -470
- package/types/src/conditionalFormat/ConditionalFormatRangeField.d.ts +0 -32
- package/types/src/conditions/DateTimeOption.d.ts +0 -43
- package/types/src/conditions/InSetOption.d.ts +0 -37
- package/types/src/dialog/CommentsDialog.d.ts +0 -11
- package/types/src/dialog/NumberFormatDialog.d.ts +0 -12
- package/types/src/filter/FilterList.d.ts +0 -28
- package/types/src/numberFormat/NumberFormatTaskPane.d.ts +0 -12
- package/types/src/numberFormat/index.d.ts +0 -8
- package/types/src/protectedRange/ProtectedRangeDetailsTaskPane.d.ts +0 -3
- package/types/src/protectedRange/ProtectedRangePlugin.d.ts +0 -2
- package/types/src/protection/WorkbookProtectionDialog.d.ts +0 -23
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Registers the **Manage Protection** pane.
|
|
3
|
+
*
|
|
4
|
+
* @remarks
|
|
5
|
+
* Replaces `ProtectedRangePlugin`. The retired `protectedRangeDetails` key stays registered as an
|
|
6
|
+
* alias so a host that activates it by name still lands somewhere sensible — the same pane, opened
|
|
7
|
+
* on Ranges. Nothing in the product references it any more; `manageProtectedRange` (the
|
|
8
|
+
* Data ribbon and the context menu) opens `manageProtection` with the tab as its argument.
|
|
9
|
+
*/
|
|
10
|
+
export declare const ProtectionPlugin: () => void;
|
|
11
|
+
//# sourceMappingURL=ProtectionPlugin.d.ts.map
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ISheet } from '@sheetxl/sdk';
|
|
3
|
+
export interface SheetProtectionPanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
/** The sheet whose protection is edited. */
|
|
5
|
+
sheet: ISheet;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* The **Sheet** tab of Manage Protection: protect / pause / highlight, the password, and the
|
|
9
|
+
* options.
|
|
10
|
+
*
|
|
11
|
+
* @remarks
|
|
12
|
+
* **Nothing here has an Apply button.** Excel has none either — its dialog has OK, which this pane
|
|
13
|
+
* is not. Every control commits the moment it is used:
|
|
14
|
+
* - the two switches and the pause button act immediately;
|
|
15
|
+
* - the password is a dialog; confirming it stages the password for the Protect switch, since an
|
|
16
|
+
* unprotected sheet keeps no hash ({@link PasswordField});
|
|
17
|
+
* - an option checkbox writes through `setProperties` — the unprotected sheet keeps its options (and
|
|
18
|
+
* saves them) for the next `lock()`.
|
|
19
|
+
*
|
|
20
|
+
* While the sheet is locked, neither the password nor the options can change: the model refuses, and
|
|
21
|
+
* both are disabled with the instruction Excel gives — unprotect first. A pause is a temporary
|
|
22
|
+
* unprotect that already asked for the password, so the options open up again; the password stays
|
|
23
|
+
* disabled, since only `lock()` writes a hash.
|
|
24
|
+
*
|
|
25
|
+
* The options are collapsed by default; expanded they take the rest of the pane and scroll inside
|
|
26
|
+
* themselves. Fifteen checkboxes are a rare edit, and letting them push the toggles off the top made
|
|
27
|
+
* the common ones the hard ones.
|
|
28
|
+
*
|
|
29
|
+
* Three states for the sheet, not two. `isLocked()` reads false while paused — correct for
|
|
30
|
+
* enforcement, wrong for chrome — so this reads `isPaused()` separately: the Protect switch stays
|
|
31
|
+
* on and a banner says why nothing is being enforced.
|
|
32
|
+
*/
|
|
33
|
+
export declare const SheetProtectionPanel: React.NamedExoticComponent<SheetProtectionPanelProps & React.RefAttributes<HTMLDivElement>>;
|
|
34
|
+
export default SheetProtectionPanel;
|
|
35
|
+
//# sourceMappingURL=SheetProtectionPanel.d.ts.map
|
|
@@ -1,28 +1,42 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
export declare namespace WorkbookProtectionPanel {
|
|
3
3
|
/**
|
|
4
|
-
* What the panel
|
|
4
|
+
* What the panel renders.
|
|
5
5
|
*
|
|
6
6
|
* @remarks
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* a
|
|
7
|
+
* Booleans only — the panel never holds a password. Encryption's lives on the io handle and
|
|
8
|
+
* structure's was only ever a hash, and neither can be read back, so "is there one" is the whole
|
|
9
|
+
* of what a UI can honestly show. Typing happens in {@link PasswordDialog}.
|
|
10
10
|
*/
|
|
11
11
|
interface Value {
|
|
12
|
-
/**
|
|
13
|
-
|
|
14
|
-
encryptPassword: string | null;
|
|
12
|
+
/** The file is encrypted: its contents cannot be read without the password. */
|
|
13
|
+
hasEncryptPassword: boolean;
|
|
15
14
|
/** Lock the workbook's structure — a gate the UI honours; it does not hide the data. */
|
|
16
15
|
structure: boolean;
|
|
17
|
-
|
|
16
|
+
hasStructurePassword: boolean;
|
|
18
17
|
lockStructure: boolean;
|
|
19
18
|
lockWindows: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Whether the structure locks can be edited.
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* `false` on a protected workbook: the model refuses option changes until it is unprotected,
|
|
24
|
+
* which is Excel's answer too.
|
|
25
|
+
*/
|
|
26
|
+
locksEditable: boolean;
|
|
20
27
|
}
|
|
21
28
|
interface Props {
|
|
22
29
|
value: Value;
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
30
|
+
/** Every callback commits — there is no Apply. */
|
|
31
|
+
onEncryptPassword(password: string, current?: string): void;
|
|
32
|
+
onEncryptPasswordClear(): void;
|
|
33
|
+
onStructureChange(enabled: boolean): void;
|
|
34
|
+
onStructurePassword(password: string, current?: string): void;
|
|
35
|
+
onStructurePasswordClear(): void;
|
|
36
|
+
onLocksChange(locks: {
|
|
37
|
+
lockStructure: boolean;
|
|
38
|
+
lockWindows: boolean;
|
|
39
|
+
}): void;
|
|
26
40
|
sx?: any;
|
|
27
41
|
}
|
|
28
42
|
}
|
|
@@ -30,8 +44,8 @@ export declare namespace WorkbookProtectionPanel {
|
|
|
30
44
|
* Edits a workbook's two, genuinely different, protections in one place.
|
|
31
45
|
*
|
|
32
46
|
* @remarks
|
|
33
|
-
* Presentational
|
|
34
|
-
*
|
|
47
|
+
* Presentational — no model or IO access — so the layout stays testable on its own and the tab
|
|
48
|
+
* around it owns every write.
|
|
35
49
|
*
|
|
36
50
|
* The two halves are grouped together because a user thinking "protect this workbook" means either,
|
|
37
51
|
* and split visibly because they are not the same thing at all:
|
|
@@ -43,8 +57,13 @@ export declare namespace WorkbookProtectionPanel {
|
|
|
43
57
|
* which puts them in unrelated parts of its UI and reliably misleads people into thinking
|
|
44
58
|
* "Protect Workbook" encrypts. Grouping by intent and labelling by effect is the fix.
|
|
45
59
|
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
60
|
+
* Encryption has no switch of its own: it IS its password, so setting one encrypts and clearing it
|
|
61
|
+
* decrypts. Structure keeps its switch because it can be protected without a password.
|
|
62
|
+
*
|
|
63
|
+
* Nothing here has an Apply button, for the same reason the Sheet tab does not: every control is
|
|
64
|
+
* one unambiguous act, and a pane is not a dialog. Encryption still only reaches the FILE on the
|
|
65
|
+
* next save — but the intent is recorded the moment it is given, and an Apply button never changed
|
|
66
|
+
* that.
|
|
48
67
|
*/
|
|
49
68
|
export declare const WorkbookProtectionPanel: React.NamedExoticComponent<WorkbookProtectionPanel.Props & React.RefAttributes<HTMLDivElement>>;
|
|
50
69
|
export default WorkbookProtectionPanel;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorkbook } from '@sheetxl/sdk';
|
|
3
|
+
export interface WorkbookProtectionTabProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
/** The workbook whose protection is edited. */
|
|
5
|
+
workbook: IWorkbook;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* The **Workbook** tab of Manage Protection — {@link WorkbookProtectionPanel} bound to the model.
|
|
9
|
+
*
|
|
10
|
+
* @remarks
|
|
11
|
+
* No Apply button, for the same reason the Sheet tab has none: every control is one unambiguous act,
|
|
12
|
+
* and a pane is not a dialog. Encryption still only reaches the FILE on the next save — but that is
|
|
13
|
+
* about when bytes are written, not about when the intent is recorded, and `origin.setPassword` has
|
|
14
|
+
* always recorded it the moment it is given. An Apply button in front of that only added a step.
|
|
15
|
+
*
|
|
16
|
+
* The two halves commit through different objects: structure is a model change
|
|
17
|
+
* (`IWorkbookProtection`, effective at once), encryption is a property of the io handle. See
|
|
18
|
+
* `PROTECTION-DESIGN.md` §5g.
|
|
19
|
+
*/
|
|
20
|
+
export declare const WorkbookProtectionTab: React.NamedExoticComponent<WorkbookProtectionTabProps & React.RefAttributes<HTMLDivElement>>;
|
|
21
|
+
export default WorkbookProtectionTab;
|
|
22
|
+
//# sourceMappingURL=WorkbookProtectionTab.d.ts.map
|
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
export * from './PasswordDialog';
|
|
2
|
+
export * from './PasswordField';
|
|
1
3
|
export * from './WorkbookProtectionPanel';
|
|
2
|
-
export * from './
|
|
4
|
+
export * from './SheetProtectionPanel';
|
|
5
|
+
export * from './ProtectedCellsPanel';
|
|
6
|
+
export * from './WorkbookProtectionTab';
|
|
7
|
+
export * from './ManageProtectionTaskPane';
|
|
8
|
+
export * from './ProtectionPlugin';
|
|
3
9
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
|
|
2
|
+
export interface InsertShapeCommandButtonProps extends CommandPopupButtonProps {
|
|
3
|
+
/**
|
|
4
|
+
* The command a pick runs, with the entry's JSON. Its label, description and enablement are the
|
|
5
|
+
* button's.
|
|
6
|
+
* @defaultValue `'insertShape'`
|
|
7
|
+
*/
|
|
8
|
+
commandKey?: string;
|
|
9
|
+
/** Gallery sections to leave out, by key: Change Shape has no `lines`. */
|
|
10
|
+
excludeCategories?: readonly string[];
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Insert > Shapes: a popup gallery of the preset shapes by section, as Excel lays it out. Picking
|
|
14
|
+
* one runs `insertShape` with what the entry states. Entries picked here are remembered by key,
|
|
15
|
+
* most recent first, in a Recently Used Shapes section shown above the gallery once there are any.
|
|
16
|
+
*
|
|
17
|
+
* The same gallery runs another command with `commandKey`, as the Shape tab's Change Shape does.
|
|
18
|
+
*/
|
|
19
|
+
export declare const InsertShapeCommandButton: import('react').NamedExoticComponent<Omit<InsertShapeCommandButtonProps, "ref"> & import('react').RefAttributes<HTMLElement>>;
|
|
20
|
+
//# sourceMappingURL=InsertShapeCommandButton.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { MovablePaneProps } from '@sheetxl/react';
|
|
3
|
+
/**
|
|
4
|
+
* The body of the format pane for a shape: Excel's Fill & Line, applying live to the shape.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* The Fill controls are the Format Cells pane's, bound to the shape's style instead of the
|
|
8
|
+
* selection's cells (see {@link FillSelection}); the Line controls are the shape's own.
|
|
9
|
+
*/
|
|
10
|
+
export declare const ShapeFormatPanel: React.MemoExoticComponent<(props: MovablePaneProps) => React.JSX.Element>;
|
|
11
|
+
//# sourceMappingURL=ShapeFormatPanel.d.ts.map
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
|
|
3
|
+
export interface PresetSlicerStylesCommandButtonProps extends CommandPopupButtonProps {
|
|
4
|
+
/** The command a style is applied with; it takes the style's name. */
|
|
5
|
+
commandKey: string;
|
|
6
|
+
/**
|
|
7
|
+
* A command the button runs when pressed, with no style: the gallery is then a dropdown beside it.
|
|
8
|
+
* The style outlined is that of the first slicer the context's `slicers` lists, else the
|
|
9
|
+
* workbook's default. As the Insert Slicer button uses it.
|
|
10
|
+
*/
|
|
11
|
+
quickCommandKey?: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* The slicer-style gallery: every slicer style drawn as a small slicer, grouped Custom, Light, Other
|
|
15
|
+
* and Dark, the slicer's own style outlined. Picking one applies it to the active slicer.
|
|
16
|
+
*/
|
|
17
|
+
export declare const PresetSlicerStylesCommandButton: React.NamedExoticComponent<Omit<PresetSlicerStylesCommandButtonProps, "ref"> & React.RefAttributes<HTMLElement>>;
|
|
18
|
+
//# sourceMappingURL=PresetSlicerStylesCommandButton.d.ts.map
|
|
@@ -6,6 +6,12 @@ export interface SheetZoomScaleProps extends BoxProps {
|
|
|
6
6
|
* @defaultValue 220
|
|
7
7
|
*/
|
|
8
8
|
debounceDelay?: number;
|
|
9
|
+
/**
|
|
10
|
+
* Show the −/slider/+ trio beside the zoom percent. When omitted it hides itself on small screens
|
|
11
|
+
* (below the `sm` breakpoint): a phone has pinch and the percent's menu, and the slider is a worse
|
|
12
|
+
* version of the gesture that eats status-bar width.
|
|
13
|
+
*/
|
|
14
|
+
showSlider?: boolean;
|
|
9
15
|
}
|
|
10
16
|
export declare const SheetZoomScale: React.NamedExoticComponent<Omit<SheetZoomScaleProps, "ref"> & React.RefAttributes<HTMLElement>>;
|
|
11
17
|
//# sourceMappingURL=SheetZoomScale.d.ts.map
|
|
@@ -3,6 +3,7 @@ import { IWorkbook } from '@sheetxl/sdk';
|
|
|
3
3
|
import { Command } from '@sheetxl/utils-react';
|
|
4
4
|
import { WorkbookElementProps } from '@sheetxl/react';
|
|
5
5
|
import { IDocumentTitleElement } from '../workbook';
|
|
6
|
+
import { StudioIODeps } from './StudioCommands';
|
|
6
7
|
import { StudioProps } from './StudioProps';
|
|
7
8
|
export interface CommandsWrapperProps extends Omit<StudioProps, 'workbook'> {
|
|
8
9
|
/**
|
|
@@ -27,6 +28,10 @@ export interface CommandsWrapperProps extends Omit<StudioProps, 'workbook'> {
|
|
|
27
28
|
refDocumentTitle: React.RefObject<IDocumentTitleElement | null>;
|
|
28
29
|
/** Live unsaved-changes probe (read at click time); drives close/open confirm. */
|
|
29
30
|
isDirty: () => boolean;
|
|
31
|
+
/** Receives the studio's Save, for `IStudioAttributes.save`. */
|
|
32
|
+
refSave?: StudioIODeps['refSave'];
|
|
33
|
+
/** The studio root element; the target of the fullscreen toggle. */
|
|
34
|
+
host?: HTMLElement | null;
|
|
30
35
|
}
|
|
31
36
|
/**
|
|
32
37
|
* Because snackbar is configured using a context provider we have to create
|
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
import { StudioProps, IStudioElement } from './StudioProps';
|
|
3
|
-
|
|
3
|
+
/**
|
|
4
|
+
* The studio's content, rendered into a root element owned by {@link Studio}.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* The root must exist before this (lazily loaded) module does, so the startup loading panel can live
|
|
8
|
+
* inside it and consumer `className` / `style` / `sx` apply to a single element from the first render.
|
|
9
|
+
*/
|
|
10
|
+
export interface EagerStudioProps extends StudioProps {
|
|
11
|
+
/** The root element rendered by {@link Studio}; decorated with the {@link IStudioAttributes}. */
|
|
12
|
+
host: HTMLDivElement | null;
|
|
13
|
+
/** The per-instance theme scope class carried by {@link EagerStudioProps.host}. */
|
|
14
|
+
scopeClass: string;
|
|
15
|
+
}
|
|
16
|
+
export declare const EagerStudio: React.NamedExoticComponent<EagerStudioProps & React.RefAttributes<IStudioElement>>;
|
|
4
17
|
export default EagerStudio;
|
|
5
18
|
//# sourceMappingURL=EagerStudio.d.ts.map
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ReactNode } from 'react';
|
|
2
2
|
import { IWorkbook } from '@sheetxl/sdk';
|
|
3
3
|
import { WorkbookInput } from '@sheetxl/react';
|
|
4
|
+
import { StudioIODeps } from './StudioCommands';
|
|
4
5
|
/** Studio app-shell state the bridge threads into the file-I/O commands (from `CommandsWrapper`). */
|
|
5
6
|
export interface StudioCommandProviderProps {
|
|
6
7
|
children: ReactNode;
|
|
@@ -12,6 +13,15 @@ export interface StudioCommandProviderProps {
|
|
|
12
13
|
workbookTitle?: string | null;
|
|
13
14
|
/** Live unsaved-changes probe (read at click time) — drives close/open confirm. */
|
|
14
15
|
isDirty?: () => boolean;
|
|
16
|
+
/** Receives the studio's Save, for {@link IStudioAttributes.save}. */
|
|
17
|
+
refSave?: StudioIODeps['refSave'];
|
|
18
|
+
/**
|
|
19
|
+
* The element the fullscreen toggle makes fullscreen — the studio root, so the studio fills the screen
|
|
20
|
+
* rather than the host page.
|
|
21
|
+
*
|
|
22
|
+
* @defaultValue `document.documentElement`
|
|
23
|
+
*/
|
|
24
|
+
fullscreenTarget?: HTMLElement | null;
|
|
15
25
|
}
|
|
16
26
|
/**
|
|
17
27
|
* **Studio command bridge** — the studio slice. Registers the studio catalog + contributes help /
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { RemoveListener } from '@sheetxl/utils';
|
|
2
|
-
import { IWorkbook } from '@sheetxl/sdk';
|
|
2
|
+
import { IWorkbook, IWorkbookIO } from '@sheetxl/sdk';
|
|
3
3
|
import { Command, IReactNotifier, ThemeMode } from '@sheetxl/utils-react';
|
|
4
|
-
import { WorkbookInput } from '@sheetxl/react';
|
|
4
|
+
import { WorkbookInput, ActivateFrameOptions } from '@sheetxl/react';
|
|
5
|
+
import { StudioSaveOptions } from './StudioProps';
|
|
5
6
|
/**
|
|
6
7
|
* A port of the **studio**-level commands (`useStudioCommands`) — file I/O, theme,
|
|
7
8
|
* help. This is the **placeholder** for the studio slice of the port; only the help/shortcuts family
|
|
@@ -25,7 +26,7 @@ export interface ContributeStudioCommandsHandlers {
|
|
|
25
26
|
* the {@link Command.CommandContribution} handle, so `contribution.remove()` tears it down.
|
|
26
27
|
*/
|
|
27
28
|
export declare function contributeStudioCommands(contribution: Command.CommandContribution, handlers: ContributeStudioCommandsHandlers): void;
|
|
28
|
-
/** The resolved appearance state the bridge threads in (from `
|
|
29
|
+
/** The resolved appearance state the bridge threads in (from `usePersistentState` + theme hooks). */
|
|
29
30
|
export interface StudioAppearanceState {
|
|
30
31
|
/** The persisted mode override (`null` = follow system). */
|
|
31
32
|
mode: ThemeMode | null;
|
|
@@ -42,7 +43,7 @@ export interface StudioAppearanceState {
|
|
|
42
43
|
/**
|
|
43
44
|
* Contribute the studio **appearance** toggles — light/dark mode, system-default, dark-grid, dark-images.
|
|
44
45
|
* Their `state`/`label`/`icon` are dynamic, so this re-runs when the appearance state changes (the bridge
|
|
45
|
-
* owns the `
|
|
46
|
+
* owns the `usePersistentState` and re-invokes on change). Ported from `useStudioCommands` L569-600.
|
|
46
47
|
*/
|
|
47
48
|
export declare function contributeStudioAppearance(contribution: Command.CommandContribution, s: StudioAppearanceState): void;
|
|
48
49
|
/** The UI-language state the bridge threads in (from `DefaultLanguagePackService`). */
|
|
@@ -74,6 +75,34 @@ export interface StudioFullScreenState {
|
|
|
74
75
|
* disallows fullscreen, so the bridge re-runs this on change.
|
|
75
76
|
*/
|
|
76
77
|
export declare function contributeStudioFullScreen(contribution: Command.CommandContribution, s: StudioFullScreenState): void;
|
|
78
|
+
/**
|
|
79
|
+
* Protect Workbook: BOTH protections behind one entry, deliberately.
|
|
80
|
+
*
|
|
81
|
+
* @remarks
|
|
82
|
+
* Excel splits them by storage mechanism - encryption is the file container, structure is XML inside
|
|
83
|
+
* the package - and so puts them in unrelated parts of its UI. That is an implementation detail
|
|
84
|
+
* deciding menu placement, and it reliably leads people to believe "Protect Workbook" encrypts.
|
|
85
|
+
* Grouped by intent here, labelled by effect in the panel.
|
|
86
|
+
*
|
|
87
|
+
* The command now OPENS the Workbook tab of Manage Protection rather than a dialog of its own; the
|
|
88
|
+
* key and the File-menu entry stay exactly where they were. Contributed here, and not with the file
|
|
89
|
+
* commands, because it is neither io nor a workbook mutation - it is a pane opener that happens to
|
|
90
|
+
* carry a studio-catalog key.
|
|
91
|
+
*/
|
|
92
|
+
export declare function contributeStudioProtection(contribution: Command.CommandContribution, activateTaskPane: (key: string, options?: ActivateFrameOptions) => void): void;
|
|
93
|
+
/** What `openWorkbookFromUrl` accepts in place of a bare URL. */
|
|
94
|
+
export interface OpenWorkbookFromUrlArgs {
|
|
95
|
+
url: string;
|
|
96
|
+
/** The name to give the opened workbook. Defaults to the URL's file name. */
|
|
97
|
+
title?: string;
|
|
98
|
+
}
|
|
99
|
+
/** What `newWorkbook` accepts to start from an existing workbook rather than a blank one. */
|
|
100
|
+
export interface NewWorkbookArgs {
|
|
101
|
+
/** The URL of the workbook to start from. */
|
|
102
|
+
source?: string;
|
|
103
|
+
/** The name to give the new workbook. Defaults to the source's file name. */
|
|
104
|
+
title?: string;
|
|
105
|
+
}
|
|
77
106
|
/**
|
|
78
107
|
* The studio **app-shell** dependencies the file-I/O commands need — threaded from `CommandsWrapper` via
|
|
79
108
|
* `StudioCommandProvider` (they live in the studio shell, not the workbook model).
|
|
@@ -95,6 +124,13 @@ export interface StudioIODeps {
|
|
|
95
124
|
isDirty: () => boolean;
|
|
96
125
|
/** Busy / error / confirm UI. */
|
|
97
126
|
notifier: IReactNotifier;
|
|
127
|
+
/**
|
|
128
|
+
* Receives the studio's Save while the backing store can write, and `null` otherwise — what
|
|
129
|
+
* {@link IStudioAttributes.save} runs.
|
|
130
|
+
*/
|
|
131
|
+
refSave?: {
|
|
132
|
+
current: ((options?: StudioSaveOptions) => Promise<IWorkbookIO.Origin | null>) | null;
|
|
133
|
+
};
|
|
98
134
|
}
|
|
99
135
|
/**
|
|
100
136
|
* Contribute the studio **file-I/O** commands (the "studio slog", Batch 3) — `newWorkbook` /
|
|
@@ -6,7 +6,7 @@ import { TaskPaneAreaProps, ITaskPaneAreaElement, IWorkbookElement, WorkbookElem
|
|
|
6
6
|
import { ExplicitTokens } from '../theme/ThemeUtils';
|
|
7
7
|
import { DocumentTitleProps } from '../workbook';
|
|
8
8
|
import { WorkbookToolbarsProps } from '../toolbar';
|
|
9
|
-
import { FormulaBarProps, IFormulaBarElement } from '../formulaBar';
|
|
9
|
+
import { FormulaBarProps, IFormulaBarElement, FormulaBarPlacement } from '../formulaBar';
|
|
10
10
|
import { StatusBarProps } from '../statusBar';
|
|
11
11
|
/**
|
|
12
12
|
* Properties for the Studio component.
|
|
@@ -137,6 +137,32 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
137
137
|
* Render a custom formula bar (replaces the default).
|
|
138
138
|
*/
|
|
139
139
|
renderFormulaBar?: (props: FormulaBarProps) => React.ReactElement;
|
|
140
|
+
/**
|
|
141
|
+
* Where the formula bar sits: above the grid, or below it directly above the status bar, the way
|
|
142
|
+
* a phone spreadsheet lays it out.
|
|
143
|
+
*
|
|
144
|
+
* @defaultValue `'auto'` — `'bottom'` on a device whose primary pointer is a finger (a phone, a
|
|
145
|
+
* tablet), `'top'` everywhere else, including on the server.
|
|
146
|
+
*
|
|
147
|
+
* @remarks
|
|
148
|
+
* `'auto'` reads the device's primary pointer once, not the live input: a tablet that gets a mouse
|
|
149
|
+
* plugged in keeps its bar where it is. Force a value to develop the phone layout under device
|
|
150
|
+
* emulation, or when the host knows better than the device test.
|
|
151
|
+
*/
|
|
152
|
+
formulaBarPlacement?: FormulaBarPlacement | 'auto';
|
|
153
|
+
/**
|
|
154
|
+
* Whether the studio sizes itself to the visual viewport while the formula bar is at the bottom,
|
|
155
|
+
* so the bar stays above the virtual keyboard.
|
|
156
|
+
*
|
|
157
|
+
* @defaultValue `true`
|
|
158
|
+
*
|
|
159
|
+
* @remarks
|
|
160
|
+
* iOS Safari does not shrink the page for the keyboard; it scrolls the focused field into view
|
|
161
|
+
* instead. The studio undoes that: it takes the visual viewport's height, pins itself to the
|
|
162
|
+
* visual viewport's offset and scrolls the page back to the top after each keyboard change.
|
|
163
|
+
* A host page that already manages the keyboard turns this off. Ignored while the bar is at the top.
|
|
164
|
+
*/
|
|
165
|
+
manageVisualViewport?: boolean;
|
|
140
166
|
/**
|
|
141
167
|
* The shared cell editor. Supply a stable {@link SheetEditable} to drive the grid and
|
|
142
168
|
* formula bar through one instance (free two-way sync); omit to let the studio auto-create one.
|
|
@@ -197,7 +223,7 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
197
223
|
* @remarks
|
|
198
224
|
* This is *config*, not state. Light/dark **mode** and the dark-grid/dark-image toggles are self-managed by
|
|
199
225
|
* Studio as persisted preferences (see {@link @sheetxl/react!ThemeStateKey}), driven by the surrounding
|
|
200
|
-
* `
|
|
226
|
+
* `PersistentStateProvider` — not by props. A wrapping `TokenThemeProvider` layers token overrides on top.
|
|
201
227
|
*/
|
|
202
228
|
muiTheme?: ThemeOptions;
|
|
203
229
|
/**
|
|
@@ -249,6 +275,16 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
249
275
|
* This will only be used the first time.
|
|
250
276
|
*/
|
|
251
277
|
licenseKey?: string;
|
|
278
|
+
/**
|
|
279
|
+
* Whether features are loaded ahead of use once the studio is showing, so their first use does
|
|
280
|
+
* not wait on the network; see {@link WorkbookElementProps.prefetch}.
|
|
281
|
+
*
|
|
282
|
+
* @remarks
|
|
283
|
+
* The script editor and its compiler are always loaded on first use.
|
|
284
|
+
*
|
|
285
|
+
* @defaultValue 'auto'
|
|
286
|
+
*/
|
|
287
|
+
prefetch?: boolean | 'auto';
|
|
252
288
|
/**
|
|
253
289
|
* MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
|
|
254
290
|
*/
|
|
@@ -281,11 +317,37 @@ export type WorkbookLoadState = {
|
|
|
281
317
|
* {@link IWorkbookElement} rather than being one — reach the chrome-free grid via
|
|
282
318
|
* {@link IStudioAttributes.getWorkbookElement}.
|
|
283
319
|
*/
|
|
320
|
+
/**
|
|
321
|
+
* Options for {@link IStudioAttributes.save}.
|
|
322
|
+
*/
|
|
323
|
+
export interface StudioSaveOptions {
|
|
324
|
+
/**
|
|
325
|
+
* Decides on a write that would lose something, in place of the studio's own dialog.
|
|
326
|
+
*
|
|
327
|
+
* @remarks
|
|
328
|
+
* For a host that cannot show the studio right now — an editor tab in the background, saved by
|
|
329
|
+
* the host's "Save All" — and so asks the user its own way. Omitted, the studio shows its dialog.
|
|
330
|
+
*/
|
|
331
|
+
onWarnings?: IWorkbookIO.WriteOptions['onWarnings'];
|
|
332
|
+
}
|
|
284
333
|
export interface IStudioAttributes {
|
|
285
334
|
/**
|
|
286
335
|
* For runtime type checking.
|
|
287
336
|
*/
|
|
288
337
|
isStudioElement: () => true;
|
|
338
|
+
/**
|
|
339
|
+
* Saves the workbook exactly as the studio's own Save does — back to its origin, or asking where
|
|
340
|
+
* when it has none — including the studio's dialog when the write would lose something.
|
|
341
|
+
*
|
|
342
|
+
* @returns The origin written, or `null` when the save was cancelled (a dismissed picker, a
|
|
343
|
+
* declined lossy write).
|
|
344
|
+
*
|
|
345
|
+
* @remarks
|
|
346
|
+
* For a host that owns the save gesture (a VS Code extension's native Save) and needs the studio's
|
|
347
|
+
* behavior plus the outcome. A failure rejects with the error rather than showing it, so the host
|
|
348
|
+
* can report it its own way. Rejects when the active backing store cannot write.
|
|
349
|
+
*/
|
|
350
|
+
save(options?: StudioSaveOptions): Promise<IWorkbookIO.Origin | null>;
|
|
289
351
|
/**
|
|
290
352
|
* Retrieve the chrome-free workbook grid element contained by this studio.
|
|
291
353
|
*
|
|
@@ -29,7 +29,7 @@ export interface StudioSplitPaneProps extends React.HTMLAttributes<HTMLDivElemen
|
|
|
29
29
|
*/
|
|
30
30
|
position?: number | string | Partial<Record<SplitPaneLayoutKey, number>>;
|
|
31
31
|
/**
|
|
32
|
-
* When set, the split position is self-managed and persisted under this key (via `
|
|
32
|
+
* When set, the split position is self-managed and persisted under this key (via `usePersistentState`
|
|
33
33
|
* against the surrounding persistence store) as a per-slot map. The resized position of each layout slot
|
|
34
34
|
* (horizontal vs vertical split, and eventually before/after side) is remembered independently. Any slot
|
|
35
35
|
* not yet resized is seeded from {@link position}; {@link onPositionChange} still fires if provided.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ReactUtils } from '@sheetxl/utils-react';
|
|
3
|
+
import { FormulaBarPlacement } from '../formulaBar';
|
|
4
|
+
/** What `detect-it` reports the device's primary pointer to be. */
|
|
5
|
+
type PrimaryInput = ReturnType<typeof ReactUtils.detectIt>['primaryInput'];
|
|
6
|
+
/**
|
|
7
|
+
* Resolve the studio's `formulaBarPlacement` prop to an edge.
|
|
8
|
+
*
|
|
9
|
+
* @remarks
|
|
10
|
+
* `'auto'` (or an omitted prop) follows the primary pointer `detect-it` measured at module load: a
|
|
11
|
+
* device whose primary pointer is a finger (`pointer: coarse`) gets the bar below the grid, everything
|
|
12
|
+
* else above. That is a static fact, not the live input modality, so the bar never jumps when a
|
|
13
|
+
* tablet gains a mouse. It is deliberately not `deviceType === 'touchOnly'`: a phone that advertises
|
|
14
|
+
* any fine pointer at all (an S Pen, a paired mouse, a screen-mirroring bridge) reports `hybrid`
|
|
15
|
+
* while its primary pointer is still a finger. The server has no device and resolves to `'top'`.
|
|
16
|
+
* `primaryInput` is a parameter so the rule can be exercised without the device.
|
|
17
|
+
*/
|
|
18
|
+
export declare const resolveFormulaBarPlacement: (placement: FormulaBarPlacement | "auto" | undefined, primaryInput?: PrimaryInput) => FormulaBarPlacement;
|
|
19
|
+
/** The studio chrome, top to bottom, before the formula bar's slot is decided. */
|
|
20
|
+
export interface StudioChromeParts {
|
|
21
|
+
toolbar: React.ReactNode;
|
|
22
|
+
formulaBar: React.ReactNode;
|
|
23
|
+
/** The grid and its task-pane split. */
|
|
24
|
+
main: React.ReactNode;
|
|
25
|
+
statusBar: React.ReactNode;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* The studio's flex-column children in render order: the formula bar sits under the toolbar, or at
|
|
29
|
+
* the very bottom under the status bar when placed at the bottom, so on a phone the entry area and
|
|
30
|
+
* its input toolbar sit directly on the keyboard. The studio, not the status bar, draws the line
|
|
31
|
+
* between the two. The elements themselves are untouched.
|
|
32
|
+
*/
|
|
33
|
+
export declare const orderStudioChrome: (placement: FormulaBarPlacement, parts: StudioChromeParts) => React.ReactNode[];
|
|
34
|
+
export {};
|
|
35
|
+
//# sourceMappingURL=formulaBarPlacement.d.ts.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { StudioProps } from './StudioProps';
|
|
3
|
+
/**
|
|
4
|
+
* Splits props into those the studio consumes and those for its root element.
|
|
5
|
+
*/
|
|
6
|
+
export declare const splitStudioProps: <P extends Partial<StudioProps>>(props: P) => [studioProps: Partial<StudioProps>, elementProps: React.HTMLAttributes<HTMLDivElement>];
|
|
7
|
+
//# sourceMappingURL=splitStudioProps.d.ts.map
|