@sheetxl/studio-mui 0.8.0-beta.9 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +17 -7
- package/browser/esm/{DT71hr6qq9QMKf7Q.mjs → -xbfcBB_r6yovwt0.mjs} +2 -2
- package/browser/esm/0Ui7wtwIglVNcnjK.mjs +975 -0
- package/browser/esm/0pDgMMkwtzP7yApV.mjs +294 -0
- package/browser/esm/3F82kokAv56WeIOp.mjs +94 -0
- package/browser/esm/B7rXnRqYPMeFo7lF.mjs +415 -0
- package/browser/esm/BDXrBgqLv2G_aBxW.mjs +8 -0
- package/browser/esm/{a5G-3nVFn86pvt8H.mjs → BEvHafOOTIvsHfzb.mjs} +82 -94
- package/browser/esm/{BscaD3SzYM6ysjgy.mjs → BF7tsgFfA5kiGqvA.mjs} +5 -5
- package/browser/esm/BGxILWytBh1gGIqX.mjs +1281 -0
- package/browser/esm/BMtcK4QQebSd-gg_.mjs +14 -0
- package/browser/esm/{DpdMtsE7oOAIJqFo.mjs → BN-SV9n15bsIT7UF.mjs} +14 -13
- package/browser/esm/BPw9ZOfyIYNPmxbo.mjs +252 -0
- package/browser/esm/Be-rw5ILGyBK1k5g.mjs +633 -0
- package/browser/esm/Bezw0tyQZcU_2PRi.mjs +242 -0
- package/browser/esm/BjHVW5_EgY2JEOYR.mjs +106 -0
- package/browser/esm/BsQHoNsrcsZZeolo.mjs +103 -0
- package/browser/esm/BtbpQMP61r1e5s6G.mjs +516 -0
- package/browser/esm/BvCt1gSMp3TNaras.mjs +424 -0
- package/browser/esm/By-REgl0FtVnNxzf.mjs +831 -0
- package/browser/esm/{DiKCs9R7e4MgyayQ.mjs → BzPrRiCDzZQnKqH4.mjs} +4 -4
- package/browser/esm/C2NKkLNVwF6qUNv1.mjs +94 -0
- package/browser/esm/C5Y1q7udZf2PwslP.mjs +973 -0
- package/browser/esm/CEbCLniKqzKNP6MP.mjs +392 -0
- package/browser/esm/CFz8KVBAQoF-AJHf.mjs +414 -0
- package/browser/esm/CKVZ-Qa6AcojcV6x.mjs +119 -0
- package/browser/esm/CPawgAiTfoCklxuh.mjs +267 -0
- package/browser/esm/CQyLZmquw7Cn-0Yv.mjs +14 -0
- package/browser/esm/{ipftNUxAU0HR-0YP.mjs → CS7kr0WaYPFpIH95.mjs} +3 -3
- package/browser/esm/CT8hUU9KN4TmEBld.mjs +8547 -0
- package/browser/esm/CX2LPfZw79Z0uRhG.mjs +386 -0
- package/browser/esm/CXViQNtqX1jITZyu.mjs +197 -0
- package/browser/esm/CbNQrqPTogPk-TRE.mjs +1550 -0
- package/browser/esm/{BdkeyaHAtiNa6jqW.mjs → CdeLvf6DfzWVbVw5.mjs} +33 -31
- package/browser/esm/{CawSvjLj4-2Qqyef.mjs → ChytgpwnPlu_VG4E.mjs} +2 -2
- package/browser/esm/CmAMY8rXqmvbCx1E.mjs +360 -0
- package/browser/esm/{BNYKPFICOYt2VRsP.mjs → CukQww6Fo8MyF56L.mjs} +2 -2
- package/browser/esm/Cupln-3vYNmxrrM2.mjs +13 -0
- package/browser/esm/Cy6Q7KGXWYIosYTX.mjs +31 -0
- package/browser/esm/{ffz9LGAgGiWQQav9.mjs → D4IXtjIE97zSR0kY.mjs} +156 -109
- package/browser/esm/D5IXaQlvCuPu8zeG.mjs +72 -0
- package/browser/esm/{CHLqCxo3afOV1Otw.mjs → D6Rur-jnQXX3jzQH.mjs} +4 -4
- package/browser/esm/D8sXey2okO2icU8d.mjs +2692 -0
- package/browser/esm/DE7H4jbuXYB08_dQ.mjs +225 -0
- package/browser/esm/DaISN0TvyxafPIve.mjs +490 -0
- package/browser/esm/{80XYmJwiiFLBmpH2.mjs → DpwtflGvQFbBSLdo.mjs} +47 -48
- package/browser/esm/DrdNTvMdXdsemC4B.mjs +225 -0
- package/browser/esm/DsxPHa5JNx8ovALW.mjs +442 -0
- package/browser/esm/DvJk84TQ-8JsgXcp.mjs +235 -0
- package/browser/esm/Dw9nScfNdZ0Cjwne.mjs +87 -0
- package/browser/esm/{BXQPMQyxdiYwawjE.mjs → PvQUVsO3tH532wV8.mjs} +20 -18
- package/browser/esm/RrujsbEgx2HUeD4s.mjs +161 -0
- package/browser/esm/S2tFDJI2wIBAgQaA.mjs +335 -0
- package/browser/esm/{Cykd-NaZAtHJlQmQ.mjs → STe4CGP-g8tCf7c5.mjs} +2 -2
- package/browser/esm/SgyjQbszb0ptsRk8.mjs +517 -0
- package/browser/esm/d1P5kwJg3I0rdzn5.mjs +318 -0
- package/browser/esm/hfHpykzxUMe5LvVF.mjs +141 -0
- package/browser/esm/{BIZX_0jxF9Fmaxuy.mjs → hjbPNszp95-0VCIw.mjs} +8 -6
- package/browser/esm/index.mjs +1910 -289
- package/browser/esm/sxqx9rjKZcYNC4Hx.mjs +77 -0
- package/browser/esm/{C--IZ8To0PhVLhoX.mjs → voMEQNZgdyO6soYo.mjs} +4 -4
- package/licenses/dependencies.txt +106 -359
- package/node/esm/{C5g2gBoUk3-cn94h.mjs → 1PN4BMQucW63NWcA.mjs} +2 -2
- package/node/esm/{BHuZQ-LJ2GgDLYSz.mjs → 4FcYpbmSwjqrMhol.mjs} +190 -141
- package/node/esm/{9k03YHFiw-wlUS8d.mjs → 6e2HZudCTjTzf6ih.mjs} +2 -2
- package/node/esm/{D4KDk-w7Khu7LrSi.mjs → B1MFTyLMh_SZnQbk.mjs} +70 -71
- package/node/esm/B2WLecbdSqMD1YVq.mjs +519 -0
- package/node/esm/BImYtxlBDnxbuYJQ.mjs +94 -0
- package/node/esm/{CNkqJbFlITxBA0t4.mjs → BQ_0nUqKSPxxzxTT.mjs} +29 -29
- package/node/esm/{Defb5qpSal98J5ay.mjs → BSJerjorDJ4w9N6r.mjs} +2 -2
- package/node/esm/{Dyd7va4aqC1jIzAk.mjs → C0KFwVu86wTgTd54.mjs} +21 -21
- package/node/esm/C0kd2sPUnsgdGUtj.mjs +197 -0
- package/node/esm/C4UnectGYMh-7x7y.mjs +267 -0
- package/node/esm/C5pD4ZSa_HiL9qxk.mjs +14 -0
- package/node/esm/C9W1LtNkMMtOs7Qg.mjs +73 -0
- package/node/esm/CAFHLlFMItMl9TpP.mjs +412 -0
- package/node/esm/CW3fvozHERUfT6Bc.mjs +294 -0
- package/node/esm/CWTDdTicFuH60csl.mjs +972 -0
- package/node/esm/ChO1UxVGRIBuNPOZ.mjs +489 -0
- package/node/esm/{BkoorcOtOEh_Y7ck.mjs → CkIf9KMnQ26-zlEa.mjs} +33 -31
- package/node/esm/CsI3f2TN7jrLwudM.mjs +106 -0
- package/node/esm/CvM_8IuzxswqHgRo.mjs +224 -0
- package/node/esm/D7iklNCWLGeAIvrP.mjs +142 -0
- package/node/esm/D9Inb0eBSow2sR6u.mjs +319 -0
- package/node/esm/DKpUHQxiykyKEuyT.mjs +638 -0
- package/node/esm/DL4-uvtWGuGAfnne.mjs +391 -0
- package/node/esm/{CTtj1NR0IrcN8PTy.mjs → DP_w1SJKb-yFCvb7.mjs} +10 -10
- package/node/esm/DR7dWTccTfAqn8m8.mjs +516 -0
- package/node/esm/DXRJq0Bn7sDr_vXm.mjs +242 -0
- package/node/esm/DZ57bmwliKKBEzB7.mjs +1276 -0
- package/node/esm/Df5VcbKeW9cXY1Lw.mjs +141 -0
- package/node/esm/{b05_u9WnJaVGO0nq.mjs → DxWAgNvtIylA_ta_.mjs} +2 -2
- package/node/esm/GsWeMsCRXwvvpe2Z.mjs +77 -0
- package/node/esm/ONS9B46FEPFzjQsi.mjs +425 -0
- package/node/esm/QfWVpAmFeAecSa0o.mjs +385 -0
- package/node/esm/{BiHw3x2LPWT-kK8G.mjs → RgfhTFBh6fACzrx4.mjs} +84 -96
- package/node/esm/UCHoCHXSYWtQeJ-9.mjs +118 -0
- package/node/esm/index.mjs +9717 -8954
- package/node/esm/mmKhNlIs2nFTMbl5.mjs +94 -0
- package/node/esm/stC67-iHu8jB-gTl.mjs +1831 -0
- package/node/esm/{DHHgNbakbpNnu0oW.mjs → uFGXjoHpIjHX5bT8.mjs} +23 -23
- package/node/esm/z_MOgf-yg9GWQtPj.mjs +975 -0
- package/package.json +16 -19
- package/resources/contents.json +6 -0
- package/resources/locales/contents.json +14 -0
- package/resources/locales/de/groups.cmd.json +59 -10
- package/resources/locales/de/ui.msg.json +267 -14
- package/resources/locales/de/workbookAnomalies.cmd.json +14 -0
- package/resources/locales/en/groups.cmd.json +63 -11
- package/resources/locales/en/ui.msg.json +272 -14
- package/resources/locales/en/workbookAnomalies.cmd.json +14 -0
- package/types/src/anchorItems/AnchorItemsDescriptor.d.ts +4 -4
- package/types/src/anomalies/AnomaliesCommands.d.ts +8 -0
- package/types/src/anomalies/AnomaliesMessages.d.ts +30 -0
- package/types/src/anomalies/AnomaliesPlugin.d.ts +12 -0
- package/types/src/anomalies/AnomaliesTaskPane.d.ts +17 -0
- package/types/src/anomalies/_source.d.ts +7 -0
- package/types/src/anomalies/index.d.ts +3 -0
- package/types/src/border/BorderPopupButton.d.ts +1 -1
- package/types/src/border/BorderTemplateIcon.d.ts +6 -1
- 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/ColorPopupButton.d.ts +1 -1
- package/types/src/command/AccountingStyleCommandButton.d.ts +1 -1
- package/types/src/command/ColorCommandButton.d.ts +5 -0
- package/types/src/command/DocThemeCommandButton.d.ts +1 -1
- package/types/src/command/FontFamilyCommandButton.d.ts +1 -1
- package/types/src/command/FontSizeCommandButton.d.ts +1 -1
- package/types/src/command/InsertCellControlCommandButton.d.ts +17 -0
- package/types/src/command/LanguageCommandButton.d.ts +1 -1
- package/types/src/command/LocaleCommandButton.d.ts +1 -1
- package/types/src/command/PresetCellStylesCommandButton.d.ts +3 -3
- package/types/src/command/PresetPivotStylesCommandButton.d.ts +17 -0
- package/types/src/command/SheetZoomCommandButton.d.ts +4 -3
- package/types/src/command/index.d.ts +2 -0
- package/types/src/comments/CommentCard.d.ts +2 -2
- package/types/src/comments/CommentsPlugin.d.ts +1 -1
- package/types/src/conditionalFormat/ConditionalFormatPlugin.d.ts +1 -1
- package/types/src/conditionalFormat/ConditionalFormatStylePicker.d.ts +4 -4
- package/types/src/conditionalFormat/IconPickerPopupButton.d.ts +3 -3
- package/types/src/conditionalFormat/IconSetRulePanel.d.ts +1 -1
- package/types/src/conditions/CombinatorOption.d.ts +7 -0
- package/types/src/conditions/ConditionEditor.d.ts +55 -3
- package/types/src/conditions/ConditionUtils.d.ts +34 -6
- package/types/src/conditions/ExpressionOption.d.ts +6 -0
- package/types/src/conditions/MembershipOption.d.ts +67 -0
- package/types/src/conditions/OperatorAndParamEditor.d.ts +36 -1
- package/types/src/conditions/OperatorSelectPopupButton.d.ts +1 -1
- package/types/src/conditions/ScalarOption.d.ts +5 -4
- 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 +2 -2
- package/types/src/dataValidation/DataValidationEditorPanel.d.ts +9 -5
- package/types/src/dataValidation/DataValidationIcon.d.ts +1 -1
- package/types/src/dataValidation/DataValidationPlugin.d.ts +1 -1
- package/types/src/dialog/HyperlinkDialog.d.ts +15 -0
- package/types/src/dialog/PivotTableNewDialog.d.ts +11 -0
- package/types/src/dialog/SparklineEditDialog.d.ts +10 -0
- package/types/src/dialog/SparklineNewDialog.d.ts +23 -0
- package/types/src/dialog/WorkbookStatisticsDialog.d.ts +1 -1
- package/types/src/dialog/_ShortcutSearch.d.ts +26 -0
- package/types/src/externalLink/ExternalLinkSettingsTab.d.ts +1 -1
- package/types/src/externalLink/ExternalLinksPlugin.d.ts +1 -1
- package/types/src/fill/GradientEditor.d.ts +15 -13
- package/types/src/fill/GradientStopsBar.d.ts +43 -0
- package/types/src/fill/PatternPopupButton.d.ts +1 -1
- package/types/src/fill/index.d.ts +1 -0
- package/types/src/filter/ColumnMenu.d.ts +31 -1
- package/types/src/filter/PivotMenu.d.ts +31 -0
- package/types/src/filter/index.d.ts +1 -1
- package/types/src/form/FormulaField.d.ts +4 -4
- package/types/src/form/InputField.d.ts +5 -5
- package/types/src/format/BorderPreview.d.ts +11 -4
- package/types/src/format/FillPanel.d.ts +42 -2
- package/types/src/format/FormatPanelParts.d.ts +3 -1
- package/types/src/format/FormatPlugin.d.ts +1 -6
- package/types/src/format/LinePanel.d.ts +53 -0
- package/types/src/format/LinePreviews.d.ts +71 -0
- package/types/src/format/index.d.ts +1 -0
- package/types/src/format/useFormatSelection.d.ts +6 -6
- package/types/src/formulaBar/IFormulaBar.d.ts +32 -3
- package/types/src/formulaBar/MobileFormulaBar.d.ts +42 -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 -6
- package/types/src/itemsPanel/ItemCard.d.ts +50 -7
- package/types/src/itemsPanel/ItemsPanel.d.ts +5 -0
- package/types/src/itemsPanel/ItemsSearchField.d.ts +17 -0
- package/types/src/itemsPanel/index.d.ts +1 -0
- package/types/src/named/NamedDetailsPanel.d.ts +2 -2
- package/types/src/named/NamedPlugin.d.ts +1 -1
- package/types/src/picture/PicturePlugin.d.ts +6 -0
- package/types/src/picture/index.d.ts +2 -0
- package/types/src/pivot/PivotChipMenu.d.ts +10 -0
- package/types/src/pivot/PivotPlugin.d.ts +3 -0
- package/types/src/pivot/PivotStyleCanvasPreview.d.ts +23 -0
- package/types/src/pivot/PivotTableHeader.d.ts +12 -0
- package/types/src/pivot/PivotValueSettingsDialog.d.ts +15 -0
- package/types/src/pivot/_pivotSource.d.ts +7 -0
- package/types/src/presence/PresenceOverlay.d.ts +14 -0
- package/types/src/presence/PresencePlugin.d.ts +31 -0
- package/types/src/presence/PresenceStrip.d.ts +22 -0
- package/types/src/presence/PresenceTaskPane.d.ts +13 -0
- package/types/src/presence/Timeline.d.ts +29 -0
- package/types/src/presence/index.d.ts +5 -0
- package/types/src/protection/ProtectedCellsPanel.d.ts +3 -3
- package/types/src/protection/ProtectionPlugin.d.ts +1 -1
- package/types/src/protection/{SheetProtectionPanel.d.ts → WorksheetProtectionPanel.d.ts} +6 -6
- package/types/src/protection/index.d.ts +1 -1
- package/types/src/shape/ShapeFormatPanel.d.ts +11 -0
- package/types/src/shape/ShapeGalleryCommandButton.d.ts +18 -0
- package/types/src/shape/ShapePlugin.d.ts +8 -0
- package/types/src/shape/index.d.ts +2 -1
- package/types/src/slicer/InsertSlicerCommandButton.d.ts +13 -0
- package/types/src/slicer/PresetSlicerStylesCommandButton.d.ts +12 -0
- package/types/src/slicer/SlicerPlugin.d.ts +6 -0
- package/types/src/slicer/index.d.ts +3 -0
- package/types/src/statusBar/PendingStatus.d.ts +19 -0
- package/types/src/statusBar/SheetZoomScale.d.ts +6 -0
- package/types/src/statusBar/index.d.ts +1 -0
- package/types/src/studio/StudioProps.d.ts +62 -27
- package/types/src/studio/formulaBarPlacement.d.ts +35 -0
- package/types/src/studio/useStudioApp.d.ts +25 -24
- package/types/src/table/TablePlugin.d.ts +1 -1
- package/types/src/table/_drawStyleSwatch.d.ts +25 -0
- package/types/src/template/TemplateDialog.d.ts +1 -1
- package/types/src/template/TemplatePanel.d.ts +5 -1
- package/types/src/template/TemplateSearchField.d.ts +17 -1
- package/types/src/template/categoryColor.d.ts +8 -0
- package/types/src/template/useTemplateCatalog.d.ts +2 -0
- package/types/src/theme/ThemeSelectPopupButton.d.ts +1 -1
- package/types/src/theme/ThemeUtils.d.ts +8 -27
- package/types/src/toolbar/WorkbookToolbars.d.ts +2 -2
- package/types/src/workbook/DefaultRenderers.d.ts +42 -18
- package/types/src/workbook/WorkbookContextMenu.d.ts +4 -0
- package/types/src/workbook/WorkbookElement.d.ts +5 -4
- package/types/src/workbook/WorkbookStrip.d.ts +8 -7
- package/types/src/workbook/index.d.ts +1 -1
- package/browser/cjs/2tG9HJLr-WjsOCP3.cjs +0 -1
- package/browser/cjs/3RXtLkq7wTAV6y_e.cjs +0 -1
- package/browser/cjs/3k_KqDFr-AybPztc.cjs +0 -5
- package/browser/cjs/4_Zy3pR6YXkzISoK.cjs +0 -1
- package/browser/cjs/BD50lsTki7wvzb5g.cjs +0 -1
- package/browser/cjs/BJ-wdkCaXqJaejKf.cjs +0 -1
- package/browser/cjs/BQJKf40kttQWOzLw.cjs +0 -20
- package/browser/cjs/BTZ5uzK0wHzpiZGC.cjs +0 -1
- package/browser/cjs/Bc-YisjBtD56vBAW.cjs +0 -1
- package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
- package/browser/cjs/BpG4iwTKbAnpi0wM.cjs +0 -1
- package/browser/cjs/ByIUHPOa02D7XbdC.cjs +0 -1
- package/browser/cjs/C97KHSuikAbr1qVM.cjs +0 -1
- package/browser/cjs/CMfoKJ3ehdXuld_7.cjs +0 -14
- package/browser/cjs/CPSc2VSYZeZ1B9mi.cjs +0 -1
- package/browser/cjs/CPcBvw4ZPwHVTUZF.cjs +0 -1
- package/browser/cjs/CdDYyAfccXme8w6m.cjs +0 -1
- package/browser/cjs/CkroJ2FmfFvk6Eyv.cjs +0 -1
- package/browser/cjs/CzJvR12QCQb-0Rtn.cjs +0 -1
- package/browser/cjs/D-Yo5aV9STT5KH4G.cjs +0 -1
- package/browser/cjs/DwkiLFWUtLC8ZcIQ.cjs +0 -1
- package/browser/cjs/HuPFsmz7kyZVo3c7.cjs +0 -1
- package/browser/cjs/KZvriGbhEOVkQD0b.cjs +0 -1
- package/browser/cjs/M0_dvdYwhikqP9kg.cjs +0 -2
- package/browser/cjs/g1WhGOz5epV7Hqsg.cjs +0 -8
- package/browser/cjs/iMWEL01eC83oU-YY.cjs +0 -1
- package/browser/cjs/index.cjs +0 -2
- package/browser/esm/BoLRDhnoO3gvviYD.mjs +0 -13811
- package/browser/esm/CH-Y2-p8GRvCHvd4.mjs +0 -52
- package/browser/esm/CUhtBLyaGSkcKB_1.mjs +0 -236
- package/browser/esm/D-Kit71xiitqCWVY.mjs +0 -5356
- package/browser/esm/DkUDZxFxx9n2Cked.mjs +0 -223
- package/browser/esm/F6kkwcBr0l-496tC.mjs +0 -152
- package/browser/esm/Q8r5yuh8Yx2ROnhC.mjs +0 -115
- package/browser/esm/iRFlbG6hQyKLVagS.mjs +0 -411
- package/browser/esm/lftI5b4ZCHVYc6OZ.mjs +0 -1150
- package/node/esm/BTZGnNrgV1na62gd.mjs +0 -415
- package/node/esm/Be0G9parvc2CTpFQ.mjs +0 -4504
- package/node/esm/CTJqjeq3smY8jw5J.mjs +0 -236
- package/node/esm/DbLFR_dnQQmZC_jm.mjs +0 -115
- package/types/src/conditions/DateTimeOption.d.ts +0 -43
- package/types/src/conditions/ListSourceOption.d.ts +0 -31
- package/types/src/filter/FilterList.d.ts +0 -32
- package/types/src/shape/InsertShapeCommandButton.d.ts +0 -10
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IPivotTable, IStyleCollection, ITableStyle } from '@sheetxl/sdk';
|
|
3
|
+
export interface PivotStyleCanvasPreviewProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
/** A pivot table style; `null` for the gallery's None, a table with no style. */
|
|
5
|
+
tableStyle: ITableStyle | null;
|
|
6
|
+
styles: IStyleCollection;
|
|
7
|
+
/** Which parts of the style show; absent, those Excel gives a new pivot table. */
|
|
8
|
+
options?: IPivotTable.StyleOptions;
|
|
9
|
+
/**
|
|
10
|
+
* How many rows the swatch has: Excel online's has 5, Excel desktop's 8.
|
|
11
|
+
* @defaultValue 8
|
|
12
|
+
*/
|
|
13
|
+
rows?: number;
|
|
14
|
+
/** If provided then this canvas is drawn on. */
|
|
15
|
+
canvas?: HTMLCanvasElement;
|
|
16
|
+
ref?: React.Ref<HTMLDivElement>;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* A canvas swatch of a pivot table style as Excel's gallery draws one: a header row, subheadings
|
|
20
|
+
* with two items each, the grand total row, and the grand total column.
|
|
21
|
+
*/
|
|
22
|
+
export declare const PivotStyleCanvasPreview: React.NamedExoticComponent<Omit<PivotStyleCanvasPreviewProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
|
|
23
|
+
//# sourceMappingURL=PivotStyleCanvasPreview.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { PivotTableHeaderProps } from '@sheetxl/react';
|
|
3
|
+
/**
|
|
4
|
+
* The PivotTable Fields pane's header in the studio: the table's name and its source, each edited
|
|
5
|
+
* in place and changed on commit (Enter, blur or ✓), as Table Details edits a table's.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* Both are read-only on a locked sheet, where Excel refuses a refresh; the source is read-only too
|
|
9
|
+
* when the table's cache names none this workbook holds (an external or data model source).
|
|
10
|
+
*/
|
|
11
|
+
export declare const PivotTableHeader: (props: PivotTableHeaderProps) => React.ReactElement;
|
|
12
|
+
//# sourceMappingURL=PivotTableHeader.d.ts.map
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { CommandContext } from '@sheetxl/react';
|
|
3
|
+
import { InputDialogProps } from '@sheetxl/utils-mui';
|
|
4
|
+
export interface PivotValueSettingsDialogProps extends InputDialogProps<CommandContext.PivotValueSettings> {
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Excel's Value Field Settings: a value's caption, its function, how it is shown and its number
|
|
8
|
+
* format. A chip's *Value settings…* opens it, and its `onInput` hands back what changed.
|
|
9
|
+
*
|
|
10
|
+
* @remarks
|
|
11
|
+
* The caption follows the function picked, as Excel's does, until it is typed over.
|
|
12
|
+
*/
|
|
13
|
+
export declare const PivotValueSettingsDialog: React.NamedExoticComponent<PivotValueSettingsDialogProps>;
|
|
14
|
+
export default PivotValueSettingsDialog;
|
|
15
|
+
//# sourceMappingURL=PivotValueSettingsDialog.d.ts.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ICalculation, ICellRanges } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* A pivot table's source as a reference field holds it: the name typed, when it is a bare name, or
|
|
4
|
+
* the one range it names; `null` for anything else.
|
|
5
|
+
*/
|
|
6
|
+
export declare const pivotSourceOf: (formula: ICalculation.IFormula | null) => ICellRanges | string | null;
|
|
7
|
+
//# sourceMappingURL=_pivotSource.d.ts.map
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { PresenceStore } from '@sheetxl/react';
|
|
3
|
+
/**
|
|
4
|
+
* Esc clears the agent's `working` cursor; `finding` and `question` findings stay until dismissed.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Not attached while a prompt is open: the prompt's window takes Esc there. While an annotation's
|
|
8
|
+
* card is open (current or hovered), Esc is the annotation layer's, which closes the card; the next
|
|
9
|
+
* Esc clears the cursor.
|
|
10
|
+
*/
|
|
11
|
+
export declare const PresenceOverlay: React.FC<{
|
|
12
|
+
store: PresenceStore;
|
|
13
|
+
}>;
|
|
14
|
+
//# sourceMappingURL=PresenceOverlay.d.ts.map
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { ReactElement } from 'react';
|
|
2
|
+
import { PresenceStore, PresenceHost } from '@sheetxl/react';
|
|
3
|
+
/** What {@link PresencePlugin} hands the host to mount. */
|
|
4
|
+
export interface PresencePluginInstance {
|
|
5
|
+
/** The session's state. Bind the live workbook with `store.bind(workbook)` once it loads. */
|
|
6
|
+
store: PresenceStore;
|
|
7
|
+
/** For Studio's `topRight` slot. */
|
|
8
|
+
strip: ReactElement;
|
|
9
|
+
/** Rendered alongside Studio: Esc clearing the agent's working cursor. */
|
|
10
|
+
overlay: ReactElement;
|
|
11
|
+
/** Removes everything the plugin registered and stops the store. */
|
|
12
|
+
dispose(): void;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Presence: an agent working in the view. Its findings on the grid, the strip, and the `agent` task
|
|
16
|
+
* pane, fed by one {@link PresenceHost}.
|
|
17
|
+
*
|
|
18
|
+
* @remarks
|
|
19
|
+
* Registers the task pane, the commands (`showAgentPane`, `clearAgentFindings` on the `workbook`
|
|
20
|
+
* scope), their icons and chrome, and the findings layer: a `RangeAnnotationLayer` on every sheet,
|
|
21
|
+
* drawing only the bound session's annotations. Returns the store and what the host mounts:
|
|
22
|
+
*
|
|
23
|
+
* ```tsx
|
|
24
|
+
* const presence = PresencePlugin(host);
|
|
25
|
+
* presence.store.bind(workbook);
|
|
26
|
+
* <Studio topRight={presence.strip} />
|
|
27
|
+
* {presence.overlay}
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
export declare function PresencePlugin(host: PresenceHost): PresencePluginInstance;
|
|
31
|
+
//# sourceMappingURL=PresencePlugin.d.ts.map
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { PresenceStore } from '@sheetxl/react';
|
|
3
|
+
export interface PresenceStripProps {
|
|
4
|
+
store: PresenceStore;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* The agent control for Studio's `topRight` slot. One control, three states:
|
|
8
|
+
*
|
|
9
|
+
* 1. **Quiet** — the agent button only (it pulses on each tool call).
|
|
10
|
+
* 2. **Badge** — the findings' count and, separately, a warning mark when a prompt is waiting on the
|
|
11
|
+
* user. A prompt never adds to the count, and it does not hide the findings: the prompt sits on
|
|
12
|
+
* top, it is not modal. While the agent has its `working` cursor up, the pill's border breathes
|
|
13
|
+
* in the cursor's color and a mark (its label in the tooltip; click to go there) sits in it — the
|
|
14
|
+
* cursor's only chip: on the grid it is a box alone, and it is never counted.
|
|
15
|
+
* 3. **Expanded** — `x / n`, previous, next, dismiss; slides out to the left. Hovering the badge
|
|
16
|
+
* expands it while the pointer stays; the pin (or clicking the badge) keeps it open.
|
|
17
|
+
*
|
|
18
|
+
* The agent button at the end is there in every state: its quick action toggles the agent pane,
|
|
19
|
+
* and its menu is the home for the other agent commands.
|
|
20
|
+
*/
|
|
21
|
+
export declare const PresenceStrip: React.FC<PresenceStripProps>;
|
|
22
|
+
//# sourceMappingURL=PresenceStrip.d.ts.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { PresenceStore, TaskPaneProps } from '@sheetxl/react';
|
|
3
|
+
export interface PresenceTaskPaneProps extends TaskPaneProps {
|
|
4
|
+
store: PresenceStore;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* **Agent** — two tabs. *Review*: what the agent pointed at for the user (live findings, as cards).
|
|
8
|
+
* *History*: one log of every finding raised and every change made, searchable — anything that has
|
|
9
|
+
* happened is a record, shown as a timeline rather than a card. Under both, the agent's status: what
|
|
10
|
+
* it is waiting on and what it is working on.
|
|
11
|
+
*/
|
|
12
|
+
export declare const PresenceTaskPane: React.MemoExoticComponent<(props: PresenceTaskPaneProps) => React.JSX.Element>;
|
|
13
|
+
//# sourceMappingURL=PresenceTaskPane.d.ts.map
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
/**
|
|
3
|
+
* A record of what happened, as a timeline: flat rows on a rail, one dot per entry. Deliberately not
|
|
4
|
+
* cards — a card reads as an object to manage, and a record is settled.
|
|
5
|
+
*/
|
|
6
|
+
export declare const Timeline: React.FC<{
|
|
7
|
+
className?: string;
|
|
8
|
+
children: React.ReactNode;
|
|
9
|
+
}>;
|
|
10
|
+
export interface TimelineEntryProps {
|
|
11
|
+
/** The entry's dot — who or what it was (an intent's color, the agent's). */
|
|
12
|
+
dotColor: string;
|
|
13
|
+
primary: React.ReactNode;
|
|
14
|
+
/** The quiet line under it: when, or where. */
|
|
15
|
+
secondary?: React.ReactNode;
|
|
16
|
+
/**
|
|
17
|
+
* Shown at the row's top right while it is hovered or focused — the row tints, so the action reads
|
|
18
|
+
* as the row's. Each should stop its click from reaching the row.
|
|
19
|
+
*/
|
|
20
|
+
actions?: React.ReactNode;
|
|
21
|
+
/** What clicking the row does. Ignored when there are {@link details}: the click discloses them. */
|
|
22
|
+
onClick?: () => void;
|
|
23
|
+
/** Disclosed in place under the row. */
|
|
24
|
+
details?: React.ReactNode;
|
|
25
|
+
className?: string;
|
|
26
|
+
}
|
|
27
|
+
/** One {@link Timeline} entry: a row with its dot on the rail, actions on hover, details on click. */
|
|
28
|
+
export declare const TimelineEntry: React.FC<TimelineEntryProps>;
|
|
29
|
+
//# sourceMappingURL=Timeline.d.ts.map
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
3
|
export interface ProtectedCellsPanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
4
|
/** The sheet whose selected cells are edited. */
|
|
5
|
-
sheet:
|
|
5
|
+
sheet: IWorksheet;
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
8
|
* The **Cells** tab of Manage Protection: the protection format of the selected cells.
|
|
9
9
|
*
|
|
10
10
|
* @remarks
|
|
11
|
-
* Two checkboxes over `
|
|
11
|
+
* Two checkboxes over `ICellStyle.getProtection()` — **Always unlocked** and **Show formulas** — that act
|
|
12
12
|
* on the selection the way a format control does: a mixed selection reads indeterminate, and a click
|
|
13
13
|
* writes every selected cell. Like everything in the pane, a control commits when it is used.
|
|
14
14
|
*
|
|
@@ -7,5 +7,5 @@
|
|
|
7
7
|
* on Ranges. Nothing in the product references it any more; `manageProtectedRange` (the
|
|
8
8
|
* Data ribbon and the context menu) opens `manageProtection` with the tab as its argument.
|
|
9
9
|
*/
|
|
10
|
-
export declare const ProtectionPlugin: () => void;
|
|
10
|
+
export declare const ProtectionPlugin: () => (() => void);
|
|
11
11
|
//# sourceMappingURL=ProtectionPlugin.d.ts.map
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import {
|
|
3
|
-
export interface
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
export interface WorksheetProtectionPanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
4
|
/** The sheet whose protection is edited. */
|
|
5
|
-
sheet:
|
|
5
|
+
sheet: IWorksheet;
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
8
|
* The **Sheet** tab of Manage Protection: protect / pause / highlight, the password, and the
|
|
@@ -30,6 +30,6 @@ export interface SheetProtectionPanelProps extends React.HTMLAttributes<HTMLDivE
|
|
|
30
30
|
* enforcement, wrong for chrome — so this reads `isPaused()` separately: the Protect switch stays
|
|
31
31
|
* on and a banner says why nothing is being enforced.
|
|
32
32
|
*/
|
|
33
|
-
export declare const
|
|
34
|
-
export default
|
|
35
|
-
//# sourceMappingURL=
|
|
33
|
+
export declare const WorksheetProtectionPanel: React.NamedExoticComponent<WorksheetProtectionPanelProps & React.RefAttributes<HTMLDivElement>>;
|
|
34
|
+
export default WorksheetProtectionPanel;
|
|
35
|
+
//# sourceMappingURL=WorksheetProtectionPanel.d.ts.map
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export * from './PasswordDialog';
|
|
2
2
|
export * from './PasswordField';
|
|
3
3
|
export * from './WorkbookProtectionPanel';
|
|
4
|
-
export * from './
|
|
4
|
+
export * from './WorksheetProtectionPanel';
|
|
5
5
|
export * from './ProtectedCellsPanel';
|
|
6
6
|
export * from './WorkbookProtectionTab';
|
|
7
7
|
export * from './ManageProtectionTaskPane';
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { MovablePaneProps } from '@sheetxl/react';
|
|
3
|
+
/**
|
|
4
|
+
* The body of the format pane for a shape: Excel's Fill & Line, applying live to the shape.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* The Fill controls are the Format Cells pane's, bound to the shape's style instead of the
|
|
8
|
+
* selection's cells (see {@link FillSelection}); the Line controls are the shape's own.
|
|
9
|
+
*/
|
|
10
|
+
export declare const ShapeFormatPanel: React.MemoExoticComponent<(props: MovablePaneProps) => React.JSX.Element>;
|
|
11
|
+
//# sourceMappingURL=ShapeFormatPanel.d.ts.map
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
|
|
2
|
+
export interface ShapeGalleryCommandButtonProps extends CommandPopupButtonProps {
|
|
3
|
+
/**
|
|
4
|
+
* The command a pick runs, with the entry's JSON. Its label, description and enablement are the
|
|
5
|
+
* button's.
|
|
6
|
+
*/
|
|
7
|
+
commandKey: string;
|
|
8
|
+
/** Gallery sections to leave out, by key: Change Shape and Crop to Shape have no `lines`. */
|
|
9
|
+
excludeCategories?: readonly string[];
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* A popup gallery of the preset shapes by section, as Excel lays it out. Picking one runs
|
|
13
|
+
* `commandKey` with what the entry states: Insert > Shapes, Change Shape and Crop to Shape are this
|
|
14
|
+
* gallery on their commands. Entries picked here are remembered by key, most recent first, in a
|
|
15
|
+
* Recently Used Shapes section shown above the gallery once there are any.
|
|
16
|
+
*/
|
|
17
|
+
export declare const ShapeGalleryCommandButton: import('react').NamedExoticComponent<Omit<ShapeGalleryCommandButtonProps, "ref"> & import('react').RefAttributes<HTMLElement>>;
|
|
18
|
+
//# sourceMappingURL=ShapeGalleryCommandButton.d.ts.map
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/** Change Shape and Crop to Shape offer no lines or connectors: a box cannot become one. */
|
|
2
|
+
export declare const ClosedShapeCategories: readonly string[];
|
|
3
|
+
/**
|
|
4
|
+
* The studio's additions to shapes: widgets react has no MUI for, added through the shape kind's
|
|
5
|
+
* contribution points as any host's would be.
|
|
6
|
+
*/
|
|
7
|
+
export declare const ShapePlugin: () => (() => void);
|
|
8
|
+
//# sourceMappingURL=ShapePlugin.d.ts.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
|
|
3
|
+
export interface InsertSlicerCommandButtonProps extends Omit<CommandPopupButtonProps, 'quickCommand'> {
|
|
4
|
+
/** The command that inserts, taking {@link CommandContext.InsertSlicerOptions}. */
|
|
5
|
+
commandKey: string;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Insert Slicer for a table or a pivot table. Pressed, it inserts a slicer on the field the active
|
|
9
|
+
* cell is in; its menu lists every field. With the active cell in no field, as on a pivot table's
|
|
10
|
+
* values, a press opens the menu.
|
|
11
|
+
*/
|
|
12
|
+
export declare const InsertSlicerCommandButton: React.NamedExoticComponent<Omit<InsertSlicerCommandButtonProps, "ref"> & React.RefAttributes<HTMLElement>>;
|
|
13
|
+
//# sourceMappingURL=InsertSlicerCommandButton.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
|
|
3
|
+
export interface PresetSlicerStylesCommandButtonProps extends CommandPopupButtonProps {
|
|
4
|
+
/** The command a style is applied with; it takes the style's name. */
|
|
5
|
+
commandKey: string;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* The slicer-style gallery: every slicer style drawn as a small slicer, grouped Custom, Light, Other
|
|
9
|
+
* and Dark, the slicer's own style outlined. Picking one applies it to the active slicer.
|
|
10
|
+
*/
|
|
11
|
+
export declare const PresetSlicerStylesCommandButton: React.NamedExoticComponent<Omit<PresetSlicerStylesCommandButtonProps, "ref"> & React.RefAttributes<HTMLElement>>;
|
|
12
|
+
//# sourceMappingURL=PresetSlicerStylesCommandButton.d.ts.map
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
export interface PendingStatusProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
3
|
+
/**
|
|
4
|
+
* Debounce (ms) between a change and the re-read.
|
|
5
|
+
*
|
|
6
|
+
* @defaultValue 40
|
|
7
|
+
*/
|
|
8
|
+
debounceDelay?: number;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* The status bar's async icon: shown while function results are awaited, saying how many in its
|
|
12
|
+
* tooltip. Pressing it cancels them (Excel's *Cancel Refresh*).
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* Renders nothing when nothing is pending. Read on the calculation's
|
|
16
|
+
* `onPendingChange` and `onStatusChange`, debounced like the number stats.
|
|
17
|
+
*/
|
|
18
|
+
export declare const PendingStatus: React.MemoExoticComponent<(props: PendingStatusProps) => React.JSX.Element | null>;
|
|
19
|
+
//# sourceMappingURL=PendingStatus.d.ts.map
|
|
@@ -6,6 +6,12 @@ export interface SheetZoomScaleProps extends BoxProps {
|
|
|
6
6
|
* @defaultValue 220
|
|
7
7
|
*/
|
|
8
8
|
debounceDelay?: number;
|
|
9
|
+
/**
|
|
10
|
+
* Show the −/slider/+ trio beside the zoom percent. When omitted it hides itself on small screens
|
|
11
|
+
* (below the `sm` breakpoint): a phone has pinch and the percent's menu, and the slider is a worse
|
|
12
|
+
* version of the gesture that eats status-bar width.
|
|
13
|
+
*/
|
|
14
|
+
showSlider?: boolean;
|
|
9
15
|
}
|
|
10
16
|
export declare const SheetZoomScale: React.NamedExoticComponent<Omit<SheetZoomScaleProps, "ref"> & React.RefAttributes<HTMLElement>>;
|
|
11
17
|
//# sourceMappingURL=SheetZoomScale.d.ts.map
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
import { IWorkbook, IWorkbookIO } from '@sheetxl/sdk';
|
|
2
|
-
import { ErrorPanelProps, LoadingPanelProps } from '@sheetxl/utils-react';
|
|
2
|
+
import { ErrorPanelProps, LoadingPanelProps, RenderSlotFn, VirtualKeyboardMode } from '@sheetxl/utils-react';
|
|
3
3
|
import { SxProps } from '@mui/system';
|
|
4
4
|
import { Theme, ThemeOptions, PaperProps } from '@mui/material';
|
|
5
|
-
import { TaskPaneAreaProps,
|
|
6
|
-
import { ExplicitTokens } from '../theme/ThemeUtils';
|
|
5
|
+
import { TaskPaneAreaProps, IWorkbookElement, WorkbookElementProps, WorkbookLoadEvent, WorkbookRenderSettledEvent, SheetEditable, ExplicitTokens } from '@sheetxl/react';
|
|
7
6
|
import { DocumentTitleProps } from '../workbook';
|
|
8
7
|
import { WorkbookToolbarsProps } from '../toolbar';
|
|
9
|
-
import { FormulaBarProps, IFormulaBarElement } from '../formulaBar';
|
|
8
|
+
import { FormulaBarProps, IFormulaBarElement, FormulaBarPlacement } from '../formulaBar';
|
|
10
9
|
import { StatusBarProps } from '../statusBar';
|
|
11
10
|
/**
|
|
12
11
|
* Properties for the Studio component.
|
|
@@ -59,7 +58,7 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
59
58
|
*
|
|
60
59
|
* @defaultValue StackTraceErrorPanel
|
|
61
60
|
*/
|
|
62
|
-
renderDocumentError?:
|
|
61
|
+
renderDocumentError?: RenderSlotFn<ErrorPanelProps> | null;
|
|
63
62
|
/**
|
|
64
63
|
* Customizations for the default loading panel shown while the {@link StudioProps.document} resolves
|
|
65
64
|
* (and the grid first paints). Use {@link StudioProps.renderDocumentLoading} to replace it entirely.
|
|
@@ -67,8 +66,9 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
67
66
|
propsDocumentLoading?: Partial<LoadingPanelProps>;
|
|
68
67
|
/**
|
|
69
68
|
* Replace the loading panel shown while the {@link StudioProps.document} resolves / the grid paints.
|
|
69
|
+
* `null` for none.
|
|
70
70
|
*/
|
|
71
|
-
renderDocumentLoading?:
|
|
71
|
+
renderDocumentLoading?: RenderSlotFn<LoadingPanelProps> | null;
|
|
72
72
|
/**
|
|
73
73
|
* Customizations forwarded to the underlying (chromeless) workbook grid.
|
|
74
74
|
*
|
|
@@ -80,20 +80,27 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
80
80
|
*/
|
|
81
81
|
propsWorkbook?: Partial<WorkbookElementProps>;
|
|
82
82
|
/**
|
|
83
|
-
*
|
|
83
|
+
* Called when the workbook grid first renders, before its pictures and charts have finished
|
|
84
|
+
* drawing. Fires again for each workbook opened in the studio.
|
|
84
85
|
*/
|
|
85
86
|
onWorkbookLoad?: (event: WorkbookLoadEvent) => void | Promise<void>;
|
|
87
|
+
/**
|
|
88
|
+
* Called when a workbook is shown: its first screen has finished drawing, or
|
|
89
|
+
* `propsWorkbook.renderSettleTimeout` ran out. Fires again for each workbook opened in the studio.
|
|
90
|
+
*
|
|
91
|
+
* @see {@link WorkbookElementProps.onRenderSettled}
|
|
92
|
+
*/
|
|
93
|
+
onRenderSettled?: (event: WorkbookRenderSettledEvent) => void;
|
|
86
94
|
/**
|
|
87
95
|
* Allow for customizations on TaskPaneArea.
|
|
88
96
|
*/
|
|
89
97
|
propsTaskPaneArea?: Partial<TaskPaneAreaProps>;
|
|
90
98
|
/**
|
|
91
|
-
* Render
|
|
99
|
+
* Render the task pane area. Pass `props.ref` on to the {@link ITaskPaneAreaElement}.
|
|
92
100
|
*
|
|
93
101
|
* @param props The properties for the TaskPaneArea.
|
|
94
|
-
* @returns A React Element representing the TaskPaneArea.
|
|
95
102
|
*/
|
|
96
|
-
renderTaskPaneArea?:
|
|
103
|
+
renderTaskPaneArea?: RenderSlotFn<TaskPaneAreaProps>;
|
|
97
104
|
/**
|
|
98
105
|
* Allow for a side of the taskpane.
|
|
99
106
|
*
|
|
@@ -136,7 +143,40 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
136
143
|
/**
|
|
137
144
|
* Render a custom formula bar (replaces the default).
|
|
138
145
|
*/
|
|
139
|
-
renderFormulaBar?:
|
|
146
|
+
renderFormulaBar?: RenderSlotFn<FormulaBarProps> | null;
|
|
147
|
+
/**
|
|
148
|
+
* Where the formula bar sits: above the grid, or below it directly above the status bar, the way
|
|
149
|
+
* a phone spreadsheet lays it out.
|
|
150
|
+
*
|
|
151
|
+
* @defaultValue `'auto'` — `'bottom'` on a device whose primary pointer is a finger (a phone, a
|
|
152
|
+
* tablet), `'top'` everywhere else, including on the server.
|
|
153
|
+
*
|
|
154
|
+
* @remarks
|
|
155
|
+
* `'auto'` reads the device's primary pointer once, not the live input: a tablet that gets a mouse
|
|
156
|
+
* plugged in keeps its bar where it is. Force a value to develop the phone layout under device
|
|
157
|
+
* emulation, or when the host knows better than the device test.
|
|
158
|
+
*/
|
|
159
|
+
formulaBarPlacement?: FormulaBarPlacement | 'auto';
|
|
160
|
+
/**
|
|
161
|
+
* How the studio makes room for the virtual keyboard while the formula bar is at the bottom.
|
|
162
|
+
*
|
|
163
|
+
* - `'float'`: the studio stays as it is and never scrolls the page; the bar's field rides the top
|
|
164
|
+
* of the keyboard, while the bar in the studio stays in place. For a studio that is part of a
|
|
165
|
+
* page.
|
|
166
|
+
* - `'resize'`: the studio shrinks to the part of the screen the keyboard leaves, so the grid, its
|
|
167
|
+
* scrollbars and the bar all stay in view above the keyboard. For a studio that is the page (what
|
|
168
|
+
* {@link @sheetxl/studio-mui!useStudioApp} sets up); in a page that scrolls it would fight the page.
|
|
169
|
+
* - `'none'`: nothing; for a host that manages the keyboard itself.
|
|
170
|
+
*
|
|
171
|
+
* @defaultValue `'float'`
|
|
172
|
+
*
|
|
173
|
+
* @remarks
|
|
174
|
+
* Ignored while the bar is at the top. The studio wires the two halves `@sheetxl/utils-react` offers
|
|
175
|
+
* any host: `KeyboardAccessory` (what the formula bar's field rides the keyboard in) and
|
|
176
|
+
* `useKeyboardResize` (the room a host that is the page gives up). A host without the studio's chrome
|
|
177
|
+
* makes the same choice with the same parts.
|
|
178
|
+
*/
|
|
179
|
+
virtualKeyboard?: VirtualKeyboardMode;
|
|
140
180
|
/**
|
|
141
181
|
* The shared cell editor. Supply a stable {@link SheetEditable} to drive the grid and
|
|
142
182
|
* formula bar through one instance (free two-way sync); omit to let the studio auto-create one.
|
|
@@ -155,7 +195,7 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
155
195
|
/**
|
|
156
196
|
* Render a custom status bar (replaces the default).
|
|
157
197
|
*/
|
|
158
|
-
renderStatusBar?:
|
|
198
|
+
renderStatusBar?: RenderSlotFn<StatusBarProps> | null;
|
|
159
199
|
/**
|
|
160
200
|
* Customizations for the toolbar.
|
|
161
201
|
*/
|
|
@@ -163,7 +203,7 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
163
203
|
/**
|
|
164
204
|
* Render a custom toolbar (replaces the default studio toolbar).
|
|
165
205
|
*/
|
|
166
|
-
renderToolbar?:
|
|
206
|
+
renderToolbar?: RenderSlotFn<WorkbookToolbarsProps> | null;
|
|
167
207
|
/**
|
|
168
208
|
* Slot rendered at the top-left of the toolbar (after the logo, before the title).
|
|
169
209
|
*
|
|
@@ -197,7 +237,7 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
197
237
|
* @remarks
|
|
198
238
|
* This is *config*, not state. Light/dark **mode** and the dark-grid/dark-image toggles are self-managed by
|
|
199
239
|
* Studio as persisted preferences (see {@link @sheetxl/react!ThemeStateKey}), driven by the surrounding
|
|
200
|
-
* `PersistentStateProvider` — not by props.
|
|
240
|
+
* `PersistentStateProvider` — not by props. {@link tokens} layers token values on top.
|
|
201
241
|
*/
|
|
202
242
|
muiTheme?: ThemeOptions;
|
|
203
243
|
/**
|
|
@@ -225,9 +265,9 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
225
265
|
* cells and keeps deriving only the rest.
|
|
226
266
|
*
|
|
227
267
|
* The surfaces are `app` (the default cell everything inherits), `header` (row/column headers) and `grid`
|
|
228
|
-
* (the cell body). These are emitted with Studio's own `sxl-app` layer, so they stay **surface-aware**.
|
|
229
|
-
*
|
|
230
|
-
*
|
|
268
|
+
* (the cell body). These are emitted with Studio's own `sxl-app` layer, so they stay **surface-aware**. The
|
|
269
|
+
* `app` cell also retints the MUI chrome (primary, background, text, radius, font). A stylesheet in
|
|
270
|
+
* `@layer sxl-overrides` reaches the grid but not the MUI chrome.
|
|
231
271
|
*/
|
|
232
272
|
tokens?: ExplicitTokens;
|
|
233
273
|
/**
|
|
@@ -250,20 +290,15 @@ export interface StudioProps extends Omit<PaperProps, 'autoFocus' | 'ref'> {
|
|
|
250
290
|
*/
|
|
251
291
|
licenseKey?: string;
|
|
252
292
|
/**
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
* - `none` - load each feature when it is first used.
|
|
256
|
-
* - `common` - features used in most sessions.
|
|
257
|
-
* - `all` - every feature.
|
|
293
|
+
* Whether features are loaded ahead of use once the studio is showing, so their first use does
|
|
294
|
+
* not wait on the network; see {@link WorkbookElementProps.prefetch}.
|
|
258
295
|
*
|
|
259
296
|
* @remarks
|
|
260
|
-
*
|
|
261
|
-
* common features on a slow connection. The script editor and its compiler are always loaded on
|
|
262
|
-
* first use.
|
|
297
|
+
* The script editor and its compiler are always loaded on first use.
|
|
263
298
|
*
|
|
264
|
-
* @defaultValue '
|
|
299
|
+
* @defaultValue 'auto'
|
|
265
300
|
*/
|
|
266
|
-
prefetch?:
|
|
301
|
+
prefetch?: boolean | 'auto';
|
|
267
302
|
/**
|
|
268
303
|
* MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
|
|
269
304
|
*/
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { ReactUtils } from '@sheetxl/utils-react';
|
|
3
|
+
import { FormulaBarPlacement } from '../formulaBar';
|
|
4
|
+
/** What `detect-it` reports the device's primary pointer to be. */
|
|
5
|
+
type PrimaryInput = ReturnType<typeof ReactUtils.detectIt>['primaryInput'];
|
|
6
|
+
/**
|
|
7
|
+
* Resolve the studio's `formulaBarPlacement` prop to an edge.
|
|
8
|
+
*
|
|
9
|
+
* @remarks
|
|
10
|
+
* `'auto'` (or an omitted prop) follows the primary pointer `detect-it` measured at module load: a
|
|
11
|
+
* device whose primary pointer is a finger (`pointer: coarse`) gets the bar below the grid, everything
|
|
12
|
+
* else above. That is a static fact, not the live input modality, so the bar never jumps when a
|
|
13
|
+
* tablet gains a mouse. It is deliberately not `deviceType === 'touchOnly'`: a phone that advertises
|
|
14
|
+
* any fine pointer at all (an S Pen, a paired mouse, a screen-mirroring bridge) reports `hybrid`
|
|
15
|
+
* while its primary pointer is still a finger. The server has no device and resolves to `'top'`.
|
|
16
|
+
* `primaryInput` is a parameter so the rule can be exercised without the device.
|
|
17
|
+
*/
|
|
18
|
+
export declare const resolveFormulaBarPlacement: (placement: FormulaBarPlacement | "auto" | undefined, primaryInput?: PrimaryInput) => FormulaBarPlacement;
|
|
19
|
+
/** The studio chrome, top to bottom, before the formula bar's slot is decided. */
|
|
20
|
+
export interface StudioChromeParts {
|
|
21
|
+
toolbar: React.ReactNode;
|
|
22
|
+
formulaBar: React.ReactNode;
|
|
23
|
+
/** The grid and its task-pane split. */
|
|
24
|
+
main: React.ReactNode;
|
|
25
|
+
statusBar: React.ReactNode;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* The studio's flex-column children in render order: the formula bar sits under the toolbar, or at
|
|
29
|
+
* the very bottom under the status bar when placed at the bottom, so on a phone the entry area and
|
|
30
|
+
* its input toolbar sit directly on the keyboard. The studio, not the status bar, draws the line
|
|
31
|
+
* between the two. The elements themselves are untouched.
|
|
32
|
+
*/
|
|
33
|
+
export declare const orderStudioChrome: (placement: FormulaBarPlacement, parts: StudioChromeParts) => React.ReactNode[];
|
|
34
|
+
export {};
|
|
35
|
+
//# sourceMappingURL=formulaBarPlacement.d.ts.map
|