@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,85 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { Theme, SxProps } from '@mui/material';
|
|
3
|
+
import { FormatSelection } from './useFormatSelection';
|
|
4
|
+
/**
|
|
5
|
+
* What every tab of the format pane takes: the live selection, and nothing else.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* Each panel is a standalone component — drop it in a dialog or an inspector by handing it a
|
|
9
|
+
* {@link FormatSelection} of your own. They apply live (no OK button), matching Excel Online.
|
|
10
|
+
*/
|
|
11
|
+
export interface FormatPanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
12
|
+
/** The live selection the panel reads and writes. */
|
|
13
|
+
selection: FormatSelection;
|
|
14
|
+
/** Force every control off, on top of the selection's own {@link FormatSelection.disabled}. */
|
|
15
|
+
disabled?: boolean;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* An `onClick` for a `MenuItem` inside a MUI `Select`: what to do when the item picked is the one
|
|
19
|
+
* the dropdown already shows.
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* `Select` fires `onChange` only for a DIFFERENT value. But the pane shows the ANCHOR cell's format,
|
|
23
|
+
* and the rest of a multi-cell selection need not match it — so picking *Accounting* over an anchor
|
|
24
|
+
* that is already Accounting is a request to make the whole selection so, not a no-op. `Select`
|
|
25
|
+
* runs an item's own `onClick` before deciding whether anything changed, which makes it the hook
|
|
26
|
+
* for that case.
|
|
27
|
+
*/
|
|
28
|
+
export declare const onReselect: <T>(shown: T, item: T, apply: () => void) => () => void;
|
|
29
|
+
export interface FormatNumberFieldProps {
|
|
30
|
+
label: string;
|
|
31
|
+
/** The committed value — the anchor cell's. */
|
|
32
|
+
value: number;
|
|
33
|
+
min: number;
|
|
34
|
+
max: number;
|
|
35
|
+
/** The spinner's increment. Default `1`. */
|
|
36
|
+
step?: number;
|
|
37
|
+
/** Accept fractions (a line width in points). Default: whole numbers only. */
|
|
38
|
+
decimals?: boolean;
|
|
39
|
+
/** Width in px. These sit in rows beside buttons, not in a form column. */
|
|
40
|
+
width: number;
|
|
41
|
+
disabled?: boolean;
|
|
42
|
+
/** A value to apply — typed, stepped, or re-committed with Enter. Already clamped to `min…max`. */
|
|
43
|
+
onChange: (value: number) => void;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* A number field for the format pane: an {@link InputField} with a numeric input, no helper
|
|
47
|
+
* line, and a commit on Enter.
|
|
48
|
+
*
|
|
49
|
+
* @remarks
|
|
50
|
+
* A plain controlled `TextField` applied on every keystroke but could not apply what it already
|
|
51
|
+
* showed — typing the value on display fires no change event — and the pane shows the ANCHOR cell's
|
|
52
|
+
* value while the rest of the selection may differ (the same problem {@link onReselect} solves for
|
|
53
|
+
* the dropdowns). `InputField`'s commit channel fires on Enter whether or not the text changed, so
|
|
54
|
+
* Enter here means "the whole selection, this value". The live channel keeps the keystroke-by-
|
|
55
|
+
* keystroke apply, and the spinner arrows with it.
|
|
56
|
+
*
|
|
57
|
+
* The two channels overlap: every edit the live channel applied reaches the commit channel again
|
|
58
|
+
* (Escape included — the cancel's revert runs through the live channel first). The field remembers
|
|
59
|
+
* what it applied since the session began and skips an identical commit, so an edit never writes
|
|
60
|
+
* twice, and Enter with nothing edited is the only time the commit channel writes.
|
|
61
|
+
*/
|
|
62
|
+
export declare const FormatNumberField: React.MemoExoticComponent<(props: FormatNumberFieldProps) => React.JSX.Element>;
|
|
63
|
+
/** The vertical rhythm every format panel shares. */
|
|
64
|
+
export declare const panelSx: SxProps<Theme>;
|
|
65
|
+
export interface FormatSectionProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
66
|
+
/** The section heading. Omit for an unlabeled group. */
|
|
67
|
+
label?: string;
|
|
68
|
+
sx?: SxProps<Theme>;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* A labeled group of controls — the pane's answer to Excel's group boxes, without the box.
|
|
72
|
+
*/
|
|
73
|
+
export declare const FormatSection: React.MemoExoticComponent<(props: FormatSectionProps) => React.JSX.Element>;
|
|
74
|
+
export interface FormatRowProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
75
|
+
sx?: SxProps<Theme>;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* A wrapping row of controls. The pane is narrow and resizable, so rows wrap rather than clip.
|
|
79
|
+
*/
|
|
80
|
+
export declare const FormatRow: React.MemoExoticComponent<(props: FormatRowProps) => React.JSX.Element>;
|
|
81
|
+
/**
|
|
82
|
+
* A strip of icon buttons that reads as one control — the alignment toggles, the font effects.
|
|
83
|
+
*/
|
|
84
|
+
export declare const FormatButtonGroup: React.MemoExoticComponent<(props: FormatRowProps) => React.JSX.Element>;
|
|
85
|
+
//# sourceMappingURL=FormatPanelParts.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The key the format pane registers under — what `activateTaskPane` and the `formatCells` command
|
|
3
|
+
* address it by.
|
|
4
|
+
*/
|
|
5
|
+
export declare const FORMAT_TASK_PANE_KEY = "formatCells";
|
|
6
|
+
/**
|
|
7
|
+
* Registers the Format Cells task pane. Called from the studio bootstrap alongside the other
|
|
8
|
+
* built-in panes.
|
|
9
|
+
*/
|
|
10
|
+
export declare const FormatPlugin: () => void;
|
|
11
|
+
//# sourceMappingURL=FormatPlugin.d.ts.map
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorkbook } from '@sheetxl/sdk';
|
|
3
|
+
import { TaskPaneProps } from '@sheetxl/react';
|
|
4
|
+
/** The pane's tabs, in Excel's own order (with Fill where Excel keeps Patterns). */
|
|
5
|
+
export declare const FormatTab: {
|
|
6
|
+
readonly Number: "number";
|
|
7
|
+
readonly Alignment: "alignment";
|
|
8
|
+
readonly Font: "font";
|
|
9
|
+
readonly Border: "border";
|
|
10
|
+
readonly Fill: "fill";
|
|
11
|
+
};
|
|
12
|
+
export type FormatTab = typeof FormatTab[keyof typeof FormatTab];
|
|
13
|
+
/**
|
|
14
|
+
* What a command may ask the format pane to open on — `activateTaskPane('formatCells', { args })`.
|
|
15
|
+
*/
|
|
16
|
+
export interface FormatPaneArgs {
|
|
17
|
+
/** The tab to show. Omit to reopen on whichever tab the user was last on. */
|
|
18
|
+
tab?: FormatTab;
|
|
19
|
+
}
|
|
20
|
+
/** Persistence key for {@link FormatPaneArgs.tab | the tab} an argument-less activation returns to. */
|
|
21
|
+
export declare const FORMAT_TAB_KEY = "format.tab";
|
|
22
|
+
/**
|
|
23
|
+
* The **Format Cells** task pane: one preview over five tabs, applying live to the selection.
|
|
24
|
+
*
|
|
25
|
+
* @remarks
|
|
26
|
+
* Modeled on Excel Online's format pane, with two deliberate departures.
|
|
27
|
+
*
|
|
28
|
+
* The **preview is shared**. Excel Online gives each of its panels its own sample, which means the
|
|
29
|
+
* font sample cannot show you the number format and the number sample cannot show you the fill.
|
|
30
|
+
* One preview of the actual anchor cell answers every tab at once — and since the pane applies
|
|
31
|
+
* live, it is not a mock of the result, it IS the result.
|
|
32
|
+
*
|
|
33
|
+
* There is a **Fill tab**, which Excel Online has no equivalent for: the model carries pattern and
|
|
34
|
+
* gradient fills, and burying them the way desktop Excel does (a "Fill Effects" sub-dialog) is not
|
|
35
|
+
* worth copying. See {@link FillPanel}.
|
|
36
|
+
*/
|
|
37
|
+
export declare const FormatTaskPane: React.MemoExoticComponent<(props: TaskPaneProps<IWorkbook, FormatPaneArgs>) => React.JSX.Element>;
|
|
38
|
+
export default FormatTaskPane;
|
|
39
|
+
//# sourceMappingURL=FormatTaskPane.d.ts.map
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IStroke, IColor, IStyleCollection } from '@sheetxl/sdk';
|
|
3
|
+
/**
|
|
4
|
+
* What the Line panel needs: one line to show and one place to write a line.
|
|
5
|
+
*/
|
|
6
|
+
export interface LineSelection {
|
|
7
|
+
/** The line the controls show, resolved: what the shape states over its theme style. */
|
|
8
|
+
stroke: IStroke;
|
|
9
|
+
/**
|
|
10
|
+
* What the shape states of its line itself, or `null` for nothing. The color picker shows the
|
|
11
|
+
* **Automatic** swatch when the color is the theme's rather than stated.
|
|
12
|
+
*/
|
|
13
|
+
stated: IStroke.JSON | null;
|
|
14
|
+
/** The color the line takes when none is stated — the picker's **Automatic** swatch. */
|
|
15
|
+
autoColor: IColor;
|
|
16
|
+
/** The workbook's style collection — theme swatches and recent colors for the picker. */
|
|
17
|
+
styles: IStyleCollection;
|
|
18
|
+
/** Theme color resolution for the color picker. */
|
|
19
|
+
schemeLookup: IColor.SchemeLookup;
|
|
20
|
+
/** Whether the GRID renders dark (not the app chrome) — swatches follow the grid. */
|
|
21
|
+
darkMode: boolean;
|
|
22
|
+
/** True when the line cannot be changed (a protected sheet). */
|
|
23
|
+
disabled: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Writes a line as one undoable step.
|
|
26
|
+
*
|
|
27
|
+
* @param stroke Line properties that merge into what is stated, or `null` for the theme's line.
|
|
28
|
+
* @param description A `messageKey('op.…')` naming the step in the undo history.
|
|
29
|
+
*/
|
|
30
|
+
applyStroke: (stroke: IStroke.Modifiers | null, description?: string) => void;
|
|
31
|
+
}
|
|
32
|
+
export interface LinePanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
33
|
+
/** The line the panel reads and writes. */
|
|
34
|
+
selection: LineSelection;
|
|
35
|
+
/** Force every control off, on top of the selection's own {@link LineSelection.disabled}. */
|
|
36
|
+
disabled?: boolean;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* The **Line** section of Format Shape: whether a line is drawn, and its color, width, dash,
|
|
40
|
+
* arrowheads, caps and joins, applying live.
|
|
41
|
+
*
|
|
42
|
+
* @remarks
|
|
43
|
+
* Excel shows the controls only while a line is drawn; so does this. The dash and the arrowheads
|
|
44
|
+
* are picked from previews drawn in the line's color, the way the border style picker offers its
|
|
45
|
+
* strokes, which is what lets the begin arrow, the dash and the end arrow sit on one row. An arrow
|
|
46
|
+
* is one button, as a border is: the types in its list, each type's sizes in a submenu.
|
|
47
|
+
*
|
|
48
|
+
* The color picker's **Automatic** swatch is the theme style's color, which is what a line that
|
|
49
|
+
* states a width alone draws with, so picking it hands the color back rather than writing the
|
|
50
|
+
* theme's value down.
|
|
51
|
+
*/
|
|
52
|
+
export declare const LinePanel: React.MemoExoticComponent<(props: LinePanelProps) => React.JSX.Element>;
|
|
53
|
+
//# sourceMappingURL=LinePanel.d.ts.map
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IStroke, IColor } from '@sheetxl/sdk';
|
|
3
|
+
/** The previews' length, in px. */
|
|
4
|
+
export declare const PREVIEW_LENGTH = 60;
|
|
5
|
+
export interface DashIconProps {
|
|
6
|
+
dash: IStroke.DashStyle | number[];
|
|
7
|
+
color: IColor | null;
|
|
8
|
+
darkMode?: boolean;
|
|
9
|
+
}
|
|
10
|
+
/** A line drawn with a dash, in the line's color: what a dash looks like. */
|
|
11
|
+
export declare const DashIcon: React.MemoExoticComponent<(props: DashIconProps) => React.ReactElement>;
|
|
12
|
+
/** An arrowhead preview's length: the largest head plus a stub of line, about a square. */
|
|
13
|
+
export declare const END_PREVIEW_LENGTH = 20;
|
|
14
|
+
export interface LineEndIconProps {
|
|
15
|
+
end: IStroke.LineEnd;
|
|
16
|
+
/** Drawn at the start of the line (pointing left) rather than its end. */
|
|
17
|
+
atStart?: boolean;
|
|
18
|
+
color: IColor | null;
|
|
19
|
+
darkMode?: boolean;
|
|
20
|
+
}
|
|
21
|
+
/** A stub of line with one end drawn: what an arrowhead of a type and size looks like. */
|
|
22
|
+
export declare const LineEndIcon: React.MemoExoticComponent<(props: LineEndIconProps) => React.ReactElement>;
|
|
23
|
+
export interface LineEndPopupButtonProps {
|
|
24
|
+
end: IStroke.LineEnd;
|
|
25
|
+
/** The start of the line (pointing left) rather than its end. */
|
|
26
|
+
atStart?: boolean;
|
|
27
|
+
color: IColor | null;
|
|
28
|
+
darkMode?: boolean;
|
|
29
|
+
/** The types offered, in order; the first is none. */
|
|
30
|
+
types: readonly IStroke.LineEndType[];
|
|
31
|
+
/** The sizes offered, in order. */
|
|
32
|
+
sizes: readonly IStroke.LineEndSize[];
|
|
33
|
+
/** Localized names by type, and by size. */
|
|
34
|
+
typeLabels: Record<string, string>;
|
|
35
|
+
sizeLabels: Record<string, string>;
|
|
36
|
+
/** The size submenu's tooltip: `${width}: Small · ${length}: Large`. */
|
|
37
|
+
widthLabel: string;
|
|
38
|
+
lengthLabel: string;
|
|
39
|
+
tooltip?: string;
|
|
40
|
+
disabled?: boolean;
|
|
41
|
+
onSelect: (end: IStroke.LineEnd | null) => void;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* One button for a line end, the way the border button is one button for a border: a preview of
|
|
45
|
+
* the end as it is, opening the list of arrowhead types, each of which opens its sizes. Clicking a
|
|
46
|
+
* type takes it at the current size; a size takes both.
|
|
47
|
+
*/
|
|
48
|
+
export declare const LineEndPopupButton: (props: LineEndPopupButtonProps) => React.ReactElement;
|
|
49
|
+
export interface PreviewOption<V extends string> {
|
|
50
|
+
value: V;
|
|
51
|
+
/** Named in the tooltip; the icon is what shows. */
|
|
52
|
+
label: string;
|
|
53
|
+
icon: React.ReactNode;
|
|
54
|
+
}
|
|
55
|
+
export interface PreviewPopupButtonProps<V extends string> {
|
|
56
|
+
value: V;
|
|
57
|
+
options: readonly PreviewOption<V>[];
|
|
58
|
+
onSelect: (value: V) => void;
|
|
59
|
+
/** Lay the options out in a grid of this many columns; a list otherwise. */
|
|
60
|
+
columns?: number;
|
|
61
|
+
tooltip?: string;
|
|
62
|
+
disabled?: boolean;
|
|
63
|
+
/** What the button shows in place of the chosen option's icon. */
|
|
64
|
+
icon?: React.ReactNode;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* A button showing a preview of what is chosen, opening a list (or grid) of previews to choose
|
|
68
|
+
* from: the way the border style picker offers its strokes.
|
|
69
|
+
*/
|
|
70
|
+
export declare const PreviewPopupButton: <V extends string>(props: PreviewPopupButtonProps<V>) => React.ReactElement;
|
|
71
|
+
//# sourceMappingURL=LinePreviews.d.ts.map
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { Theme, SxProps } from '@mui/material';
|
|
3
|
+
import { NumberFormat } from '@sheetxl/sdk';
|
|
4
|
+
import { TranslateFn } from '@sheetxl/utils-react';
|
|
5
|
+
type Category = NumberFormat.Category;
|
|
6
|
+
export interface NumberFormatOptionProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
7
|
+
/** The format's name — a {@link NumberFormat.Type} in the toolbar, a category in the pane. */
|
|
8
|
+
label: string;
|
|
9
|
+
/**
|
|
10
|
+
* A live sample of the selection formatted this way. Blank keeps the row's height, so a list
|
|
11
|
+
* where only some rows can show a sample stays evenly spaced.
|
|
12
|
+
*/
|
|
13
|
+
sample?: string;
|
|
14
|
+
/**
|
|
15
|
+
* MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
|
|
16
|
+
*/
|
|
17
|
+
sx?: SxProps<Theme>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* The body of a number-format row: the format's name over what the current cell looks like in it.
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* Deliberately item-chrome free. The toolbar popup and the format pane's category dropdown each
|
|
24
|
+
* wrap it in their own `ExhibitMenuItem`, since the two rows select differently (a command versus
|
|
25
|
+
* the pane's `onChange`).
|
|
26
|
+
*/
|
|
27
|
+
export declare const NumberFormatOption: React.MemoExoticComponent<(props: NumberFormatOptionProps) => React.JSX.Element>;
|
|
28
|
+
/**
|
|
29
|
+
* Localized display name for a {@link NumberFormat.Type}. The canonical Type
|
|
30
|
+
* string stays the identity (state/lookup); this is display-only. Reuses the
|
|
31
|
+
* dialog's `numberFormat.cat*` keys where a type maps 1:1 to a category, plus
|
|
32
|
+
* `numberFormat.type*` for the granular date/time + comma variants the toolbar
|
|
33
|
+
* exposes. Unknown types fall back to the canonical name.
|
|
34
|
+
*/
|
|
35
|
+
export declare const numberFormatTypeLabel: (t: TranslateFn, type: string) => string;
|
|
36
|
+
/**
|
|
37
|
+
* Localized display name for a category. The SDK's `Builder.CATEGORIES` strings are canonical
|
|
38
|
+
* (they are the `Category` identity values) — a literal `t()` pair per category keeps the
|
|
39
|
+
* extractor seeing `key → english`; unknown categories fall back to the canonical name.
|
|
40
|
+
*/
|
|
41
|
+
export declare const numberFormatCategoryLabel: (t: TranslateFn, category: Category) => string;
|
|
42
|
+
export {};
|
|
43
|
+
//# sourceMappingURL=NumberFormatOption.d.ts.map
|
|
@@ -15,6 +15,26 @@ export interface NumberFormatPanelProps extends Omit<React.HTMLAttributes<HTMLDi
|
|
|
15
15
|
* Not used in a task pane, where the panel applies live.
|
|
16
16
|
*/
|
|
17
17
|
onCommit?: () => void;
|
|
18
|
+
/**
|
|
19
|
+
* Drop the panel's own sample line.
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* For a host that already shows the formatted cell — the format task pane's shared preview —
|
|
23
|
+
* where a second sample of the same value is noise.
|
|
24
|
+
*/
|
|
25
|
+
hideSample?: boolean;
|
|
26
|
+
/**
|
|
27
|
+
* Show the one-click formats — accounting, percent, comma, and the decimal nudges — above the
|
|
28
|
+
* category.
|
|
29
|
+
*
|
|
30
|
+
* @remarks
|
|
31
|
+
* Off by default because they are commands: they format the SELECTION rather than routing
|
|
32
|
+
* through `onChange`, so a host whose target is something else (a dialog editing a style, a
|
|
33
|
+
* preview) must leave them out.
|
|
34
|
+
*
|
|
35
|
+
* @defaultValue false
|
|
36
|
+
*/
|
|
37
|
+
showQuickFormats?: boolean;
|
|
18
38
|
/** Disable all controls. */
|
|
19
39
|
disabled?: boolean;
|
|
20
40
|
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export * from './useFormatSelection';
|
|
2
|
+
export * from './FormatPanelParts';
|
|
3
|
+
export * from './FormatCellPreview';
|
|
4
|
+
export * from './NumberFormatOption';
|
|
5
|
+
export * from './NumberFormatPanel';
|
|
6
|
+
export * from './AlignmentPanel';
|
|
7
|
+
export * from './FontPanel';
|
|
8
|
+
export * from './FillPanel';
|
|
9
|
+
export * from './LinePanel';
|
|
10
|
+
export * from './BorderPanel';
|
|
11
|
+
export * from './BorderPreview';
|
|
12
|
+
export * from './FormatTaskPane';
|
|
13
|
+
export * from './FormatPlugin';
|
|
14
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { IBorders, IWorkbook, ISheet, ICell, ICellRange, ICellStyle, IStyleCollection, IColor } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* Everything the format panels need from the workbook, resolved from the live selection.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* The panels themselves stay presentational — they read {@link style} and call {@link applyStyle}.
|
|
7
|
+
* That keeps each one usable outside the task pane (a dialog, a shape inspector) by handing it a
|
|
8
|
+
* different implementation of this shape.
|
|
9
|
+
*/
|
|
10
|
+
export interface FormatSelection {
|
|
11
|
+
/** The sheet the selection lives on. */
|
|
12
|
+
sheet: ISheet;
|
|
13
|
+
/**
|
|
14
|
+
* The ANCHOR cell — the one the panels read their control values from, and the one the preview
|
|
15
|
+
* shows. A multi-cell selection has one style per cell; Excel reads the anchor too.
|
|
16
|
+
*/
|
|
17
|
+
cell: ICell;
|
|
18
|
+
/** {@link cell}'s resolved style. */
|
|
19
|
+
style: ICellStyle;
|
|
20
|
+
/** The workbook's style collection — theme swatches and recent colors for the pickers. */
|
|
21
|
+
styles: IStyleCollection;
|
|
22
|
+
/** Theme color resolution for the color pickers. */
|
|
23
|
+
schemeLookup: IColor.SchemeLookup;
|
|
24
|
+
/**
|
|
25
|
+
* The color a border draws in when it has none of its own — the pickers' **Automatic** swatch.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* The same value, from the same place, as the toolbar's border picker gets from the
|
|
29
|
+
* `formatBorder` command context (see `SheetCommands`). Without it a picker has no way to offer
|
|
30
|
+
* "no color of my own", and the panel has to hand it some literal color instead — which then
|
|
31
|
+
* reads back as a custom swatch that the user never chose.
|
|
32
|
+
*/
|
|
33
|
+
autoColor: IColor;
|
|
34
|
+
/** Whether the GRID renders dark (not the app chrome) — previews and swatches follow the grid. */
|
|
35
|
+
darkMode: boolean;
|
|
36
|
+
/** True when the selection cannot be formatted (a protected sheet). */
|
|
37
|
+
disabled: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Apply a partial style to every selected range, as one undoable step.
|
|
40
|
+
*
|
|
41
|
+
* @param update The style delta, or a SEQUENCE of them applied in order.
|
|
42
|
+
* @param description A `messageKey('op.…')` naming the step in the undo history.
|
|
43
|
+
* @param autoFit How the selection is fit afterwards, when the default style fit is not it.
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* A sequence is how a caller expresses REPLACE rather than merge. A style delta merges into
|
|
47
|
+
* what is already there, and for a border stroke that means an absent `color` leaves the old
|
|
48
|
+
* one standing — there is no value for "no color" to write. Erasing the edge first and drawing
|
|
49
|
+
* it second says the whole thing, and the batch keeps it one step in the undo history.
|
|
50
|
+
*/
|
|
51
|
+
applyStyle: (update: ICellStyle.Update | readonly ICellStyle.Update[], description?: string, autoFit?: ICellRange.AutoFitOptions) => void;
|
|
52
|
+
/** Mints a detached cell for the previews (theme + named styles resolve against the workbook). */
|
|
53
|
+
createCell: (update: ICell.Update) => ICell | null;
|
|
54
|
+
/** Mints a detached border for the border diagram, the way the border picker's context does. */
|
|
55
|
+
createBorder: (properties: Partial<IBorders.Properties>) => IBorders | null;
|
|
56
|
+
/**
|
|
57
|
+
* What is DRAWN on one edge of the selected block, sampled from the cell that carries it.
|
|
58
|
+
*
|
|
59
|
+
* @remarks
|
|
60
|
+
* A range's style object is cell-shaped: `getBottom()` on it answers for the style's own cell,
|
|
61
|
+
* not for the bottom of the block. So every edge is sampled from the cell it is drawn on — the
|
|
62
|
+
* outer edges from the block's CORNER cells (top and left from the top-left, bottom and right
|
|
63
|
+
* from the bottom-right), and each inner rule from the first cell across it: the horizontal from
|
|
64
|
+
* the `top` of the cell one row down, the vertical from the `left` of the cell one column over.
|
|
65
|
+
*
|
|
66
|
+
* The inner rules deliberately do NOT come from `IBorders.getHorizontal`/`getVertical`. Those
|
|
67
|
+
* report the RULE, which only exists while one authored block spans the whole selection: a
|
|
68
|
+
* border written at any other scope splits the blocks and the rule reads `null` forever after,
|
|
69
|
+
* and an imported workbook never has one at all (xlsx stores borders per cell). Read that way a
|
|
70
|
+
* covered-in-lines selection reports "no inner border", so the toggle can only ever draw.
|
|
71
|
+
*
|
|
72
|
+
* Sampling is `direct`: a border painted by a conditional format is not something this panel can
|
|
73
|
+
* clear, so counting it would make the toggle write `none` over an edge that stays on screen.
|
|
74
|
+
*/
|
|
75
|
+
getEdgeStroke: (edge: IBorders.Edge) => IBorders.IStroke | null;
|
|
76
|
+
/**
|
|
77
|
+
* Whether the selection spans more than one row / column — i.e. whether it HAS an inside.
|
|
78
|
+
*
|
|
79
|
+
* @remarks
|
|
80
|
+
* `IBorders.Edge.Horizontal` written to a single row lands nowhere: there is no shared edge to
|
|
81
|
+
* put it on. The border diagram greys those targets out rather than letting a click do nothing.
|
|
82
|
+
*/
|
|
83
|
+
hasInnerHorizontal: boolean;
|
|
84
|
+
/** {@inheritDoc FormatSelection.hasInnerHorizontal} */
|
|
85
|
+
hasInnerVertical: boolean;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Binds the format panels to the workbook's live selection: re-renders on a selection change and on
|
|
89
|
+
* any style change (Excel-style live apply — the pane has no OK button, so what it shows must follow
|
|
90
|
+
* what it just wrote).
|
|
91
|
+
*/
|
|
92
|
+
export declare const useFormatSelection: (workbook: IWorkbook) => FormatSelection;
|
|
93
|
+
//# sourceMappingURL=useFormatSelection.d.ts.map
|
|
@@ -2,6 +2,10 @@ import { default as React } from 'react';
|
|
|
2
2
|
import { IWorkbook } from '@sheetxl/sdk';
|
|
3
3
|
import { SheetEditable } from '@sheetxl/react';
|
|
4
4
|
import { NamedCollectionEditorProps, INamedCollectionEditorElement } from '../named';
|
|
5
|
+
/**
|
|
6
|
+
* Where a formula bar sits in the studio: above the grid, or below it directly above the status bar.
|
|
7
|
+
*/
|
|
8
|
+
export type FormulaBarPlacement = 'top' | 'bottom';
|
|
5
9
|
export interface FormulaBarProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
6
10
|
/**
|
|
7
11
|
* The workbook that is used for the range.use
|
|
@@ -36,6 +40,13 @@ export interface FormulaBarProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
|
36
40
|
* @defaultValue true
|
|
37
41
|
*/
|
|
38
42
|
showCalculateNow?: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Which edge of the grid the bar sits on. A bar below the grid grows upward when expanded and
|
|
45
|
+
* marks focus along its top edge.
|
|
46
|
+
*
|
|
47
|
+
* @defaultValue 'top'
|
|
48
|
+
*/
|
|
49
|
+
placement?: FormulaBarPlacement;
|
|
39
50
|
/**
|
|
40
51
|
* Ref for the FormulaBar element.
|
|
41
52
|
*/
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FormulaBarProps, IFormulaBarElement } from './IFormulaBar';
|
|
3
|
+
/**
|
|
4
|
+
* The formula bar for a touch-only device: the same input the in-grid editor renders, in a box
|
|
5
|
+
* built for the bottom of a phone screen, with a row of entry buttons under it.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* The bar is `fx` and the editor, with the expand chevron inside the field at its right edge.
|
|
9
|
+
* Under it, the {@link MobileInputToolbar}: the letters, numbers and date inputs, Tab, Enter, and
|
|
10
|
+
* cancel / commit. There is no name box and no Calculate Now button; the commands behind them stay
|
|
11
|
+
* reachable elsewhere. Expanding grows the field upward: the bar is a flex sibling below the grid,
|
|
12
|
+
* so the grid gives up the lines.
|
|
13
|
+
*
|
|
14
|
+
* It drives the same shared {@link SheetEditable} as the grid through {@link useFormulaBarSession}:
|
|
15
|
+
* a tap on the field starts the edit on the active cell, and a tap on a cell while editing inserts a
|
|
16
|
+
* reference, exactly as the desktop bar does. Enter and Tab (the toolbar's, the keyboard's) commit,
|
|
17
|
+
* move the active cell and open the next cell for typing without dropping the keyboard; cancel and
|
|
18
|
+
* commit end the entry and hand focus back to the grid.
|
|
19
|
+
*/
|
|
20
|
+
export declare const MobileFormulaBar: React.NamedExoticComponent<Omit<FormulaBarProps, "ref"> & React.RefAttributes<IFormulaBarElement>>;
|
|
21
|
+
//# sourceMappingURL=MobileFormulaBar.d.ts.map
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
/** The native keyboard the input asks for: letters, or the number pad. */
|
|
3
|
+
export type MobileInputMode = 'text' | 'decimal';
|
|
4
|
+
export interface MobileInputToolbarProps {
|
|
5
|
+
/** Whether an edit session is live; cancel and commit are disabled otherwise. */
|
|
6
|
+
isEditing: boolean;
|
|
7
|
+
/** The bar cannot edit (protected cell, read-only workbook). */
|
|
8
|
+
disabled: boolean;
|
|
9
|
+
/** Whether the input's virtual keyboard is up. */
|
|
10
|
+
keyboardShown: boolean;
|
|
11
|
+
/** The keyboard the input currently asks for. */
|
|
12
|
+
inputMode: MobileInputMode;
|
|
13
|
+
/** Open the letters or the number keyboard on the field. */
|
|
14
|
+
onInputMode: (mode: MobileInputMode) => void;
|
|
15
|
+
/** Open the date picker; the picked date goes into the field. */
|
|
16
|
+
onDate: () => void;
|
|
17
|
+
/** Commit and move the active cell right, then keep typing. */
|
|
18
|
+
onTab: () => void;
|
|
19
|
+
/** Commit and move the active cell down, then keep typing. */
|
|
20
|
+
onEnter: () => void;
|
|
21
|
+
/** Discard the edit. */
|
|
22
|
+
onCancel: () => void;
|
|
23
|
+
/** Keep the edit and stop. */
|
|
24
|
+
onCommit: () => void;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* The row of entry buttons under the phone's formula bar, on the same surface as the studio
|
|
28
|
+
* toolbar: the three inputs (letters, numbers, date) at the left, Tab and Enter in the middle, and
|
|
29
|
+
* cancel / commit at the right.
|
|
30
|
+
*
|
|
31
|
+
* @remarks
|
|
32
|
+
* Presentation only. The host owns the textarea and the session, so every action is a callback it
|
|
33
|
+
* runs inside the gesture, which is what lets the browser raise or switch the keyboard. Each input
|
|
34
|
+
* button opens its input: tapping one is never a no-op, whether or not a keyboard is already up.
|
|
35
|
+
*/
|
|
36
|
+
export declare const MobileInputToolbar: React.MemoExoticComponent<(props: MobileInputToolbarProps) => React.ReactElement>;
|
|
37
|
+
//# sourceMappingURL=MobileInputToolbar.d.ts.map
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorkbook, ISheet, ICell } from '@sheetxl/sdk';
|
|
3
|
+
import { CommandScopeSpec } from '@sheetxl/utils-react';
|
|
4
|
+
import { SheetEditable } from '@sheetxl/react';
|
|
5
|
+
/** The logical editor id both formula bar hosts park on the session (see `EditSession.setActiveEditorId`). */
|
|
6
|
+
export declare const FORMULA_BAR_EDITOR_ID = "formula-bar";
|
|
7
|
+
export interface FormulaBarSessionOptions {
|
|
8
|
+
/** The workbook whose active cell the bar follows. */
|
|
9
|
+
workbook: IWorkbook;
|
|
10
|
+
/** The shared cell editor; the bar is display-only without one. */
|
|
11
|
+
editable: SheetEditable | undefined;
|
|
12
|
+
/** A host-level disable, on top of cell protection and a read-only workbook. */
|
|
13
|
+
disabled?: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* The line rhythm the host's editor box snaps to, in px. Handed to the input so a rendered line
|
|
16
|
+
* and a host row are the same height.
|
|
17
|
+
*/
|
|
18
|
+
lineHeight: number;
|
|
19
|
+
/** The virtual keyboard a touch host asks for. */
|
|
20
|
+
inputMode?: React.TextareaHTMLAttributes<HTMLTextAreaElement>['inputMode'];
|
|
21
|
+
/** The action label of the virtual keyboard's Enter key. */
|
|
22
|
+
enterKeyHint?: React.TextareaHTMLAttributes<HTMLTextAreaElement>['enterKeyHint'];
|
|
23
|
+
/** Which side of the caret the function hint opens on; `'above'` for a bar at the bottom. */
|
|
24
|
+
hintPlacement?: 'below' | 'above';
|
|
25
|
+
}
|
|
26
|
+
export interface FormulaBarSession {
|
|
27
|
+
/** The selected sheet. */
|
|
28
|
+
sheet: ISheet;
|
|
29
|
+
/** The active cell's coordinates on {@link FormulaBarSession.sheet}. */
|
|
30
|
+
activeCoords: ICell.Coords;
|
|
31
|
+
/** The bar cannot start an edit: the host said so, the cell is protected or the workbook is read-only. */
|
|
32
|
+
disabled: boolean;
|
|
33
|
+
/** The live edit session, or `null` while idle. */
|
|
34
|
+
session: ReturnType<SheetEditable['getSession']>;
|
|
35
|
+
/** Whether an edit session is live. */
|
|
36
|
+
isEditing: boolean;
|
|
37
|
+
/** Cancel the live session. Does not move focus. */
|
|
38
|
+
cancel: () => void;
|
|
39
|
+
/** Commit the live session. Does not move focus. */
|
|
40
|
+
commit: () => void;
|
|
41
|
+
/**
|
|
42
|
+
* The `formula:editor` command scope, for the host's `CommandScopeProvider`. `null` without an
|
|
43
|
+
* editable.
|
|
44
|
+
*/
|
|
45
|
+
editorSpec: CommandScopeSpec | null;
|
|
46
|
+
/**
|
|
47
|
+
* The editor element: the shared `EditorDiv` + cell input bound to the active cell and restyled as
|
|
48
|
+
* chrome text. The host places it in its own box. `null` without an editable.
|
|
49
|
+
*/
|
|
50
|
+
cellEditor: React.ReactElement | null;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Everything a formula bar host shares with the other hosts: which cell the bar shows, whether it
|
|
54
|
+
* may edit, the live session on the shared editable, and the editor element itself.
|
|
55
|
+
*
|
|
56
|
+
* @remarks
|
|
57
|
+
* A formula bar host is a box around the same input the in-grid editor renders, driving the same
|
|
58
|
+
* `SheetEditable`, so typing in either place is one edit. The hosts differ in chrome (a name box, a
|
|
59
|
+
* resize grip, how the ✕ / ✓ / fx buttons sit), not in behavior; this hook is the behavior.
|
|
60
|
+
*
|
|
61
|
+
* Ending a session from here does not return focus to the grid. That spans the bar and the grid,
|
|
62
|
+
* which only the studio owns (see the editable-session focus-restore effect in EagerStudio).
|
|
63
|
+
*/
|
|
64
|
+
export declare const useFormulaBarSession: (options: FormulaBarSessionOptions) => FormulaBarSession;
|
|
65
|
+
//# sourceMappingURL=useFormulaBarSession.d.ts.map
|
package/types/src/index.d.ts
CHANGED
|
@@ -2,6 +2,8 @@ export { LicenseManager, type LicenseDetails } from '@sheetxl/sdk';
|
|
|
2
2
|
export { useModelListener, useRangeListener, DefaultTaskPaneRegistry, WorkbookIO } from '@sheetxl/react';
|
|
3
3
|
export * from './command';
|
|
4
4
|
export * from './form';
|
|
5
|
+
export { ItemCard, ItemCardAction, ItemsSearchField, type ItemCardProps, type ItemCardActionProps, type ItemsSearchFieldProps, type ItemBodyProps } from './itemsPanel';
|
|
6
|
+
export { PresetChip, type PresetChipProps } from './conditionalFormat/PresetChip';
|
|
5
7
|
export * from './function';
|
|
6
8
|
export * from './border';
|
|
7
9
|
export * from './color';
|
|
@@ -10,9 +12,13 @@ export * from './toolbar';
|
|
|
10
12
|
export * from './statusBar';
|
|
11
13
|
export * from './formulaBar';
|
|
12
14
|
export * from './named';
|
|
15
|
+
export * from './externalLink';
|
|
16
|
+
export * from './comments';
|
|
13
17
|
export * from './filter';
|
|
14
18
|
export * from './table';
|
|
15
|
-
export * from './
|
|
19
|
+
export * from './slicer';
|
|
20
|
+
export * from './fill';
|
|
21
|
+
export * from './format';
|
|
16
22
|
export * from './protection';
|
|
17
23
|
export * from './sheet';
|
|
18
24
|
export * from './workbook';
|