@sheetxl/studio-mui 0.7.28-beta.4 → 0.8.0-beta.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/browser/cjs/3k_KqDFr-AybPztc.cjs +5 -0
- package/browser/cjs/{zQsyZpeXAvcVXJMs.cjs → 3uprnzi2l0iT17Dg.cjs} +1 -1
- package/browser/cjs/B9GcCj7sj8XdjPZF.cjs +1 -0
- package/browser/cjs/{CJLwX_A3y3TQUmzj.cjs → BGvoJjUs21bbuE1i.cjs} +1 -1
- package/browser/cjs/{CYxc8vnRi8dNpDPk.cjs → BHb7TnK1NmimV4OX.cjs} +1 -1
- package/browser/cjs/BJ-wdkCaXqJaejKf.cjs +1 -0
- package/browser/cjs/BNqyPYRxYISp-uEg.cjs +1 -0
- package/browser/cjs/BXkdjAb4jpTr412c.cjs +1 -0
- package/browser/cjs/Bc-YisjBtD56vBAW.cjs +1 -0
- package/browser/cjs/CuqM721PsKey3yMP.cjs +1 -0
- package/browser/cjs/Cy_XmYq6BsWmCXkk.cjs +3 -0
- package/browser/cjs/D948H7ell-f87BX3.cjs +1 -0
- package/browser/cjs/Dy6O3OWbDBKIj_Ak.cjs +8 -0
- package/browser/cjs/M0_dvdYwhikqP9kg.cjs +2 -0
- package/browser/cjs/QI6GKw7uo1f8gY8C.cjs +1 -0
- package/browser/cjs/eCw4rAEIYE3BftpG.cjs +1 -0
- package/browser/cjs/index.cjs +2 -2
- package/browser/cjs/rCZbExyf1Q3aHloQ.cjs +13 -0
- package/browser/esm/{CZGRaL9mjYTo8fAd.mjs → 894KM-_Oc5cB6ExA.mjs} +8 -16
- package/browser/esm/B1YOQZHyO_dmHUN4.mjs +293 -0
- package/browser/esm/BQSamOMBAoFdQdJe.mjs +12903 -0
- package/browser/esm/{CDyYtk9WscSzj5I5.mjs → BlZiWp3SB3wH5O38.mjs} +130 -103
- package/browser/esm/{C7WFuxTBA8MWoOQj.mjs → Bo74PCF42KVYJF0j.mjs} +3 -3
- package/browser/esm/{CVxEcB8lAnOQ-oPh.mjs → C2Eke_9Dj_m6mtMj.mjs} +2 -2
- package/browser/esm/C5-J1xiO3O1-qaaP.mjs +268 -0
- package/browser/esm/CIbDvsCeLOFHzzId.mjs +152 -0
- package/browser/esm/CNLLwRPWnd4PJgPO.mjs +117 -0
- package/browser/esm/{DhMl3LbgjdX8Nz7b.mjs → CppDmJ4ckCH3alQf.mjs} +113 -111
- package/browser/esm/{DbHn3Fq4gYggsoXV.mjs → CyHNVjgkMYZYlJpY.mjs} +2100 -2214
- package/browser/esm/{GCJRjX28QYfxi-Lg.mjs → D7fA9EyCNSzQMgxg.mjs} +1 -1
- package/browser/esm/D8VPmFDvXDE778_x.mjs +222 -0
- package/browser/esm/{DoOWIBDSfgrvMmNO.mjs → DE7MVTTfExTzvyMW.mjs} +569 -540
- package/browser/esm/DEEnXLhYlUARg6MU.mjs +410 -0
- package/browser/esm/{Drbpg4A9TaJUZd5A.mjs → DIGlcemS7napWyKW.mjs} +1 -1
- package/browser/esm/{6GrWBX-cyxTRJerw.mjs → DN4cwAPYCrtR4gS9.mjs} +3 -3
- package/browser/esm/{BVC0iuc28yuEcyua.mjs → DSGFnb1gYyL22p0t.mjs} +1 -1
- package/browser/esm/DlEshYp6NPfHxFvI.mjs +115 -0
- package/browser/esm/{RbGJTMzxMTlkFlTq.mjs → Dv3hSCyjvwo6GcH1.mjs} +195 -174
- package/browser/esm/{l5BsxVQszkPy_n34.mjs → GmQ9XFFY3hi1L_Ej.mjs} +1 -1
- package/browser/esm/{CccE_2DTbTMNIfQM.mjs → _v6Wbw_y3QgJy3qY.mjs} +1 -1
- package/browser/esm/{BLjxQ1NUjmULb00s.mjs → iM5uEM9H4e8HGt5y.mjs} +2 -2
- package/browser/esm/index.mjs +466 -135
- package/browser/esm/{DdbgnOWM0tle1jeT.mjs → xGJU5xUJx3HF317Q.mjs} +2 -2
- package/browser/esm/{C5XQW-A03GP8EZ3s.mjs → z3zkU7Jf3WJ2_Z_P.mjs} +1 -1
- package/licenses/dependencies.txt +73 -73
- package/node/esm/{CbhFnQCOA5TjhFB1.mjs → BI8XFczUY--Db2n3.mjs} +32 -40
- package/node/esm/{-9Hcp_VKJtR9fWlC.mjs → BJi0FlhIqCMEwROu.mjs} +143 -141
- package/node/esm/{BxTFDoMd-nowfxfb.mjs → BMoRatciTqOi1HkT.mjs} +1 -1
- package/node/esm/BgxeTfCn3jZHGwd7.mjs +414 -0
- package/node/esm/{DYlYrd0A73WoQQgM.mjs → BoDCV8cDmFVAYtaW.mjs} +1 -1
- package/node/esm/C0M1VbsIRuRauUI-.mjs +268 -0
- package/node/esm/{C2HawKeialuFRR9r.mjs → CCWQ116Z67Kz78Uo.mjs} +1 -1
- package/node/esm/C_oV7ldFStOF_fAd.mjs +115 -0
- package/node/esm/DAji2BXelmIUxioS.mjs +116 -0
- package/node/esm/{6PuhMTJrzLciGI0Z.mjs → DN-bhyNbuBbNB0Ky.mjs} +2 -2
- package/node/esm/{ELTc6e1FF88hBAev.mjs → DVaQ6xIbKQgBk0uw.mjs} +1 -1
- package/node/esm/{uJOy7zjNtP0IqGoa.mjs → DVshSSmP5QZU7GoY.mjs} +163 -135
- package/node/esm/{CgA8rdWVZEpIUpsM.mjs → Dbv0IltYad9SQrj3.mjs} +1 -1
- package/node/esm/{DPhvWXmDun8bC0_v.mjs → DvMAUBSQsZmIsRxi.mjs} +1 -1
- package/node/esm/OmUP1AfaJcOxWQAg.mjs +4462 -0
- package/node/esm/cJDXopFIX6f3_oi3.mjs +294 -0
- package/node/esm/index.mjs +7716 -4114
- package/package.json +9 -9
- package/resources/locales/de/groups.cmd.json +24 -6
- package/resources/locales/de/studio.cmd.json +18 -1
- package/resources/locales/de/ui.msg.json +251 -30
- package/resources/locales/en/groups.cmd.json +24 -6
- package/resources/locales/en/studio.cmd.json +18 -1
- package/resources/locales/en/ui.msg.json +202 -30
- package/types/src/anchorItems/AnchorItemsDescriptor.d.ts +11 -1
- package/types/src/anchorItems/AnchorItemsPanel.d.ts +14 -0
- package/types/src/anchorItems/AnchoredRangeField.d.ts +40 -0
- package/types/src/anchorItems/index.d.ts +1 -0
- package/types/src/border/BorderPopupButton.d.ts +6 -6
- package/types/src/border/BorderStylePopupButton.d.ts +3 -3
- package/types/src/border/BorderTemplateIcon.d.ts +24 -0
- package/types/src/border/index.d.ts +1 -0
- package/types/src/color/ColorPanel.d.ts +8 -2
- package/types/src/color/ColorPopupButton.d.ts +2 -1
- package/types/src/command/NumberFormatQuickButtons.d.ts +32 -0
- package/types/src/conditions/BetweenOption.d.ts +1 -1
- package/types/src/conditions/ConditionEditor.d.ts +6 -1
- package/types/src/conditions/ConditionUtils.d.ts +31 -0
- package/types/src/conditions/DateTimeOption.d.ts +4 -4
- package/types/src/conditions/ExpressionOption.d.ts +6 -6
- package/types/src/conditions/ListSourceOption.d.ts +31 -0
- package/types/src/conditions/ScalarOption.d.ts +6 -6
- 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 +9 -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/TableNewDialog.d.ts +1 -4
- package/types/src/dialog/index.d.ts +0 -1
- 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 +39 -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 +4 -0
- package/types/src/filter/FilterList.d.ts +9 -6
- package/types/src/form/FormulaField.d.ts +25 -2
- package/types/src/form/InputField.d.ts +30 -0
- package/types/src/format/AlignmentPanel.d.ts +14 -0
- package/types/src/format/BorderPanel.d.ts +22 -0
- package/types/src/format/BorderPreview.d.ts +84 -0
- package/types/src/format/FillPanel.d.ts +25 -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 +83 -0
- package/types/src/format/FormatPlugin.d.ts +11 -0
- package/types/src/format/FormatTaskPane.d.ts +39 -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 +13 -0
- package/types/src/format/useFormatSelection.d.ts +92 -0
- package/types/src/index.d.ts +3 -1
- package/types/src/itemsPanel/EditorPanel.d.ts +5 -1
- package/types/src/itemsPanel/ItemCard.d.ts +10 -1
- package/types/src/itemsPanel/ItemsDescriptor.d.ts +55 -19
- package/types/src/itemsPanel/ItemsPanel.d.ts +9 -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/protectedRange/ProtectedRangeDetailsPanel.d.ts +6 -0
- package/types/src/protectedRange/ProtectedRangeDraft.d.ts +22 -0
- package/types/src/protectedRange/ProtectedRangeEditorPanel.d.ts +0 -14
- package/types/src/protectedRange/index.d.ts +2 -1
- package/types/src/protection/ManageProtectionTaskPane.d.ts +29 -0
- package/types/src/protection/PasswordDialog.d.ts +32 -0
- package/types/src/protection/PasswordField.d.ts +35 -0
- package/types/src/protection/ProtectedCellsPanel.d.ts +20 -0
- package/types/src/protection/ProtectionPlugin.d.ts +11 -0
- package/types/src/protection/SheetProtectionPanel.d.ts +35 -0
- package/types/src/protection/WorkbookProtectionPanel.d.ts +34 -15
- package/types/src/protection/WorkbookProtectionTab.d.ts +22 -0
- package/types/src/protection/index.d.ts +7 -1
- package/types/src/studio/CommandsWrapper.d.ts +3 -0
- package/types/src/studio/EagerStudio.d.ts +14 -1
- package/types/src/studio/StudioCommandProvider.d.ts +3 -0
- package/types/src/studio/StudioCommands.d.ts +38 -2
- package/types/src/studio/StudioProps.d.ts +41 -0
- package/types/src/studio/splitStudioProps.d.ts +7 -0
- package/types/src/studio/useStudioApp.d.ts +20 -1
- 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 +13 -0
- package/types/src/template/WelcomeDialog.d.ts +29 -0
- package/types/src/template/index.d.ts +3 -0
- package/types/src/template/useTemplateCatalog.d.ts +69 -0
- package/types/src/workbook/DefaultRenderers.d.ts +2 -0
- package/types/src/workbook/FillMenu.d.ts +21 -0
- package/types/src/workbook/index.d.ts +1 -0
- 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/Bte6P3MhSjajJmmY.cjs +0 -7
- package/browser/cjs/CZm1jVZaHQ246prW.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/UnMhi28mbvLiOXQe.cjs +0 -1
- package/browser/cjs/Vbigo0kFP3PFfmeA.cjs +0 -1
- package/browser/cjs/w2GjebPlOFv3pCbm.cjs +0 -1
- package/browser/cjs/z0rB4fK6X1M6PpVD.cjs +0 -11
- package/browser/esm/6seXVm4fUaBp34tP.mjs +0 -217
- package/browser/esm/C1PiodbCgkhztxU5.mjs +0 -411
- package/browser/esm/DTWkitCkayiinpgU.mjs +0 -219
- package/browser/esm/DxBsD4nDbg_OWhYG.mjs +0 -47
- package/browser/esm/HZXAXZqrC43FBvGk.mjs +0 -82
- package/browser/esm/dgkVCh7lmm1Twqmo.mjs +0 -9257
- package/node/esm/B-3Ypi8akR-GxIpw.mjs +0 -82
- package/node/esm/CxqL51jVpIL4ncWW.mjs +0 -47
- package/node/esm/D-x3LVzppkKf5be_.mjs +0 -4575
- package/types/src/conditionalFormat/ConditionalFormatRangeField.d.ts +0 -32
- package/types/src/conditions/InSetOption.d.ts +0 -37
- package/types/src/dialog/NumberFormatDialog.d.ts +0 -12
- package/types/src/numberFormat/NumberFormatTaskPane.d.ts +0 -12
- package/types/src/numberFormat/index.d.ts +0 -8
- package/types/src/protectedRange/ProtectedRangeDetailsTaskPane.d.ts +0 -3
- package/types/src/protectedRange/ProtectedRangePlugin.d.ts +0 -2
- package/types/src/protection/WorkbookProtectionDialog.d.ts +0 -23
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IFill, ICell, IColor } from '@sheetxl/sdk';
|
|
3
|
+
/**
|
|
4
|
+
* A pattern fill's stored `foreground`/`background` from its colors as Excel's Format Cells dialog
|
|
5
|
+
* names them — Pattern Color (the marks) and Background Color (behind the marks).
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* The two agree for every tile but `solid`. A solid tile is all background in the dialog, but the
|
|
9
|
+
* file format paints `solid` with `fgColor`, so Excel stores the dialog's Background in
|
|
10
|
+
* `foreground` and its Pattern Color in `background`. The swap is its own inverse: pass a stored
|
|
11
|
+
* fill's slots to get the dialog's colors back.
|
|
12
|
+
*/
|
|
13
|
+
export declare function toPatternSlots<C>(patternType: IFill.BuiltInSheetPattern, patternColor: C, background: C): {
|
|
14
|
+
foreground: C;
|
|
15
|
+
background: C;
|
|
16
|
+
};
|
|
17
|
+
export interface PatternSwatchProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
18
|
+
/** The tile to draw. */
|
|
19
|
+
patternType: IFill.BuiltInSheetPattern;
|
|
20
|
+
/** The color of the tile's marks — Excel's Pattern Color. */
|
|
21
|
+
foreground?: IColor.Serializable | null;
|
|
22
|
+
/** The color behind the marks — Excel's Background Color, and all of a `solid` tile. */
|
|
23
|
+
background?: IColor.Serializable | null;
|
|
24
|
+
/**
|
|
25
|
+
* Mints the cell the pattern CSS is read from — the model owns the tile geometry, so a swatch
|
|
26
|
+
* without a workbook to ask has nothing to draw.
|
|
27
|
+
*/
|
|
28
|
+
createCell: (update: ICell.Update) => ICell | null;
|
|
29
|
+
/** Whether to bake the colors for a dark surface. */
|
|
30
|
+
darkMode?: boolean;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* One pattern tile, drawn exactly as the grid draws it.
|
|
34
|
+
*
|
|
35
|
+
* @remarks
|
|
36
|
+
* The tile geometry lives in the SDK (`IFill.toCSS` bakes it into a repeating SVG data-URI), so
|
|
37
|
+
* this asks the model for a pattern fill's CSS rather than keeping a second, drifting copy of the
|
|
38
|
+
* twenty-odd Excel tiles. That makes it generic: any `BuiltInSheetPattern` with any two colors,
|
|
39
|
+
* whether it is a menu swatch, a preview, or a legend.
|
|
40
|
+
*/
|
|
41
|
+
export declare const PatternSwatch: React.MemoExoticComponent<(props: PatternSwatchProps) => React.JSX.Element>;
|
|
42
|
+
/**
|
|
43
|
+
* The patterns Excel offers in Format Cells → Fill → Pattern Style, in Excel's own grid order (left
|
|
44
|
+
* to right, top to bottom, six to a row): solid and the grays darkest first, then the dark
|
|
45
|
+
* stripes, then the thin ones.
|
|
46
|
+
*
|
|
47
|
+
* @remarks
|
|
48
|
+
* `Solid` leads, as in Excel: a tile that is all background color (see {@link toPatternSlots}).
|
|
49
|
+
* `None` is omitted — it is a fill type in this model, not a tile. `Custom` is omitted because
|
|
50
|
+
* there is nothing to draw until custom tiles land.
|
|
51
|
+
*/
|
|
52
|
+
export declare const PATTERN_GALLERY: readonly IFill.BuiltInSheetPattern[];
|
|
53
|
+
//# sourceMappingURL=PatternSwatch.d.ts.map
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
import { ITable } from '@sheetxl/sdk';
|
|
3
3
|
import { FloatReference } from '@sheetxl/utils-react';
|
|
4
|
+
import { ValueChecklistProps } from '@sheetxl/react';
|
|
4
5
|
export interface FilterListAttributes {
|
|
5
6
|
isFilterList: () => true;
|
|
6
7
|
}
|
|
@@ -11,18 +12,20 @@ export interface FilterListProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
|
11
12
|
column: ITable.IColumn;
|
|
12
13
|
/** The popup, closed on Apply / Cancel. */
|
|
13
14
|
floatReference: FloatReference;
|
|
15
|
+
/** Passed to the checklist: its rows' look, or (a test) its scroll state. */
|
|
16
|
+
propsChecklist?: Partial<Pick<ValueChecklistProps, 'itemHeight' | 'renderItem' | 'renderCheckbox' | 'viewport'>>;
|
|
14
17
|
/** Ref for the Element. */
|
|
15
18
|
ref?: React.Ref<IFilterListElement>;
|
|
16
19
|
}
|
|
17
20
|
/**
|
|
18
|
-
* The column **filter dropdown** body: a
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
+
* The column **filter dropdown** body: a {@link ValueChecklist} of the column's distinct values
|
|
22
|
+
* with Apply / Cancel. Apply writes an `InSet` condition through the column's filter, ANDed with
|
|
23
|
+
* the other columns' — one Promise, one undo step.
|
|
21
24
|
*
|
|
22
25
|
* @remarks
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
+
* Interim (PLAN-DROPDOWN Phase D rewrites the whole menu on the condition editor): the values come
|
|
27
|
+
* from a walk of the column ({@link readColumnItems}) and the condition holds raw values, as the
|
|
28
|
+
* `InSet` operator compares them today.
|
|
26
29
|
*/
|
|
27
30
|
export declare const FilterList: React.ForwardRefExoticComponent<Omit<FilterListProps, "ref"> & React.RefAttributes<IFilterListElement>>;
|
|
28
31
|
//# sourceMappingURL=FilterList.d.ts.map
|
|
@@ -2,7 +2,7 @@ import { default as React } from 'react';
|
|
|
2
2
|
import { RegisterOptions } from 'react-hook-form';
|
|
3
3
|
import { FormControlProps } from '@mui/material';
|
|
4
4
|
import { ICalculation, ICellRanges, IRange, IWorkbook } from '@sheetxl/sdk';
|
|
5
|
-
import { FormulaInputApi, FormulaInputGrammar, FormulaInputEquals, ReferenceDoneArgs } from '@sheetxl/react';
|
|
5
|
+
import { FormulaInputApi, FormulaInputGrammar, FormulaInputEquals, ReferenceDoneArgs, FormulaArgument } from '@sheetxl/react';
|
|
6
6
|
/**
|
|
7
7
|
* The height an `'above'` label adds over the input — its line plus the gap under it.
|
|
8
8
|
*
|
|
@@ -113,7 +113,16 @@ export interface FormulaFieldProps extends FormControlProps {
|
|
|
113
113
|
* table-resize shape. See `UseFormulaInputOptions.pickAs`.
|
|
114
114
|
*/
|
|
115
115
|
pickAs?: 'absolute' | 'relative';
|
|
116
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* Whether a pick that is exactly a dynamic array's spill writes `D2#` instead of its address.
|
|
118
|
+
* Default `false`, as Excel's range fields; the cell editor always does. See
|
|
119
|
+
* `UseFormulaInputOptions.pickSpills`.
|
|
120
|
+
*/
|
|
121
|
+
pickSpills?: boolean;
|
|
122
|
+
/**
|
|
123
|
+
* Allow a comma-separated multi-range reference (typed, or Ctrl+click-picked). Default `false`;
|
|
124
|
+
* a `'formula'` field defaults to `true` and gates only the pick. See `UseFormulaInputOptions.allowMulti`.
|
|
125
|
+
*/
|
|
117
126
|
allowMulti?: boolean;
|
|
118
127
|
/**
|
|
119
128
|
* Whether references may reach other sheets. Default `true`. Set `false` for a single-sheet input (a
|
|
@@ -161,11 +170,20 @@ export interface FormulaFieldProps extends FormControlProps {
|
|
|
161
170
|
* The parse error CHANGED — the message key, or `null` when the text became valid again.
|
|
162
171
|
*
|
|
163
172
|
* @remarks
|
|
173
|
+
* The error as the field would show it: held back while an operand is expected at the caret
|
|
174
|
+
* (`=A1+`, a lone `=`), and reported when the field is left that way.
|
|
175
|
+
*
|
|
164
176
|
* A message KEY, not a sentence (the same rule as `disabledReasons`): the error is state that
|
|
165
177
|
* outlives a language switch, so the chrome that renders it translates at display — `t(key)`, which
|
|
166
178
|
* passes a non-key through unchanged.
|
|
167
179
|
*/
|
|
168
180
|
onChangeError?: (error: string | null) => void;
|
|
181
|
+
/**
|
|
182
|
+
* An error the host found in text that PARSES — a list item holding the separator. Outlines the
|
|
183
|
+
* field and takes the helper line as a parse error does; a parse error wins when there are both.
|
|
184
|
+
* A message key or plain text, as {@link onChangeError}'s.
|
|
185
|
+
*/
|
|
186
|
+
validationError?: string | null;
|
|
169
187
|
/** Placeholder. Default `"Enter Formula"` (`'reference'` grammar: `"Enter Range"`). */
|
|
170
188
|
placeholder?: string;
|
|
171
189
|
/**
|
|
@@ -194,6 +212,11 @@ export interface FormulaFieldProps extends FormControlProps {
|
|
|
194
212
|
* decides which one takes first focus by tagging it, rather than by DOM order.
|
|
195
213
|
*/
|
|
196
214
|
classNameInput?: string;
|
|
215
|
+
/**
|
|
216
|
+
* The call argument this field's whole text is — the Function Arguments form's rows. An empty field
|
|
217
|
+
* then offers, in its hint popup, the values the parameter is limited to.
|
|
218
|
+
*/
|
|
219
|
+
argument?: FormulaArgument | null;
|
|
197
220
|
/**
|
|
198
221
|
* Reference to the element.
|
|
199
222
|
*/
|
|
@@ -66,8 +66,38 @@ export interface InputFieldProps extends FormControlProps {
|
|
|
66
66
|
formOptions?: RegisterOptions;
|
|
67
67
|
/** Field label. Default `"Name"`. */
|
|
68
68
|
label?: string;
|
|
69
|
+
/**
|
|
70
|
+
* Guidance shown under the field while it is VALID. The error takes that line when there is one —
|
|
71
|
+
* the field reserves it either way, so the layout never shifts.
|
|
72
|
+
*
|
|
73
|
+
* @remarks
|
|
74
|
+
* `null` (explicitly — not `undefined`, which takes the reserved default) COLLAPSES the line: the
|
|
75
|
+
* field's block ends at the input, so it centers against the buttons beside it in a toolbar-like
|
|
76
|
+
* row. An error then claims a line as it appears — for a field with no {@link onValidate}, or one
|
|
77
|
+
* whose host accepts the shift. The same contract as `FormulaField`'s `helperText`.
|
|
78
|
+
*/
|
|
79
|
+
helperText?: React.ReactNode | null;
|
|
80
|
+
/**
|
|
81
|
+
* Show the validation error on the field's helper line. Default `true`.
|
|
82
|
+
*
|
|
83
|
+
* @remarks
|
|
84
|
+
* `false` keeps the error outline but leaves the message to the host — for a host that collects it
|
|
85
|
+
* through {@link onChangeError} and shows it somewhere of its own. The same contract as
|
|
86
|
+
* `FormulaField`'s `showError`.
|
|
87
|
+
*/
|
|
88
|
+
showError?: boolean;
|
|
89
|
+
/**
|
|
90
|
+
* The validation error CHANGED — the message key, or `null` when the text became valid again.
|
|
91
|
+
* Translate at display (`t(key)` passes a non-key through unchanged).
|
|
92
|
+
*/
|
|
93
|
+
onChangeError?: (error: string | null) => void;
|
|
69
94
|
/** Hide the adornment cluster (the ✓/✗ pair shown while engaged in modal mode). */
|
|
70
95
|
hideAdornment?: boolean;
|
|
96
|
+
/**
|
|
97
|
+
* Attributes for the INNER `<input>` — `type`, `min`/`max`/`step`, `inputMode`, a class of the
|
|
98
|
+
* host's own. Merged over the field's defaults (spell-check and autocomplete off).
|
|
99
|
+
*/
|
|
100
|
+
propsInput?: React.InputHTMLAttributes<HTMLInputElement>;
|
|
71
101
|
/**
|
|
72
102
|
* Underlying reference to the input element.
|
|
73
103
|
*/
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FormatPanelProps } from './FormatPanelParts';
|
|
3
|
+
/**
|
|
4
|
+
* The **Alignment** tab of the format pane: where text sits in the cell, how it behaves when it
|
|
5
|
+
* does not fit, and which way it runs.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* The toggles are the ribbon's own commands, so they carry the ribbon's icons, tooltips, keyboard
|
|
9
|
+
* shortcuts and protection-disable for free — and pressing one here lights up the matching ribbon
|
|
10
|
+
* button, because both read the same command state. Only the two numeric fields (indent, custom
|
|
11
|
+
* angle) write the model directly: a spinner is a poor fit for a command's fire-once shape.
|
|
12
|
+
*/
|
|
13
|
+
export declare const AlignmentPanel: React.MemoExoticComponent<(props: FormatPanelProps) => React.JSX.Element>;
|
|
14
|
+
//# sourceMappingURL=AlignmentPanel.d.ts.map
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FormatPanelProps } from './FormatPanelParts';
|
|
3
|
+
/**
|
|
4
|
+
* The **Border** tab of the format pane.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Excel's model — and this one — treats a border as a PEN plus a set of edges, and the panel is laid
|
|
8
|
+
* out in that order: the pen first (color, then line style, since our line styles are drawn IN the
|
|
9
|
+
* color), then the presets, then the diagram with a button per edge around it, the way the Format
|
|
10
|
+
* Cells dialog arranges them.
|
|
11
|
+
*
|
|
12
|
+
* Every one of those buttons draws its own icon with the pen (see `BorderTemplateIcon`), so the
|
|
13
|
+
* whole panel restyles as the color or the line changes and each button previews its own edit.
|
|
14
|
+
*
|
|
15
|
+
* The pen is panel state, not cell state: it is what the next click will draw, so it survives
|
|
16
|
+
* moving the selection, exactly as the Format Cells dialog's does.
|
|
17
|
+
*
|
|
18
|
+
* Everything reads the SELECTION's border rather than the anchor cell's — inner rules only exist
|
|
19
|
+
* at range scope.
|
|
20
|
+
*/
|
|
21
|
+
export declare const BorderPanel: React.MemoExoticComponent<(props: FormatPanelProps) => React.JSX.Element>;
|
|
22
|
+
//# sourceMappingURL=BorderPanel.d.ts.map
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IBorders } from '@sheetxl/sdk';
|
|
3
|
+
import { TranslateFn } from '@sheetxl/utils-react';
|
|
4
|
+
/**
|
|
5
|
+
* The edges the diagram lets you click — the six that a block of cells can draw.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* The diagonals are not here: they would run corner to corner through both inner rules, and
|
|
9
|
+
* nearest-edge picking cannot separate three lines that all cross the same point.
|
|
10
|
+
*
|
|
11
|
+
* The order is the tie-break for a pointer sitting exactly where two lines cross, so the OUTER
|
|
12
|
+
* edges come first — a click on the left edge at its midpoint is aimed at the block's outline, not
|
|
13
|
+
* at the inner rule that happens to end there — and the dead center of the diagram, where only the
|
|
14
|
+
* two inner rules meet, belongs to the inside-horizontal one.
|
|
15
|
+
*/
|
|
16
|
+
export declare const PREVIEW_EDGES: readonly IBorders.Edge[];
|
|
17
|
+
/** The strokes currently drawn on a block, by edge. An absent entry means "no line here". */
|
|
18
|
+
export type BorderEdges = Partial<Record<IBorders.Edge, IBorders.StrokeProperties>>;
|
|
19
|
+
/** Localized name for a border edge; literal `t()` pairs keep the extractor able to see them. */
|
|
20
|
+
export declare function edgeLabel(t: TranslateFn, edge: IBorders.Edge): string;
|
|
21
|
+
/**
|
|
22
|
+
* The edge a pointer is aimed at, or `null` for none.
|
|
23
|
+
*
|
|
24
|
+
* @param x Pointer position relative to the diagram's top-left corner, in CSS px.
|
|
25
|
+
* @param y Pointer position relative to the diagram's top-left corner, in CSS px.
|
|
26
|
+
* @param width The diagram's width in CSS px.
|
|
27
|
+
* @param height The diagram's height in CSS px.
|
|
28
|
+
* @param isAvailable Whether an edge can be drawn at all — the inner rules cannot, on a selection
|
|
29
|
+
* with no inside, and an edge that cannot be drawn must not swallow a click aimed past it.
|
|
30
|
+
*
|
|
31
|
+
* @remarks
|
|
32
|
+
* Nearest line wins, which is the only rule that stays honest where two of them cross. Fixed
|
|
33
|
+
* rectangles cannot be: the inside-horizontal and inside-vertical zones necessarily overlap in the
|
|
34
|
+
* middle, whichever paints later takes the whole square, and clicking the horizontal rule anywhere
|
|
35
|
+
* near the center of the diagram toggles the vertical one instead.
|
|
36
|
+
*
|
|
37
|
+
* Exported because this is the part worth testing directly — jsdom lays nothing out, so a mounted
|
|
38
|
+
* diagram cannot be asked where its lines are.
|
|
39
|
+
*/
|
|
40
|
+
export declare function edgeAt(x: number, y: number, width: number, height: number, isAvailable: (edge: IBorders.Edge) => boolean): IBorders.Edge | null;
|
|
41
|
+
export interface BorderPreviewProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
42
|
+
/**
|
|
43
|
+
* What is drawn on each edge of the selected block right now.
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* Resolved DATA, not accessors: each edge of a block is read from a different cell (see
|
|
47
|
+
* `FormatSelection.getEdgeStroke`), and the panel is the one that knows which. Values also keep
|
|
48
|
+
* this component honestly re-rendering — a bag of stable callbacks looks unchanged to React even
|
|
49
|
+
* when the cells underneath have changed completely.
|
|
50
|
+
*/
|
|
51
|
+
edges: BorderEdges;
|
|
52
|
+
/** Mints the per-cell border the renderer draws. */
|
|
53
|
+
createBorder: (properties: Partial<IBorders.Properties>) => IBorders | null;
|
|
54
|
+
/** Toggle one edge with the panel's active pen. */
|
|
55
|
+
onToggleEdge: (edge: IBorders.Edge) => void;
|
|
56
|
+
/**
|
|
57
|
+
* Edges this selection cannot draw — the inner rules, on a selection with no inside.
|
|
58
|
+
*
|
|
59
|
+
* @remarks
|
|
60
|
+
* They are left OUT, not greyed out, and the diagram reshapes around them: a selection with no
|
|
61
|
+
* inside draws one cell rather than four with two dead lines through them. A target that cannot
|
|
62
|
+
* do anything is not information, and offering it is what made the inner rules feel broken.
|
|
63
|
+
*/
|
|
64
|
+
omittedEdges?: readonly IBorders.Edge[];
|
|
65
|
+
disabled?: boolean;
|
|
66
|
+
height?: number;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Excel's Format Cells → Border diagram: a block of cells whose edges you click to draw or clear.
|
|
70
|
+
*
|
|
71
|
+
* @remarks
|
|
72
|
+
* Two cells by two, not one — the inner rules have nowhere to show on a single cell, and they are
|
|
73
|
+
* half of what a border edit is about. The lines are a real {@link StaticBorderRenderer} fed the
|
|
74
|
+
* selection's own strokes, so what you click is what the grid will draw.
|
|
75
|
+
*
|
|
76
|
+
* Aiming is by DISTANCE rather than by zone (see {@link edgeAt}), and the feedback is the edge
|
|
77
|
+
* itself: hovering lights the line a click would toggle, along its whole length. Shading a
|
|
78
|
+
* quadrant says "somewhere around here"; a lit line says which line.
|
|
79
|
+
*/
|
|
80
|
+
export declare const BorderPreview: {
|
|
81
|
+
(props: BorderPreviewProps): React.ReactElement;
|
|
82
|
+
displayName: string;
|
|
83
|
+
};
|
|
84
|
+
//# sourceMappingURL=BorderPreview.d.ts.map
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FormatPanelProps } from './FormatPanelParts';
|
|
3
|
+
/**
|
|
4
|
+
* The **Fill** tab of the format pane — the one tab Excel Online does not have.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Excel buries pattern and gradient fills in a desktop-only "Fill Effects" sub-dialog, and Excel
|
|
8
|
+
* Online drops them entirely: on the web, a cell's fill is a single color. The model here has
|
|
9
|
+
* always carried all three (`IFill.Type.Solid | Pattern | Gradient`), so this tab surfaces them as
|
|
10
|
+
* one choice — pick the KIND of fill, then edit that kind — rather than hiding two of the three
|
|
11
|
+
* behind a button.
|
|
12
|
+
*
|
|
13
|
+
* `IFill.Type.None` is a fourth model type but not a fourth choice: it reads as Solid with the
|
|
14
|
+
* picker's *No Fill* swatch selected, the same swatch the ribbon offers. Setting a color was the
|
|
15
|
+
* common case and a No Fill entry in the type dropdown cost it an extra trip through that dropdown.
|
|
16
|
+
*
|
|
17
|
+
* Every control here reads {@link FormatSelection.style} and writes through
|
|
18
|
+
* {@link FormatSelection.applyStyle} — solid included. The solid swatch used to be the ribbon's
|
|
19
|
+
* `formatFillColor` command button, which reads and writes the SHEET's selection directly: correct
|
|
20
|
+
* in the task pane, wrong the moment a caller hands these panels a selection of their own. The
|
|
21
|
+
* command is still consulted for the picker's cross-surface memory (last-used color, recent
|
|
22
|
+
* colors), just not for the value.
|
|
23
|
+
*/
|
|
24
|
+
export declare const FillPanel: React.MemoExoticComponent<(props: FormatPanelProps) => React.JSX.Element>;
|
|
25
|
+
//# sourceMappingURL=FillPanel.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FormatPanelProps } from './FormatPanelParts';
|
|
3
|
+
/**
|
|
4
|
+
* The **Font** tab of the format pane: typeface, size, color and the character effects.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Every control here is the ribbon's own — the same family/size popups and the same toggles, just
|
|
8
|
+
* laid out for a narrow column instead of a strip. Nothing writes the model directly; the commands
|
|
9
|
+
* do, which is why the ribbon and this panel never disagree about what is bold.
|
|
10
|
+
*/
|
|
11
|
+
export declare const FontPanel: React.MemoExoticComponent<(props: FormatPanelProps) => React.JSX.Element>;
|
|
12
|
+
//# sourceMappingURL=FontPanel.d.ts.map
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FormatSelection } from './useFormatSelection';
|
|
3
|
+
export interface FormatCellPreviewProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
selection: FormatSelection;
|
|
5
|
+
/**
|
|
6
|
+
* Height of the preview box.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* Roughly two grid rows — enough for vertical alignment and a tilt to read, without the pane's
|
|
10
|
+
* top third being an empty rectangle.
|
|
11
|
+
*/
|
|
12
|
+
height?: number;
|
|
13
|
+
/**
|
|
14
|
+
* Widest the preview box is drawn, in px. It still shrinks with a narrower pane.
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* A cap, not a width: the pane is several cell-widths wide, and a preview stretched across all of
|
|
18
|
+
* it stops reading as a cell — a filled format (accounting's `* `) spans the whole span, and the
|
|
19
|
+
* ends land a hand's width apart. This keeps the box near the width the value would actually be
|
|
20
|
+
* shown at.
|
|
21
|
+
*/
|
|
22
|
+
maxWidth?: number;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* The one preview shared by every tab of the format pane: the selection's ANCHOR cell, rendered the
|
|
26
|
+
* way the grid will render it.
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
* The pane applies live, so this is not a "what you would get" mock — it is the cell, re-read after
|
|
30
|
+
* each edit. Only the VALUE is ever substituted: a cell holding text (or nothing) previews
|
|
31
|
+
* {@link SAMPLE_VALUE} instead, so the Number tab has something to format. The style is always the
|
|
32
|
+
* real one.
|
|
33
|
+
*/
|
|
34
|
+
export declare const FormatCellPreview: React.MemoExoticComponent<(props: FormatCellPreviewProps) => React.JSX.Element>;
|
|
35
|
+
//# sourceMappingURL=FormatCellPreview.d.ts.map
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { Theme, SxProps } from '@mui/material';
|
|
3
|
+
import { FormatSelection } from './useFormatSelection';
|
|
4
|
+
/**
|
|
5
|
+
* What every tab of the format pane takes: the live selection, and nothing else.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* Each panel is a standalone component — drop it in a dialog or an inspector by handing it a
|
|
9
|
+
* {@link FormatSelection} of your own. They apply live (no OK button), matching Excel Online.
|
|
10
|
+
*/
|
|
11
|
+
export interface FormatPanelProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
12
|
+
/** The live selection the panel reads and writes. */
|
|
13
|
+
selection: FormatSelection;
|
|
14
|
+
/** Force every control off, on top of the selection's own {@link FormatSelection.disabled}. */
|
|
15
|
+
disabled?: boolean;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* An `onClick` for a `MenuItem` inside a MUI `Select`: what to do when the item picked is the one
|
|
19
|
+
* the dropdown already shows.
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* `Select` fires `onChange` only for a DIFFERENT value. But the pane shows the ANCHOR cell's format,
|
|
23
|
+
* and the rest of a multi-cell selection need not match it — so picking *Accounting* over an anchor
|
|
24
|
+
* that is already Accounting is a request to make the whole selection so, not a no-op. `Select`
|
|
25
|
+
* runs an item's own `onClick` before deciding whether anything changed, which makes it the hook
|
|
26
|
+
* for that case.
|
|
27
|
+
*/
|
|
28
|
+
export declare const onReselect: <T>(shown: T, item: T, apply: () => void) => () => void;
|
|
29
|
+
export interface FormatNumberFieldProps {
|
|
30
|
+
label: string;
|
|
31
|
+
/** The committed value — the anchor cell's. */
|
|
32
|
+
value: number;
|
|
33
|
+
min: number;
|
|
34
|
+
max: number;
|
|
35
|
+
/** The spinner's increment. Default `1`. */
|
|
36
|
+
step?: number;
|
|
37
|
+
/** Width in px. These sit in rows beside buttons, not in a form column. */
|
|
38
|
+
width: number;
|
|
39
|
+
disabled?: boolean;
|
|
40
|
+
/** A value to apply — typed, stepped, or re-committed with Enter. Already clamped to `min…max`. */
|
|
41
|
+
onChange: (value: number) => void;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* A whole-number field for the format pane: an {@link InputField} with a numeric input, no helper
|
|
45
|
+
* line, and a commit on Enter.
|
|
46
|
+
*
|
|
47
|
+
* @remarks
|
|
48
|
+
* A plain controlled `TextField` applied on every keystroke but could not apply what it already
|
|
49
|
+
* showed — typing the value on display fires no change event — and the pane shows the ANCHOR cell's
|
|
50
|
+
* value while the rest of the selection may differ (the same problem {@link onReselect} solves for
|
|
51
|
+
* the dropdowns). `InputField`'s commit channel fires on Enter whether or not the text changed, so
|
|
52
|
+
* Enter here means "the whole selection, this value". The live channel keeps the keystroke-by-
|
|
53
|
+
* keystroke apply, and the spinner arrows with it.
|
|
54
|
+
*
|
|
55
|
+
* The two channels overlap: every edit the live channel applied reaches the commit channel again
|
|
56
|
+
* (Escape included — the cancel's revert runs through the live channel first). The field remembers
|
|
57
|
+
* what it applied since the session began and skips an identical commit, so an edit never writes
|
|
58
|
+
* twice, and Enter with nothing edited is the only time the commit channel writes.
|
|
59
|
+
*/
|
|
60
|
+
export declare const FormatNumberField: React.MemoExoticComponent<(props: FormatNumberFieldProps) => React.JSX.Element>;
|
|
61
|
+
/** The vertical rhythm every format panel shares. */
|
|
62
|
+
export declare const panelSx: SxProps<Theme>;
|
|
63
|
+
export interface FormatSectionProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
64
|
+
/** The section heading. Omit for an unlabeled group. */
|
|
65
|
+
label?: string;
|
|
66
|
+
sx?: SxProps<Theme>;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* A labeled group of controls — the pane's answer to Excel's group boxes, without the box.
|
|
70
|
+
*/
|
|
71
|
+
export declare const FormatSection: React.MemoExoticComponent<(props: FormatSectionProps) => React.JSX.Element>;
|
|
72
|
+
export interface FormatRowProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
73
|
+
sx?: SxProps<Theme>;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* A wrapping row of controls. The pane is narrow and resizable, so rows wrap rather than clip.
|
|
77
|
+
*/
|
|
78
|
+
export declare const FormatRow: React.MemoExoticComponent<(props: FormatRowProps) => React.JSX.Element>;
|
|
79
|
+
/**
|
|
80
|
+
* A strip of icon buttons that reads as one control — the alignment toggles, the font effects.
|
|
81
|
+
*/
|
|
82
|
+
export declare const FormatButtonGroup: React.MemoExoticComponent<(props: FormatRowProps) => React.JSX.Element>;
|
|
83
|
+
//# sourceMappingURL=FormatPanelParts.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The key the format pane registers under — what `activateTaskPane` and the `formatCells` command
|
|
3
|
+
* address it by.
|
|
4
|
+
*/
|
|
5
|
+
export declare const FORMAT_TASK_PANE_KEY = "formatCells";
|
|
6
|
+
/**
|
|
7
|
+
* Registers the Format Cells task pane. Called from the studio bootstrap alongside the other
|
|
8
|
+
* built-in panes.
|
|
9
|
+
*/
|
|
10
|
+
export declare const FormatPlugin: () => void;
|
|
11
|
+
//# sourceMappingURL=FormatPlugin.d.ts.map
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IWorkbook } from '@sheetxl/sdk';
|
|
3
|
+
import { TaskPaneProps } from '@sheetxl/react';
|
|
4
|
+
/** The pane's tabs, in Excel's own order (with Fill where Excel keeps Patterns). */
|
|
5
|
+
export declare const FormatTab: {
|
|
6
|
+
readonly Number: "number";
|
|
7
|
+
readonly Alignment: "alignment";
|
|
8
|
+
readonly Font: "font";
|
|
9
|
+
readonly Border: "border";
|
|
10
|
+
readonly Fill: "fill";
|
|
11
|
+
};
|
|
12
|
+
export type FormatTab = typeof FormatTab[keyof typeof FormatTab];
|
|
13
|
+
/**
|
|
14
|
+
* What a command may ask the format pane to open on — `activateTaskPane('formatCells', { args })`.
|
|
15
|
+
*/
|
|
16
|
+
export interface FormatPaneArgs {
|
|
17
|
+
/** The tab to show. Omit to reopen on whichever tab the user was last on. */
|
|
18
|
+
tab?: FormatTab;
|
|
19
|
+
}
|
|
20
|
+
/** Persistence key for {@link FormatPaneArgs.tab | the tab} an argument-less activation returns to. */
|
|
21
|
+
export declare const FORMAT_TAB_KEY = "format.tab";
|
|
22
|
+
/**
|
|
23
|
+
* The **Format Cells** task pane: one preview over five tabs, applying live to the selection.
|
|
24
|
+
*
|
|
25
|
+
* @remarks
|
|
26
|
+
* Modeled on Excel Online's format pane, with two deliberate departures.
|
|
27
|
+
*
|
|
28
|
+
* The **preview is shared**. Excel Online gives each of its panels its own sample, which means the
|
|
29
|
+
* font sample cannot show you the number format and the number sample cannot show you the fill.
|
|
30
|
+
* One preview of the actual anchor cell answers every tab at once — and since the pane applies
|
|
31
|
+
* live, it is not a mock of the result, it IS the result.
|
|
32
|
+
*
|
|
33
|
+
* There is a **Fill tab**, which Excel Online has no equivalent for: the model carries pattern and
|
|
34
|
+
* gradient fills, and burying them the way desktop Excel does (a "Fill Effects" sub-dialog) is not
|
|
35
|
+
* worth copying. See {@link FillPanel}.
|
|
36
|
+
*/
|
|
37
|
+
export declare const FormatTaskPane: React.MemoExoticComponent<(props: TaskPaneProps<IWorkbook, FormatPaneArgs>) => React.JSX.Element>;
|
|
38
|
+
export default FormatTaskPane;
|
|
39
|
+
//# sourceMappingURL=FormatTaskPane.d.ts.map
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { Theme, SxProps } from '@mui/material';
|
|
3
|
+
import { NumberFormat } from '@sheetxl/sdk';
|
|
4
|
+
import { TranslateFn } from '@sheetxl/utils-react';
|
|
5
|
+
type Category = NumberFormat.Category;
|
|
6
|
+
export interface NumberFormatOptionProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
7
|
+
/** The format's name — a {@link NumberFormat.Type} in the toolbar, a category in the pane. */
|
|
8
|
+
label: string;
|
|
9
|
+
/**
|
|
10
|
+
* A live sample of the selection formatted this way. Blank keeps the row's height, so a list
|
|
11
|
+
* where only some rows can show a sample stays evenly spaced.
|
|
12
|
+
*/
|
|
13
|
+
sample?: string;
|
|
14
|
+
/**
|
|
15
|
+
* MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
|
|
16
|
+
*/
|
|
17
|
+
sx?: SxProps<Theme>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* The body of a number-format row: the format's name over what the current cell looks like in it.
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* Deliberately item-chrome free. The toolbar popup and the format pane's category dropdown each
|
|
24
|
+
* wrap it in their own `ExhibitMenuItem`, since the two rows select differently (a command versus
|
|
25
|
+
* the pane's `onChange`).
|
|
26
|
+
*/
|
|
27
|
+
export declare const NumberFormatOption: React.MemoExoticComponent<(props: NumberFormatOptionProps) => React.JSX.Element>;
|
|
28
|
+
/**
|
|
29
|
+
* Localized display name for a {@link NumberFormat.Type}. The canonical Type
|
|
30
|
+
* string stays the identity (state/lookup); this is display-only. Reuses the
|
|
31
|
+
* dialog's `numberFormat.cat*` keys where a type maps 1:1 to a category, plus
|
|
32
|
+
* `numberFormat.type*` for the granular date/time + comma variants the toolbar
|
|
33
|
+
* exposes. Unknown types fall back to the canonical name.
|
|
34
|
+
*/
|
|
35
|
+
export declare const numberFormatTypeLabel: (t: TranslateFn, type: string) => string;
|
|
36
|
+
/**
|
|
37
|
+
* Localized display name for a category. The SDK's `Builder.CATEGORIES` strings are canonical
|
|
38
|
+
* (they are the `Category` identity values) — a literal `t()` pair per category keeps the
|
|
39
|
+
* extractor seeing `key → english`; unknown categories fall back to the canonical name.
|
|
40
|
+
*/
|
|
41
|
+
export declare const numberFormatCategoryLabel: (t: TranslateFn, category: Category) => string;
|
|
42
|
+
export {};
|
|
43
|
+
//# sourceMappingURL=NumberFormatOption.d.ts.map
|
|
@@ -15,6 +15,26 @@ export interface NumberFormatPanelProps extends Omit<React.HTMLAttributes<HTMLDi
|
|
|
15
15
|
* Not used in a task pane, where the panel applies live.
|
|
16
16
|
*/
|
|
17
17
|
onCommit?: () => void;
|
|
18
|
+
/**
|
|
19
|
+
* Drop the panel's own sample line.
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* For a host that already shows the formatted cell — the format task pane's shared preview —
|
|
23
|
+
* where a second sample of the same value is noise.
|
|
24
|
+
*/
|
|
25
|
+
hideSample?: boolean;
|
|
26
|
+
/**
|
|
27
|
+
* Show the one-click formats — accounting, percent, comma, and the decimal nudges — above the
|
|
28
|
+
* category.
|
|
29
|
+
*
|
|
30
|
+
* @remarks
|
|
31
|
+
* Off by default because they are commands: they format the SELECTION rather than routing
|
|
32
|
+
* through `onChange`, so a host whose target is something else (a dialog editing a style, a
|
|
33
|
+
* preview) must leave them out.
|
|
34
|
+
*
|
|
35
|
+
* @defaultValue false
|
|
36
|
+
*/
|
|
37
|
+
showQuickFormats?: boolean;
|
|
18
38
|
/** Disable all controls. */
|
|
19
39
|
disabled?: boolean;
|
|
20
40
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export * from './useFormatSelection';
|
|
2
|
+
export * from './FormatPanelParts';
|
|
3
|
+
export * from './FormatCellPreview';
|
|
4
|
+
export * from './NumberFormatOption';
|
|
5
|
+
export * from './NumberFormatPanel';
|
|
6
|
+
export * from './AlignmentPanel';
|
|
7
|
+
export * from './FontPanel';
|
|
8
|
+
export * from './FillPanel';
|
|
9
|
+
export * from './BorderPanel';
|
|
10
|
+
export * from './BorderPreview';
|
|
11
|
+
export * from './FormatTaskPane';
|
|
12
|
+
export * from './FormatPlugin';
|
|
13
|
+
//# sourceMappingURL=index.d.ts.map
|