@sheetxl/studio-mui 0.8.0-beta.1 → 0.8.0-beta.11
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/0BWO0bLZ8Vm_dKd2.mjs +582 -0
- package/browser/esm/BAbq4-I5f5oUiNaF.mjs +141 -0
- package/browser/esm/BED6h6YAwCf1HEQJ.mjs +161 -0
- package/browser/esm/{DMLXV4EKl1NCp_jk.mjs → BXhNFzyEGokTF-BL.mjs} +2 -2
- package/browser/esm/BYE9gCDWKyx6mnVs.mjs +381 -0
- package/browser/esm/BjvD_4t2KGsZP5V8.mjs +71 -0
- package/browser/esm/{zWTZ8BvT4hjgC2ua.mjs → BknfGJouygmnpFIU.mjs} +13 -12
- package/browser/esm/{DNDrQKMTzKzNMjl-.mjs → BlE_8o8tO2AgAlaj.mjs} +19 -17
- package/browser/esm/BokqKEpU6TFgfRs6.mjs +252 -0
- package/browser/esm/{BoLxSRdEWt-Yg2RI.mjs → Brsh5yscJ_4uKFXp.mjs} +130 -103
- package/browser/esm/Bujtz_Guj88d03vI.mjs +831 -0
- package/browser/esm/Buqcl7J75MJrhpVE.mjs +1379 -0
- package/browser/esm/BvhYPwX3GrRaO9CM.mjs +319 -0
- package/browser/esm/C0wlMAIn9iREPK6w.mjs +87 -0
- package/browser/esm/C8JU4KsMasmLvojI.mjs +103 -0
- package/browser/esm/C9pIZVACtl9unFOp.mjs +77 -0
- package/browser/esm/CBD4RiRKbbZtSXV-.mjs +318 -0
- package/browser/esm/CEtXsBzEjEKk9GOj.mjs +117 -0
- package/browser/esm/{BZBJG2tDdD3-VujP.mjs → COlZu93LRwuBvjE-.mjs} +195 -174
- package/browser/esm/{Cj2pgCNqBCGl4rTX.mjs → CTjqDD-swFMZzI-Y.mjs} +587 -556
- package/browser/esm/CWkOgdL7mOKiTR62.mjs +975 -0
- package/browser/esm/ChSVxkPTIjgcC8PL.mjs +412 -0
- package/browser/esm/{Cd6n1XUgF0VItpkH.mjs → ClBvNPeNCAhuVWrG.mjs} +7 -5
- package/browser/esm/CyLn6zOOp_biA3xU.mjs +335 -0
- package/browser/esm/CynTY0oNtyJnoaBq.mjs +14 -0
- package/browser/esm/D3rRUK4dIM5gUSmj.mjs +256 -0
- package/browser/esm/D9ISy7VkaRRFJl46.mjs +515 -0
- package/browser/esm/DDc6rDuU9JAo1DH_.mjs +225 -0
- package/browser/esm/DDczwkXhz_MHub4z.mjs +197 -0
- package/browser/esm/{3ydDykDMtDYbfVVn.mjs → DEv4pIEgYr5C7etm.mjs} +178 -129
- package/browser/esm/DG21x7RKDpge6zAE.mjs +31 -0
- package/browser/esm/DJOOed_OtB-XT7f3.mjs +437 -0
- package/browser/esm/{Bz5LiUe3SZ8g42Ia.mjs → DKtJxrpN0axtuQ0l.mjs} +1 -1
- package/browser/esm/DRSCS6aLiYmPjUz1.mjs +1543 -0
- package/browser/esm/{ChwS_ougBsogOEsP.mjs → DTpRkgsTm_zYnWfW.mjs} +46 -47
- package/browser/esm/DV6i9RQZfJiKtEaJ.mjs +2552 -0
- package/browser/esm/DdcZrjMLWVukWcU5.mjs +7473 -0
- package/browser/esm/Di3BUxA0SqFWWgeg.mjs +94 -0
- package/browser/esm/DnGaP5F7mLwCGUYG.mjs +408 -0
- package/browser/esm/DpD4fg2WcyiKX_2K.mjs +414 -0
- package/browser/esm/{BUGepznywvV0tUjW.mjs → Ds3XRkne7HxcXD8J.mjs} +2 -2
- package/browser/esm/DsoNMWDwHZP8UXQd.mjs +293 -0
- package/browser/esm/G0Inqm6Eqw47dMpa.mjs +212 -0
- package/browser/esm/HViD4Wfoi0mmqk9w.mjs +13 -0
- package/browser/esm/LZoYSQAYV2wksnDv.mjs +386 -0
- package/browser/esm/{rU8xNPVQtDSnujM-.mjs → QgaAIDUMmBQBsXP9.mjs} +3 -3
- package/browser/esm/YThnrg3PadGs7B4j.mjs +627 -0
- package/browser/esm/index.mjs +1208 -67
- package/browser/esm/ttjcNHcFn8O6hfnd.mjs +1288 -0
- package/browser/esm/w_JrR69vEpvoyeMy.mjs +68 -0
- package/browser/esm/{CVfuCNRpODUw04IH.mjs → xFqkfN8QMCxvsetB.mjs} +1 -1
- package/browser/esm/zqilJefihVd7At2T.mjs +517 -0
- package/licenses/dependencies.txt +96 -349
- package/node/esm/1bf4gn-2vld4BZ9u.mjs +294 -0
- package/node/esm/{BhqI3pQFkV8K_612.mjs → 3WghtBXAvCDwcVrq.mjs} +1 -1
- package/node/esm/4HmLH0bPVJCZLgik.mjs +116 -0
- package/node/esm/{DM7K7-284z-PczVz.mjs → B0bdb_6p7fQI_ivo.mjs} +28 -28
- package/node/esm/BIMkjQUwG4Ih-6Sh.mjs +142 -0
- package/node/esm/BNg4QQY0WAPLE0q7.mjs +141 -0
- package/node/esm/BPzcW4BejRqso338.mjs +72 -0
- package/node/esm/BR45ogAR-hY2bE60.mjs +318 -0
- package/node/esm/BlN7G0DVC24zauig.mjs +197 -0
- package/node/esm/Bph-sR3l6AYWeuxK.mjs +256 -0
- package/node/esm/CPq-MIdEnc-53JpF.mjs +319 -0
- package/node/esm/CSAnTp5rwId0DUb8.mjs +380 -0
- package/node/esm/CWcv7UVXF8IUB0PC.mjs +1379 -0
- package/node/esm/{BA7VzUQ2sKRLTZ5c.mjs → CYIoK22I6Yvv12_x.mjs} +20 -20
- package/node/esm/CZyA9uD4SkTvqp_G.mjs +1283 -0
- package/node/esm/{CHi3AuWEwEPOg9IZ.mjs → CjC6s3RUJQNCF7mP.mjs} +1 -1
- package/node/esm/{DXZrzWee8K5FPOW1.mjs → CuMePia6i_8yfJ6S.mjs} +9 -9
- package/node/esm/CvRbu8JPxFarsSR-.mjs +412 -0
- package/node/esm/CyafafEgfmjLqE5O.mjs +521 -0
- package/node/esm/D-xqQ5qOSd6WrzwJ.mjs +94 -0
- package/node/esm/DLqBHdFp6wvm6EGs.mjs +212 -0
- package/node/esm/{BwZcoHDBmLPIVOT5.mjs → DMXLxp3T0E0SRTQc.mjs} +69 -70
- package/node/esm/{CUMKTjYv6VTkcWYi.mjs → DWqvf4H5F2wMnZ0L.mjs} +32 -30
- package/node/esm/DatM6eEYPpAtIMy-.mjs +405 -0
- package/node/esm/Db3dbaYLKUO66T9s.mjs +1689 -0
- package/node/esm/DdEzhVqYTrGODXrz.mjs +68 -0
- package/node/esm/DeZJlLk8WJ3BLtLs.mjs +975 -0
- package/node/esm/DfCuL8AUxMFoEG2s.mjs +519 -0
- package/node/esm/Do-zCKziWhoG5eAv.mjs +77 -0
- package/node/esm/DpJ2gmZJioCyq8La.mjs +632 -0
- package/node/esm/{Qpuqm6xBr_da38Ht.mjs → XEDcegsv5AGKBfu2.mjs} +165 -137
- package/node/esm/index.mjs +10124 -6751
- package/node/esm/yCUxQuqVuC4DHKPx.mjs +385 -0
- package/node/esm/zITjZ7R4raDqhP-n.mjs +515 -0
- 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 +447 -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 +403 -40
- package/types/src/anchorItems/AnchorItemsDescriptor.d.ts +21 -5
- 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/anomalies/AnomaliesPlugin.d.ts +5 -0
- package/types/src/anomalies/AnomaliesTaskPane.d.ts +17 -0
- package/types/src/anomalies/index.d.ts +3 -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 +29 -0
- package/types/src/border/index.d.ts +1 -0
- package/types/src/chart/ChartFormatPanel.d.ts +20 -0
- package/types/src/chart/ChartPlugin.d.ts +6 -0
- package/types/src/chart/index.d.ts +3 -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/WorkbookStatisticsDialog.d.ts +1 -1
- 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 +101 -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 +33 -0
- package/types/src/formulaBar/MobileInputToolbar.d.ts +43 -0
- package/types/src/formulaBar/index.d.ts +3 -0
- package/types/src/formulaBar/useFormulaBarSession.d.ts +68 -0
- package/types/src/index.d.ts +19 -4
- 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/WorkbookProtectionPanel.d.ts +34 -15
- package/types/src/protection/WorkbookProtectionTab.d.ts +22 -0
- package/types/src/protection/WorksheetProtectionPanel.d.ts +35 -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 +16 -2
- package/types/src/workbook/FillMenu.d.ts +21 -0
- package/types/src/workbook/OutlineButtons.d.ts +11 -0
- package/types/src/workbook/WorkbookContextMenu.d.ts +4 -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
|
@@ -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,33 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FormulaBarProps, IFormulaBarElement } from './IFormulaBar';
|
|
3
|
+
export interface MobileFormulaBarProps extends FormulaBarProps {
|
|
4
|
+
/**
|
|
5
|
+
* If cancel and commit buttons are shown on the input toolbar. The studio's status bar shows both
|
|
6
|
+
* during an edit, so a host without that status bar can turn these on.
|
|
7
|
+
*/
|
|
8
|
+
showCancelCommit?: boolean;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* The formula bar for a touch-only device: the same input the in-grid editor renders, in a box
|
|
12
|
+
* built for the bottom of a phone screen, with a row of entry buttons under it.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* The bar is `fx` and the editor, with the expand chevron inside the field at its right edge.
|
|
16
|
+
* Under it, the {@link MobileInputToolbar}: the letters, numbers and date inputs, Tab, Enter, and
|
|
17
|
+
* (with {@link MobileFormulaBarProps.showCancelCommit}) cancel / commit. There is no name box and no
|
|
18
|
+
* Calculate Now button; the commands behind them stay reachable elsewhere. Expanding grows the field upward: the bar is a flex sibling below the grid,
|
|
19
|
+
* so the grid gives up the lines.
|
|
20
|
+
*
|
|
21
|
+
* It drives the same shared {@link SheetEditable} as the grid through {@link useFormulaBarSession}:
|
|
22
|
+
* a tap on the field starts the edit on the active cell, and a tap on a cell while editing inserts a
|
|
23
|
+
* reference, exactly as the desktop bar does. Enter and Tab (the toolbar's, the keyboard's) commit
|
|
24
|
+
* and move the active cell, leaving the bar idle.
|
|
25
|
+
*
|
|
26
|
+
* The virtual keyboard is the sheet's (see `useVirtualKeyboard`): the bar asks for its keyboard
|
|
27
|
+
* type, its letters and numbers buttons set it, and the bar registers itself as the editor a key typed
|
|
28
|
+
* into the grid opens in while the keyboard is up. In keyboard mode, focus that returns to the grid
|
|
29
|
+
* after an entry lands on the grid's typing input, so the keyboard stays for the next cell. Cancel and
|
|
30
|
+
* commit are the edit's ways out (`exitEditMode`), which end keyboard mode, so the keyboard goes down.
|
|
31
|
+
*/
|
|
32
|
+
export declare const MobileFormulaBar: React.NamedExoticComponent<Omit<MobileFormulaBarProps, "ref"> & React.RefAttributes<IFormulaBarElement>>;
|
|
33
|
+
//# sourceMappingURL=MobileFormulaBar.d.ts.map
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { VirtualKeyboardInputMode } from '@sheetxl/utils-react';
|
|
3
|
+
/** The native keyboard the input asks for: letters, or the number pad. */
|
|
4
|
+
export type MobileInputMode = 'text' | 'decimal';
|
|
5
|
+
export interface MobileInputToolbarProps {
|
|
6
|
+
/** Whether an edit session is live; cancel and commit are disabled otherwise. */
|
|
7
|
+
isEditing: boolean;
|
|
8
|
+
/** The bar cannot edit (protected cell, read-only workbook). */
|
|
9
|
+
disabled: boolean;
|
|
10
|
+
/** Whether the input's virtual keyboard is up. */
|
|
11
|
+
keyboardShown: boolean;
|
|
12
|
+
/** The keyboard the input currently asks for. */
|
|
13
|
+
inputMode: VirtualKeyboardInputMode;
|
|
14
|
+
/** Open the letters or the number keyboard on the field. */
|
|
15
|
+
onInputMode: (mode: MobileInputMode) => void;
|
|
16
|
+
/** Open the date picker; the picked date goes into the field. */
|
|
17
|
+
onDate: () => void;
|
|
18
|
+
/** Commit and move the active cell right, then keep typing. */
|
|
19
|
+
onTab: () => void;
|
|
20
|
+
/** Commit and move the active cell down, then keep typing. */
|
|
21
|
+
onEnter: () => void;
|
|
22
|
+
/**
|
|
23
|
+
* Whether cancel and commit are on the toolbar. The studio's status bar carries both for any
|
|
24
|
+
* edit, so they are off unless a host without one asks.
|
|
25
|
+
*/
|
|
26
|
+
showCancelCommit?: boolean;
|
|
27
|
+
/** Discard the edit. */
|
|
28
|
+
onCancel: () => void;
|
|
29
|
+
/** Keep the edit and stop. */
|
|
30
|
+
onCommit: () => void;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* The row of entry buttons under the phone's formula bar, on the same surface as the studio
|
|
34
|
+
* toolbar: the three inputs (letters, numbers, date) at the left, then Tab and Enter, and cancel /
|
|
35
|
+
* commit at the right when {@link MobileInputToolbarProps.showCancelCommit} asks for them.
|
|
36
|
+
*
|
|
37
|
+
* @remarks
|
|
38
|
+
* Presentation only. The host owns the textarea and the session, so every action is a callback it
|
|
39
|
+
* runs inside the gesture, which is what lets the browser raise or switch the keyboard. Each input
|
|
40
|
+
* button opens its input: tapping one is never a no-op, whether or not a keyboard is already up.
|
|
41
|
+
*/
|
|
42
|
+
export declare const MobileInputToolbar: React.MemoExoticComponent<(props: MobileInputToolbarProps) => React.ReactElement>;
|
|
43
|
+
//# sourceMappingURL=MobileInputToolbar.d.ts.map
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorkbook, IWorksheet, 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
|
+
/**
|
|
28
|
+
* The selected worksheet, or `null` while the active tab is a sheet of another kind. The bar is
|
|
29
|
+
* then disabled and shows no cell.
|
|
30
|
+
*/
|
|
31
|
+
sheet: IWorksheet | null;
|
|
32
|
+
/** The active cell's coordinates on {@link FormulaBarSession.sheet}. */
|
|
33
|
+
activeCoords: ICell.Coords;
|
|
34
|
+
/** The bar cannot start an edit: the host said so, the cell is protected or the workbook is read-only. */
|
|
35
|
+
disabled: boolean;
|
|
36
|
+
/** The live edit session, or `null` while idle. */
|
|
37
|
+
session: ReturnType<SheetEditable['getSession']>;
|
|
38
|
+
/** Whether an edit session is live. */
|
|
39
|
+
isEditing: boolean;
|
|
40
|
+
/** Cancel the live session. Does not move focus. */
|
|
41
|
+
cancel: () => void;
|
|
42
|
+
/** Commit the live session. Does not move focus. */
|
|
43
|
+
commit: () => void;
|
|
44
|
+
/**
|
|
45
|
+
* The `formula:editor` command scope, for the host's `CommandScopeProvider`. `null` without an
|
|
46
|
+
* editable.
|
|
47
|
+
*/
|
|
48
|
+
editorSpec: CommandScopeSpec | null;
|
|
49
|
+
/**
|
|
50
|
+
* The editor element: the shared `EditorDiv` + cell input bound to the active cell and restyled as
|
|
51
|
+
* chrome text. The host places it in its own box. `null` without an editable.
|
|
52
|
+
*/
|
|
53
|
+
cellEditor: React.ReactElement | null;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Everything a formula bar host shares with the other hosts: which cell the bar shows, whether it
|
|
57
|
+
* may edit, the live session on the shared editable, and the editor element itself.
|
|
58
|
+
*
|
|
59
|
+
* @remarks
|
|
60
|
+
* A formula bar host is a box around the same input the in-grid editor renders, driving the same
|
|
61
|
+
* `SheetEditable`, so typing in either place is one edit. The hosts differ in chrome (a name box, a
|
|
62
|
+
* resize grip, how the ✕ / ✓ / fx buttons sit), not in behavior; this hook is the behavior.
|
|
63
|
+
*
|
|
64
|
+
* Ending a session from here does not return focus to the grid. That spans the bar and the grid,
|
|
65
|
+
* which only the studio owns (see the editable-session focus-restore effect in EagerStudio).
|
|
66
|
+
*/
|
|
67
|
+
export declare const useFormulaBarSession: (options: FormulaBarSessionOptions) => FormulaBarSession;
|
|
68
|
+
//# 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';
|
|
@@ -9,11 +11,24 @@ export * from './theme';
|
|
|
9
11
|
export * from './toolbar';
|
|
10
12
|
export * from './statusBar';
|
|
11
13
|
export * from './formulaBar';
|
|
12
|
-
export * from './named';
|
|
14
|
+
export * from './named/INamedCollectionEditor';
|
|
15
|
+
export * from './named/NamedCollectionEditor';
|
|
16
|
+
export * from './named/NamedPlugin';
|
|
17
|
+
export * from './externalLink/ExternalLinksPlugin';
|
|
18
|
+
export * from './comments/CommentCard';
|
|
19
|
+
export * from './comments/CommentsPlugin';
|
|
20
|
+
export * from './anomalies/AnomaliesPlugin';
|
|
13
21
|
export * from './filter';
|
|
14
|
-
export * from './table';
|
|
15
|
-
export * from './
|
|
16
|
-
export * from './
|
|
22
|
+
export * from './table/TableStylePreview';
|
|
23
|
+
export * from './table/TableStyleCanvasPreview';
|
|
24
|
+
export * from './table/TablePlugin';
|
|
25
|
+
export * from './slicer';
|
|
26
|
+
export * from './fill';
|
|
27
|
+
export * from './format/NumberFormatOption';
|
|
28
|
+
export * from './format/FormatPlugin';
|
|
29
|
+
export type { FormatTab, FormatPaneArgs } from './format/FormatTaskPane';
|
|
30
|
+
export * from './protection/PasswordField';
|
|
31
|
+
export * from './protection/ProtectionPlugin';
|
|
17
32
|
export * from './sheet';
|
|
18
33
|
export * from './workbook';
|
|
19
34
|
export * from './theme';
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Commits whatever a field still holds onto the editor's draft.
|
|
3
|
+
*
|
|
4
|
+
* @returns `false` to refuse the save — the field holds text it cannot commit — which leaves the
|
|
5
|
+
* editor open on it.
|
|
6
|
+
*/
|
|
7
|
+
export type EditorCommit = () => boolean;
|
|
8
|
+
/**
|
|
9
|
+
* Where a field inside an {@link EditorPanel} registers to be committed when Save is pressed.
|
|
10
|
+
*/
|
|
11
|
+
export interface EditorCommits {
|
|
12
|
+
/**
|
|
13
|
+
* @returns An unregister callback.
|
|
14
|
+
*/
|
|
15
|
+
register(commit: EditorCommit): () => void;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Provided by {@link EditorPanel}; `null` outside of one.
|
|
19
|
+
*/
|
|
20
|
+
export declare const EditorCommitContext: import('react').Context<EditorCommits | null>;
|
|
21
|
+
/**
|
|
22
|
+
* Has the enclosing {@link EditorPanel} commit this field before it saves.
|
|
23
|
+
*
|
|
24
|
+
* @remarks
|
|
25
|
+
* For a field that commits on done rather than per change. Its commit points are its own keys, its
|
|
26
|
+
* ✓ and a blur to another field; Save is a button, which takes focus without any of them, so text
|
|
27
|
+
* typed but not yet committed would never reach the draft the save reads.
|
|
28
|
+
*
|
|
29
|
+
* Does nothing outside an editor — the same field on a card has no Save to answer to.
|
|
30
|
+
*/
|
|
31
|
+
export declare const useEditorCommit: (commit: EditorCommit) => void;
|
|
32
|
+
//# sourceMappingURL=EditorCommit.d.ts.map
|
|
@@ -3,8 +3,11 @@ import { ItemMessageKeys } from './ItemsDescriptor';
|
|
|
3
3
|
export interface EditorProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
4
|
/**
|
|
5
5
|
* The feature's catalog keys for the cancel/save labels.
|
|
6
|
+
*
|
|
7
|
+
* `Required`, because these are the editor's own buttons: a list that reaches this panel at all
|
|
8
|
+
* is an authorable one, and an authorable list supplies them (see `ItemsDescriptor.createDraft`).
|
|
6
9
|
*/
|
|
7
|
-
messageKeys: Pick<ItemMessageKeys, 'cancel' | 'save'
|
|
10
|
+
messageKeys: Required<Pick<ItemMessageKeys, 'cancel' | 'save'>>;
|
|
8
11
|
/**
|
|
9
12
|
* Called when save is requested
|
|
10
13
|
*/
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
+
import { SxProps, Theme } from '@mui/material';
|
|
2
3
|
import { ItemBodyProps, ItemMessageKeys } from './ItemsDescriptor';
|
|
3
4
|
export interface ItemCardProps<T = any> extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
5
|
item: T;
|
|
5
6
|
/**
|
|
6
|
-
* The feature's catalog keys for the action tooltips.
|
|
7
|
+
* The feature's catalog keys for the built-in action tooltips. A built-in action whose key is
|
|
8
|
+
* missing is not offered.
|
|
7
9
|
*/
|
|
8
|
-
messageKeys: Pick<ItemMessageKeys, 'moveUp' | 'moveDown' | 'edit' | 'duplicate' | 'delete'
|
|
10
|
+
messageKeys: Partial<Pick<ItemMessageKeys, 'moveUp' | 'moveDown' | 'edit' | 'duplicate' | 'delete'>>;
|
|
9
11
|
/**
|
|
10
12
|
* The one-line header.
|
|
11
13
|
*/
|
|
@@ -14,13 +16,34 @@ export interface ItemCardProps<T = any> extends React.HTMLAttributes<HTMLDivElem
|
|
|
14
16
|
* The emphasized line below the header. `null` renders nothing.
|
|
15
17
|
*/
|
|
16
18
|
subtitle?: string | null;
|
|
19
|
+
/**
|
|
20
|
+
* A quiet second line under the title, beside the {@link Media}. For a detail that belongs to the
|
|
21
|
+
* title (where an item is) rather than a section of the card under a divider, as {@link subtitle}
|
|
22
|
+
* is. With a caption the media and the actions align to the title's line rather than centering on
|
|
23
|
+
* the two lines.
|
|
24
|
+
*/
|
|
25
|
+
caption?: React.ReactNode;
|
|
17
26
|
/**
|
|
18
27
|
* Hides every action affordance.
|
|
19
28
|
*/
|
|
20
29
|
readOnly?: boolean;
|
|
30
|
+
/**
|
|
31
|
+
* Marks the card as the one the host is pointing at (the item revealed on the grid). Drawn as the
|
|
32
|
+
* focus outline, without taking focus.
|
|
33
|
+
*/
|
|
34
|
+
selected?: boolean;
|
|
21
35
|
canMoveUp?: boolean;
|
|
22
36
|
canMoveDown?: boolean;
|
|
23
|
-
|
|
37
|
+
/**
|
|
38
|
+
* Omit for an item with no editor — the title is then plain text and no edit action is offered.
|
|
39
|
+
* See `ItemsDescriptor.createDraft`.
|
|
40
|
+
*/
|
|
41
|
+
onEdit?: () => void;
|
|
42
|
+
/**
|
|
43
|
+
* A click on the card's surface — anywhere that is not the title, an action, or a control the
|
|
44
|
+
* card carries. Omit when there is nothing on the grid to select.
|
|
45
|
+
*/
|
|
46
|
+
onSelect?: () => void;
|
|
24
47
|
/**
|
|
25
48
|
* Omit to hide the move affordances (unordered list).
|
|
26
49
|
*/
|
|
@@ -29,11 +52,24 @@ export interface ItemCardProps<T = any> extends React.HTMLAttributes<HTMLDivElem
|
|
|
29
52
|
* Omit to hide the duplicate affordance.
|
|
30
53
|
*/
|
|
31
54
|
onDuplicate?: () => void;
|
|
32
|
-
|
|
55
|
+
/**
|
|
56
|
+
* Omit to hide the delete affordance.
|
|
57
|
+
*/
|
|
58
|
+
onDelete?: () => void;
|
|
59
|
+
/**
|
|
60
|
+
* The feature's own actions, shown in the hover row ahead of the built-in ones. Use
|
|
61
|
+
* {@link ItemCardAction} so they look and behave as the built-in ones do.
|
|
62
|
+
*/
|
|
63
|
+
actions?: React.ReactNode;
|
|
33
64
|
/**
|
|
34
65
|
* Subscribes to the item's own events to re-render this card.
|
|
35
66
|
*/
|
|
36
67
|
subscribeItem?: (item: T, onChange: () => void) => () => void;
|
|
68
|
+
/**
|
|
69
|
+
* Merged over the card's own styling — a host's accent (`'&.Mui-selected'`'s outline) or density
|
|
70
|
+
* (`gap`).
|
|
71
|
+
*/
|
|
72
|
+
sx?: SxProps<Theme>;
|
|
37
73
|
/**
|
|
38
74
|
* Leading visual at the card's top-left, before the title.
|
|
39
75
|
*/
|
|
@@ -48,10 +84,26 @@ export interface ItemCardProps<T = any> extends React.HTMLAttributes<HTMLDivElem
|
|
|
48
84
|
*/
|
|
49
85
|
Subtitle?: React.ComponentType<ItemBodyProps<T>>;
|
|
50
86
|
}
|
|
87
|
+
export interface ItemCardActionProps {
|
|
88
|
+
/** The tooltip, already translated. Also the button's accessible name. */
|
|
89
|
+
title: string;
|
|
90
|
+
iconKey: string;
|
|
91
|
+
onClick: () => void;
|
|
92
|
+
disabled?: boolean;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* One action in a card's hover row — the built-in ones (move, edit, duplicate, delete) and a
|
|
96
|
+
* feature's own (`ItemCardProps.actions`) alike. Its click does not reach the card.
|
|
97
|
+
*/
|
|
98
|
+
export declare const ItemCardAction: React.NamedExoticComponent<ItemCardActionProps>;
|
|
51
99
|
/**
|
|
52
|
-
* Card chrome for one listed item
|
|
53
|
-
*
|
|
54
|
-
*
|
|
100
|
+
* Card chrome for one listed item. See {@link ItemCardProps}.
|
|
101
|
+
*
|
|
102
|
+
* @remarks
|
|
103
|
+
* `memo` erases the item type; this restores it, so a card's `Media`, `Subtitle` and `Body` are typed
|
|
104
|
+
* against the item they are handed.
|
|
55
105
|
*/
|
|
56
|
-
export declare const ItemCard:
|
|
106
|
+
export declare const ItemCard: (<T = any>(props: ItemCardProps<T>) => React.ReactElement) & {
|
|
107
|
+
displayName?: string;
|
|
108
|
+
};
|
|
57
109
|
//# sourceMappingURL=ItemCard.d.ts.map
|
|
@@ -50,27 +50,37 @@ export interface ItemEditorProps<D> {
|
|
|
50
50
|
* English catalog while it is still in use.
|
|
51
51
|
*/
|
|
52
52
|
export interface ItemMessageKeys {
|
|
53
|
-
/** Empty-list text when nothing can be added (read-only). */
|
|
53
|
+
/** Empty-list text when nothing can be added (read-only, or an unauthorable list). */
|
|
54
54
|
none: string;
|
|
55
|
-
/**
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
55
|
+
/**
|
|
56
|
+
* Empty-list text inviting the first item. Required for an AUTHORABLE list — see
|
|
57
|
+
* {@link ItemsDescriptor.createDraft}.
|
|
58
|
+
*/
|
|
59
|
+
addPrompt?: string;
|
|
60
|
+
/** List header. Omit when the pane's own chrome (a tab, a section title) already names the list. */
|
|
61
|
+
heading?: string;
|
|
62
|
+
/** Tooltip on the header's add affordance. Authorable lists only. */
|
|
63
|
+
insert?: string;
|
|
64
|
+
/** Label of the empty-list add button. Authorable lists only. */
|
|
65
|
+
new?: string;
|
|
66
|
+
/** Card action tooltips. `edit` is for authorable lists only. */
|
|
67
|
+
edit?: string;
|
|
65
68
|
delete: string;
|
|
66
69
|
/** Card duplicate tooltip. Required when the feature supplies {@link ItemsDescriptor.duplicate}. */
|
|
67
70
|
duplicate?: string;
|
|
68
|
-
/** Editor buttons. */
|
|
69
|
-
cancel
|
|
70
|
-
save
|
|
71
|
+
/** Editor buttons. Authorable lists only. */
|
|
72
|
+
cancel?: string;
|
|
73
|
+
save?: string;
|
|
71
74
|
/** Card reorder tooltips. Required when the feature supplies {@link ItemsDescriptor.moveBy}. */
|
|
72
75
|
moveUp?: string;
|
|
73
76
|
moveDown?: string;
|
|
77
|
+
/**
|
|
78
|
+
* Search field placeholder, its clear-button tooltip, and the text shown when a query matches
|
|
79
|
+
* nothing. Required when the feature supplies {@link ItemsDescriptor.getSearchText}.
|
|
80
|
+
*/
|
|
81
|
+
search?: string;
|
|
82
|
+
clearSearch?: string;
|
|
83
|
+
noMatches?: string;
|
|
74
84
|
}
|
|
75
85
|
/**
|
|
76
86
|
* Describes one listable feature to the generic {@link ItemsPanel}: where its items come from,
|
|
@@ -141,8 +151,14 @@ export interface ItemsDescriptor<T = any, D = T> {
|
|
|
141
151
|
* `createItem` and edits that. A collection with no such notion — defined names are
|
|
142
152
|
* aggregated from registries that own them, so there is nothing to detach — returns a plain
|
|
143
153
|
* object instead, and {@link save} applies it. The panel only ever hands it back.
|
|
154
|
+
*
|
|
155
|
+
* **Omit it, with {@link save} and {@link EditorBody}, for a list that can be ACTED ON but not
|
|
156
|
+
* AUTHORED** — external links are made by typing a formula, and each one is an immutable
|
|
157
|
+
* snapshot, so the list offers Go to and Break link and no editor at all. The panel then shows
|
|
158
|
+
* no add affordance and no edit action, and the card title is plain text rather than a way in.
|
|
159
|
+
* This is not the same as {@link isReadOnly}, which hides every action including delete.
|
|
144
160
|
*/
|
|
145
|
-
createDraft(workbook: IWorkbook, template?: T): D;
|
|
161
|
+
createDraft?(workbook: IWorkbook, template?: T): D;
|
|
146
162
|
/**
|
|
147
163
|
* Creates a draft from an ACTIVATION seed — the `draft` of the task pane's `ItemsPaneArgs`, put
|
|
148
164
|
* there by whatever opened the pane (a conditional-format preset command, say). The panel opens
|
|
@@ -162,6 +178,19 @@ export interface ItemsDescriptor<T = any, D = T> {
|
|
|
162
178
|
* {@link save} reads it (hashing a password, say).
|
|
163
179
|
*/
|
|
164
180
|
beforeSave?(draft: D): Promise<void> | void;
|
|
181
|
+
/**
|
|
182
|
+
* Whether the draft can be saved as it is.
|
|
183
|
+
*
|
|
184
|
+
* @returns A message key naming the problem, or `null`. The problem is shown and the editor stays
|
|
185
|
+
* open on the draft.
|
|
186
|
+
*
|
|
187
|
+
* @remarks
|
|
188
|
+
* Asked after the editor's fields have committed what they still held and after
|
|
189
|
+
* {@link beforeSave}, so it reads the draft as {@link save} would. For what a single field
|
|
190
|
+
* cannot take, the field refuses the save itself (`useEditorCommit`); this is for what only the
|
|
191
|
+
* whole draft can answer — bounds the wrong way around, a condition missing an operand.
|
|
192
|
+
*/
|
|
193
|
+
validate?(draft: D): string | null;
|
|
165
194
|
/**
|
|
166
195
|
* Persists the draft.
|
|
167
196
|
*
|
|
@@ -172,9 +201,11 @@ export interface ItemsDescriptor<T = any, D = T> {
|
|
|
172
201
|
* Whatever spans more than one model write belongs in one transaction here, or undo unwinds a
|
|
173
202
|
* single edit a field at a time.
|
|
174
203
|
*/
|
|
175
|
-
save(workbook: IWorkbook, draft: D, target: T | null): Promise<void> | void;
|
|
204
|
+
save?(workbook: IWorkbook, draft: D, target: T | null): Promise<void> | void;
|
|
176
205
|
/**
|
|
177
|
-
* Removes an item.
|
|
206
|
+
* Removes an item. For a list whose items are not deleted so much as retired — breaking an
|
|
207
|
+
* external link turns its formulas into values first — this is that operation, and
|
|
208
|
+
* {@link ItemMessageKeys.delete} names it.
|
|
178
209
|
*/
|
|
179
210
|
delete(item: T, workbook: IWorkbook): void;
|
|
180
211
|
/**
|
|
@@ -186,6 +217,23 @@ export interface ItemsDescriptor<T = any, D = T> {
|
|
|
186
217
|
* move affordances.
|
|
187
218
|
*/
|
|
188
219
|
moveBy?(item: T, delta: number, workbook: IWorkbook): void;
|
|
220
|
+
/**
|
|
221
|
+
* Selects what an item designates on the grid. Invoked by a click on the card's SURFACE — not on
|
|
222
|
+
* its title, its actions, or a field it carries, which act for themselves.
|
|
223
|
+
*
|
|
224
|
+
* @remarks
|
|
225
|
+
* Omit when nothing on the grid corresponds to an item. An item that sometimes has nothing to
|
|
226
|
+
* select (a name holding a constant) simply does nothing.
|
|
227
|
+
*/
|
|
228
|
+
select?(item: T, workbook: IWorkbook): void;
|
|
229
|
+
/**
|
|
230
|
+
* The text a search query is matched against — everything a user might remember an item by.
|
|
231
|
+
*
|
|
232
|
+
* @remarks
|
|
233
|
+
* Supplying it puts a search field over the list. Matching is a case-insensitive substring
|
|
234
|
+
* test the panel performs; the feature only says what is searchable.
|
|
235
|
+
*/
|
|
236
|
+
getSearchText?(item: T, t: (key: string, options?: any) => string): string;
|
|
189
237
|
/**
|
|
190
238
|
* The one-line card header.
|
|
191
239
|
*/
|
|
@@ -208,8 +256,9 @@ export interface ItemsDescriptor<T = any, D = T> {
|
|
|
208
256
|
*/
|
|
209
257
|
CardSubtitle?: React.ComponentType<ItemBodyProps<T>>;
|
|
210
258
|
/**
|
|
211
|
-
* The feature editor, rendered inside the save/cancel shell.
|
|
259
|
+
* The feature editor, rendered inside the save/cancel shell. Omit for an unauthorable list —
|
|
260
|
+
* see {@link createDraft}.
|
|
212
261
|
*/
|
|
213
|
-
EditorBody
|
|
262
|
+
EditorBody?: React.ComponentType<ItemEditorProps<D>>;
|
|
214
263
|
}
|
|
215
264
|
//# sourceMappingURL=ItemsDescriptor.d.ts.map
|
|
@@ -23,6 +23,15 @@ export interface ItemsPanelProps<T = any, D = T> extends React.HTMLAttributes<HT
|
|
|
23
23
|
* `descriptor.getItems`, so the feature panel holds both and rebuilds the descriptor.
|
|
24
24
|
*/
|
|
25
25
|
headerActions?: React.ReactNode;
|
|
26
|
+
/**
|
|
27
|
+
* Rendered right-aligned under the search field — view toggles that qualify what the list shows
|
|
28
|
+
* (a hidden-items switch) and should read as secondary to it, not as a peer of the heading.
|
|
29
|
+
*
|
|
30
|
+
* @remarks
|
|
31
|
+
* Kept reachable when the list is empty, for the same reason as {@link headerActions}: an empty
|
|
32
|
+
* list is a state these controls can produce.
|
|
33
|
+
*/
|
|
34
|
+
listActions?: React.ReactNode;
|
|
26
35
|
/**
|
|
27
36
|
* Enables drag reordering of the cards, and animates every reorder — dropped drags and the
|
|
28
37
|
* move up/down buttons alike.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { SxProps, Theme } from '@mui/material';
|
|
3
|
+
export interface ItemsSearchFieldProps {
|
|
4
|
+
value: string;
|
|
5
|
+
onChange: (value: string) => void;
|
|
6
|
+
/** Placeholder, already translated. Also the field's accessible name. */
|
|
7
|
+
placeholder?: string;
|
|
8
|
+
/** The clear button's tooltip, already translated. */
|
|
9
|
+
clearLabel?: string;
|
|
10
|
+
sx?: SxProps<Theme>;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* The search field above a card list: a find glyph, a clear button while there is a query, and
|
|
14
|
+
* Escape clearing the query before it does anything else.
|
|
15
|
+
*/
|
|
16
|
+
export declare const ItemsSearchField: React.NamedExoticComponent<ItemsSearchFieldProps>;
|
|
17
|
+
//# sourceMappingURL=ItemsSearchField.d.ts.map
|
|
@@ -2,5 +2,7 @@ export * from './ItemsDescriptor';
|
|
|
2
2
|
export * from './ItemsPanel';
|
|
3
3
|
export * from './ItemCard';
|
|
4
4
|
export * from './EditorPanel';
|
|
5
|
+
export * from './EditorCommit';
|
|
5
6
|
export * from './SortableCards';
|
|
7
|
+
export * from './ItemsSearchField';
|
|
6
8
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1,11 +1,18 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import { IWorkbook } from '@sheetxl/sdk';
|
|
2
|
+
import { IWorkbook, INamed } from '@sheetxl/sdk';
|
|
3
|
+
import { ItemsPaneArgs } from '@sheetxl/react';
|
|
3
4
|
export interface NamedDetailsPanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
5
|
workbook: IWorkbook;
|
|
6
|
+
/**
|
|
7
|
+
* The task pane's activation argument. `insert` opens the pane on a new name and `edit` on an
|
|
8
|
+
* existing one — how the name box's "Define Name…" and "Edit…" reach this editor rather than a
|
|
9
|
+
* dialog of their own. Nothing is seeded from properties: a name has no preset to hand over.
|
|
10
|
+
*/
|
|
11
|
+
args?: ItemsPaneArgs<never, INamed>;
|
|
5
12
|
}
|
|
6
13
|
/**
|
|
7
14
|
* The managed-names task pane: every defined name in the workbook — across all scopes and of every
|
|
8
|
-
* type — with add/edit/delete and a hidden-names toggle.
|
|
15
|
+
* type — with add/edit/delete, search, and a hidden-names toggle.
|
|
9
16
|
*/
|
|
10
17
|
export declare const NamedDetailsPanel: React.NamedExoticComponent<NamedDetailsPanelProps & React.RefAttributes<HTMLDivElement>>;
|
|
11
18
|
//# sourceMappingURL=NamedDetailsPanel.d.ts.map
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import { INamed } from '@sheetxl/sdk';
|
|
2
|
+
import { TaskPaneProps, ItemsPaneArgs } from '@sheetxl/react';
|
|
3
|
+
export declare const NamedDetailsTaskPane: (props: TaskPaneProps<any, ItemsPaneArgs<never, INamed>>) => import("react").JSX.Element;
|
|
3
4
|
//# sourceMappingURL=NamedDetailsTaskPane.d.ts.map
|
|
@@ -9,7 +9,7 @@ export interface NamedEditorPanelProps {
|
|
|
9
9
|
workbook: IWorkbook;
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* Editor panel for one defined name: its name,
|
|
12
|
+
* Editor panel for one defined name: its name, expression, scope, comment and visibility.
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
15
|
* Writes straight through to {@link NamedDraft} while mirroring each field in local state to
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { INamed } from '@sheetxl/sdk';
|
|
3
|
+
export interface NamedExpressionFieldProps {
|
|
4
|
+
/**
|
|
5
|
+
* The name to redefine. Written through on commit.
|
|
6
|
+
*/
|
|
7
|
+
named: INamed;
|
|
8
|
+
/**
|
|
9
|
+
* Field label. Defaults to "Refers To"; `null` renders none, for a host that names it itself.
|
|
10
|
+
*/
|
|
11
|
+
label?: React.ReactNode | null;
|
|
12
|
+
/**
|
|
13
|
+
* Helper line below the field. Defaults to `null` (none) — a reserved line is left for the error
|
|
14
|
+
* message, which is the one thing a user can get wrong here.
|
|
15
|
+
*/
|
|
16
|
+
helperText?: React.ReactNode | null;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* A name's "Refers to" — its expression, as a formula field that writes back to the name.
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* The card's counterpart to a conditional format's "Apply to": re-pointing a name is the edit
|
|
23
|
+
* users reach for most, and it needs none of the editor. The FORMULA grammar, not `'reference'`,
|
|
24
|
+
* for the reason the editor gives — a name refers to any expression, of which a range is only the
|
|
25
|
+
* common case — and unanchored, so references stay sheet-qualified.
|
|
26
|
+
*
|
|
27
|
+
* Commit-on-done: a redefinition lands one entry on the undo stack and re-resolves every formula
|
|
28
|
+
* that reads the name, so it is not something to do on every keystroke. A derived name (a table's)
|
|
29
|
+
* shows its range but takes no edit; renaming or resizing a table belongs to the table.
|
|
30
|
+
*/
|
|
31
|
+
export declare const NamedExpressionField: React.NamedExoticComponent<NamedExpressionFieldProps>;
|
|
32
|
+
//# sourceMappingURL=NamedExpressionField.d.ts.map
|