@svgrid/enterprise 3.0.0 → 3.0.2

package/dist/sheet/ribbon-icons.js

@@ -0,0 +1,350 @@
+/**
+ * The ribbon's icons, as path data on a 16 x 16 grid.
+ *
+ * Drawn here rather than pulled from an icon font or a package: the ribbon
+ * is the one place in the library that needs a coordinated set of command
+ * glyphs (a clipboard, scissors, a paint bucket, a funnel), and an icon set
+ * that is part of the source can be read, tested and tuned like anything
+ * else. `SvRibbonIcon.svelte` renders one by name; a large button draws the
+ * same paths at twice the size, which is why they are vectors.
+ *
+ * One style, one colour. These are line icons - a 1.4px stroke with round
+ * caps and joins, the way Excel's own monochrome set is drawn - and every
+ * one of them is `currentColor`, so they are black on a light ribbon and
+ * white on a dark one and never carry a colour of their own. The only fills
+ * are the small solid parts Excel also fills: a dot, a corner, the head of
+ * an arrow. Colour belongs to the colour bar under Fill Colour and Font
+ * Colour, which shows the colour the face will apply, not to the glyph.
+ */
+const SQUARE = 'M2.5 2.5h11v11h-11z';
+const CROSS = 'M2.5 8h11M8 2.5v11';
+const DASHED = '1.6 1.6';
+/** A clipboard: the board, then the clip on top. */
+const CLIPBOARD = [
+    { d: 'M5.5 3H4.5A1.5 1.5 0 0 0 3 4.5v8A1.5 1.5 0 0 0 4.5 14h7a1.5 1.5 0 0 0 1.5-1.5v-8A1.5 1.5 0 0 0 11.5 3h-1' },
+    { d: 'M6 1.5h4a.5.5 0 0 1 .5.5v1.5a.5.5 0 0 1-.5.5H6a.5.5 0 0 1-.5-.5V2a.5.5 0 0 1 .5-.5z' },
+];
+/** A speech bubble with its tail at the bottom left. */
+const BUBBLE = 'M3.5 2.5h9a1.5 1.5 0 0 1 1.5 1.5v6a1.5 1.5 0 0 1-1.5 1.5H7l-3 2.5v-2.5h-.5A1.5 1.5 0 0 1 2 10V4a1.5 1.5 0 0 1 1.5-1.5z';
+/** A sheet of paper with a folded corner. */
+const SHEET = [{ d: 'M4 1.5h5.5l3 3v10H4z' }, { d: 'M9.5 1.5v3h3' }];
+export const RIBBON_ICONS = {
+    /* The curved arrows: an open arc, the head at its tip pointing back down
+       to the lower-left (or right); closing the arc any further reads as a
+       refresh glyph. */
+    undo: [
+        { d: 'M3.3 6.6A5.6 5.6 0 1 1 9.6 13.9', width: 1.6 },
+        { d: 'M3.3 6.6V2.8M3.3 6.6h3.8', width: 1.6 },
+    ],
+    redo: [
+        { d: 'M12.7 6.6A5.6 5.6 0 1 0 6.4 13.9', width: 1.6 },
+        { d: 'M12.7 6.6V2.8M12.7 6.6h-3.8', width: 1.6 },
+    ],
+    paste: [
+        ...CLIPBOARD,
+        { d: 'M6 7h4M6 9.5h4M6 12h2.5' },
+    ],
+    cut: [
+        { d: 'M4.5 14a2.2 2.2 0 1 0 0-4.4 2.2 2.2 0 0 0 0 4.4zM11.5 14a2.2 2.2 0 1 0 0-4.4 2.2 2.2 0 0 0 0 4.4z' },
+        { d: 'M6.1 10.2L12.5 2M9.9 10.2L3.5 2' },
+    ],
+    copy: [
+        { d: 'M6 5.5h6.5a1 1 0 0 1 1 1v6.5a1 1 0 0 1-1 1H6a1 1 0 0 1-1-1V6.5a1 1 0 0 1 1-1z' },
+        { d: 'M10 5.5V3.5a1 1 0 0 0-1-1H3.5a1 1 0 0 0-1 1V9a1 1 0 0 0 1 1H5' },
+    ],
+    'paste-special': [
+        ...CLIPBOARD,
+        { d: 'M8 6.5v5M5.5 9h5' },
+    ],
+    // A brush: the head as a tilted block, the handle running down-left.
+    'format-painter': [
+        { d: 'M9.2 2.4l4.4 4.4-3.2 3.2-4.4-4.4z' },
+        { d: 'M6 5.6L3.2 8.4a1.6 1.6 0 0 0 0 2.3l2.1 2.1a1.6 1.6 0 0 0 2.3 0l2.8-2.8' },
+    ],
+    'font-grow': [
+        { d: 'M2 12.5L5.5 4l3.5 8.5M3.2 9.5h4.6' },
+        { d: 'M12.5 3.5v7M10.5 5.5l2-2 2 2' },
+    ],
+    'font-shrink': [
+        { d: 'M2 12.5L5.5 4l3.5 8.5M3.2 9.5h4.6' },
+        { d: 'M12.5 3.5v7M10.5 8.5l2 2 2-2' },
+    ],
+    borders: [{ d: SQUARE, dash: DASHED }, { d: CROSS, dash: DASHED }, { d: 'M2.5 13.5h11', width: 2 }],
+    'border-none': [{ d: SQUARE, dash: DASHED }, { d: CROSS, dash: DASHED }],
+    'border-bottom': [{ d: SQUARE, dash: DASHED }, { d: CROSS, dash: DASHED }, { d: 'M2.5 13.5h11', width: 2 }],
+    'border-top': [{ d: SQUARE, dash: DASHED }, { d: CROSS, dash: DASHED }, { d: 'M2.5 2.5h11', width: 2 }],
+    'border-left': [{ d: SQUARE, dash: DASHED }, { d: CROSS, dash: DASHED }, { d: 'M2.5 2.5v11', width: 2 }],
+    'border-right': [{ d: SQUARE, dash: DASHED }, { d: CROSS, dash: DASHED }, { d: 'M13.5 2.5v11', width: 2 }],
+    'border-all': [{ d: SQUARE, width: 1.6 }, { d: CROSS, width: 1.6 }],
+    'border-outside': [{ d: SQUARE, width: 2 }, { d: CROSS, dash: DASHED }],
+    'border-thick-bottom': [{ d: SQUARE, dash: DASHED }, { d: CROSS, dash: DASHED }, { d: 'M2.5 13h11', width: 3 }],
+    'fill-colour': [
+        // A tipped paint bucket with a spilling drop, the shape Excel uses.
+        { d: 'M7.5 2.5l5 5-4.3 4.3a1.5 1.5 0 0 1-2.1 0L3 8.7a1 1 0 0 1 0-1.4z' },
+        { d: 'M3.2 8h8.6' },
+        { d: 'M7.5 2.5L6 1' },
+        { d: 'M13.2 9.3c.9 1.1 1.3 1.9 1.3 2.5a1.3 1.3 0 0 1-2.6 0c0-.6.4-1.4 1.3-2.5z', fill: true },
+    ],
+    'font-colour': [
+        { d: 'M3 12.5L7.5 2l4.5 10.5M4.6 9h5.8', width: 1.6 },
+    ],
+    'align-left': [{ d: 'M2.5 3.5h11M2.5 6.5h7M2.5 9.5h11M2.5 12.5h7' }],
+    'align-center': [{ d: 'M2.5 3.5h11M4.5 6.5h7M2.5 9.5h11M4.5 12.5h7' }],
+    'align-right': [{ d: 'M2.5 3.5h11M6.5 6.5h7M2.5 9.5h11M6.5 12.5h7' }],
+    wrap: [
+        { d: 'M2.5 4h11M2.5 8h8a2.25 2.25 0 0 1 0 4.5H8.5M2.5 12h3' },
+        { d: 'M10 10.5l-2 2 2 2' },
+    ],
+    'dec-more': [
+        { d: 'M2.6 13h.01', width: 2.2 },
+        { d: 'M6 13a1.6 2.2 0 1 0 0-.01M11.2 13a1.6 2.2 0 1 0 0-.01', width: 1.3 },
+        { d: 'M7.5 4h6M11.5 2l2 2-2 2' },
+    ],
+    'dec-less': [
+        { d: 'M2.6 13h.01', width: 2.2 },
+        { d: 'M6 13a1.6 2.2 0 1 0 0-.01', width: 1.3 },
+        { d: 'M13.5 4h-6M9.5 2l-2 2 2 2' },
+    ],
+    'insert-cells': [
+        { d: 'M2.5 2.5h6M2.5 2.5v11h11V8' },
+        { d: 'M2.5 8h11M8 2.5v11' },
+        { d: 'M12.5 1.5v4M10.5 3.5h4', width: 1.7 },
+    ],
+    'delete-cells': [
+        { d: 'M2.5 2.5h6M2.5 2.5v11h11V6' },
+        { d: 'M2.5 8h11M8 2.5v11' },
+        { d: 'M10.5 3.5h4', width: 1.7 },
+    ],
+    freeze: [
+        { d: SQUARE },
+        { d: 'M2.5 6h11M6 2.5v11', width: 1.6 },
+        { d: 'M2.5 2.5h3.5v3.5H2.5z', fill: true },
+    ],
+    /* An A, for the folded Font group. */
+    font: [{ d: 'M3 13.5L8 2.5l5 11M4.9 9.5h6.2' }],
+    /* A number sign, for the folded Number group. */
+    number: [{ d: 'M6 2.5L4.5 13.5M11.5 2.5L10 13.5M3 6h11M2 10.5h11' }],
+    /* A 3x3 of cells: the lines the Gridlines toggle shows and hides. */
+    gridlines: [
+        { d: SQUARE },
+        { d: 'M2.5 6.2h11M2.5 9.8h11M6.2 2.5v11M9.8 2.5v11', width: 1.1 },
+    ],
+    /* The bar itself: a long box with fx in it. */
+    'formula-bar': [
+        { d: 'M1.5 5h13v6h-13z' },
+        { d: 'M4.8 9.6V7.4a1.1 1.1 0 0 1 1.1-1.1M3.9 8.2h2', width: 1.3 },
+        { d: 'M8.3 6.9l3 2.8M11.3 6.9l-3 2.8', width: 1.1 },
+    ],
+    /* The header band and the row gutter framing a sheet. */
+    headings: [
+        { d: SQUARE },
+        { d: 'M2.5 5.5h11M5.5 2.5v11' },
+        { d: 'M7.5 4h.01M9.8 4h.01M12 4h.01M4 7.5h.01M4 9.8h.01M4 12h.01', width: 1.6 },
+    ],
+    /* The frozen lines dotted, and struck through. */
+    unfreeze: [
+        { d: SQUARE },
+        { d: 'M2.5 6h11M6 2.5v11', dash: DASHED },
+        { d: 'M3.5 12.5l9-9' },
+    ],
+    autosum: [{ d: 'M12 3.5H4l4.5 4.5L4 12.5h8', width: 1.7 }],
+    'fill-down': [
+        { d: 'M2.5 13.5h11' },
+        { d: 'M8 2.5v8M5 7.5l3 3 3-3' },
+    ],
+    'fill-right': [
+        { d: 'M13.5 2.5v11' },
+        { d: 'M2.5 8h8M7.5 5l3 3-3 3' },
+    ],
+    clear: [
+        // An eraser on its side: the body, the split between rubber and grip,
+        // and the line it is wiping.
+        { d: 'M9.5 2.5l4 4-6.5 6.5H4.5L2.5 11l7-8.5z' },
+        { d: 'M6 6l4 4' },
+        { d: 'M4 14.5h9.5' },
+    ],
+    /* The eraser, smaller, over an A: formats wiped, the text kept. */
+    'clear-formats': [
+        { d: 'M2.5 13.5L6 5l3.5 8.5M3.8 10.5h4.4' },
+        { d: 'M11.5 2.5l2.5 2.5-4 4-2.5-2.5z' },
+        { d: 'M9.5 6.5l2.5 2.5' },
+    ],
+    /* A column's two edges and the arrow that sets the gap between them. */
+    'column-width': [
+        { d: 'M4 2v12M12 2v12' },
+        { d: 'M5 8h6M6.6 6.4L5 8l1.6 1.6M9.4 6.4L11 8l-1.6 1.6' },
+    ],
+    'row-height': [
+        { d: 'M2 4h12M2 12h12' },
+        { d: 'M8 5v6M6.4 6.6L8 5l1.6 1.6M6.4 9.4L8 11l1.6-1.6' },
+    ],
+    /* An eye, open for Unhide and struck through for Hide. */
+    hide: [
+        { d: 'M1.8 8s2.3-4 6.2-4 6.2 4 6.2 4-2.3 4-6.2 4-6.2-4-6.2-4z' },
+        { d: 'M8 9.8a1.8 1.8 0 1 0 0-3.6 1.8 1.8 0 0 0 0 3.6z' },
+        { d: 'M3 13L13 3' },
+    ],
+    unhide: [
+        { d: 'M1.8 8s2.3-4 6.2-4 6.2 4 6.2 4-2.3 4-6.2 4-6.2-4-6.2-4z' },
+        { d: 'M8 9.8a1.8 1.8 0 1 0 0-3.6 1.8 1.8 0 0 0 0 3.6z' },
+    ],
+    find: [
+        { d: 'M7 11.5a4.5 4.5 0 1 0 0-9 4.5 4.5 0 0 0 0 9z' },
+        { d: 'M10.3 10.3L14 14', width: 1.8 },
+    ],
+    filter: [
+        { d: 'M2.5 3h11l-4.3 5.3v3.9L6.8 13.5V8.3z' },
+    ],
+    'sort-asc': [
+        { d: 'M3 6.5l2-4 2 4M3.6 5.3h2.8', width: 1.2 },
+        { d: 'M3.2 9.5h3.6l-3.6 4h3.6', width: 1.2 },
+        { d: 'M12 2.5v11M9.5 11l2.5 2.5 2.5-2.5' },
+    ],
+    'sort-desc': [
+        { d: 'M3.2 2.5h3.6l-3.6 4h3.6', width: 1.2 },
+        { d: 'M3 13.5l2-4 2 4M3.6 12.3h2.8', width: 1.2 },
+        { d: 'M12 2.5v11M9.5 11l2.5 2.5 2.5-2.5' },
+    ],
+    chart: [
+        { d: 'M2.5 2.5v11h11' },
+        { d: 'M4.5 13.5V8h2.5v5.5M8 13.5V4.5h2.5v9M11.5 13.5V10h2v3.5' },
+    ],
+    /* A table: the header row is the one drawn heavier. */
+    table: [
+        { d: 'M2.5 3h11v10h-11z' },
+        { d: 'M2.5 9.5h11M6.2 6.5v6.5M9.8 6.5v6.5' },
+        { d: 'M2.5 6.5h11', width: 2 },
+    ],
+    function: [
+        { d: 'M2.5 3h11v10h-11z' },
+        { d: 'M6.8 11V6.5a1.4 1.4 0 0 1 1.4-1.4M5.6 8h2.6', width: 1.5 },
+        { d: 'M9 8l2.7 3M11.7 8L9 11', width: 1.3 },
+    ],
+    'new-sheet': [
+        ...SHEET,
+        { d: 'M8.2 6.5v5M5.7 9h5', width: 1.7 },
+    ],
+    'name-manager': [
+        { d: 'M2.5 3.5A1 1 0 0 1 3.5 2.5h4.6l5.4 5.4-4.9 4.9L3.5 8.4a1 1 0 0 1-1-1z' },
+        { d: 'M5.6 5.6h.01', width: 2.2 },
+    ],
+    'show-formulas': [
+        { d: 'M2.5 3.5h11v9h-11z' },
+        { d: 'M6.3 10.5V7a1.2 1.2 0 0 1 1.2-1.2M5.2 8h2.4', width: 1.4 },
+        { d: 'M8.6 8l2.4 2.5M11 8l-2.4 2.5', width: 1.2 },
+    ],
+    calculate: [
+        { d: 'M4 1.5h8a1 1 0 0 1 1 1v11a1 1 0 0 1-1 1H4a1 1 0 0 1-1-1v-11a1 1 0 0 1 1-1z' },
+        { d: 'M5 3.5h6v2.5H5z' },
+        { d: 'M5.5 8.5h.01M8 8.5h.01M10.5 8.5h.01M5.5 11h.01M8 11h.01M10.5 11h.01', width: 1.8 },
+    ],
+    'goal-seek': [
+        { d: 'M8 14a6 6 0 1 0 0-12 6 6 0 0 0 0 12z' },
+        { d: 'M8 11a3 3 0 1 0 0-6 3 3 0 0 0 0 6z' },
+        { d: 'M8 8h.01', width: 2.4 },
+    ],
+    'text-to-columns': [
+        { d: 'M2.5 3.5h11v9h-11z' },
+        { d: 'M8 3.5v9', dash: DASHED },
+        { d: 'M6.5 8H4M5 6.5L3.5 8 5 9.5M9.5 8H12M11 6.5L12.5 8 11 9.5' },
+    ],
+    /* Two rows the same, the second crossed out. */
+    'remove-duplicates': [
+        { d: 'M2.5 3h11v3.5h-11zM2.5 9.5h11v3.5h-11z' },
+        { d: 'M5 4.75h6M5 11.25h6', width: 1.2 },
+        { d: 'M11 8.5l3 3M14 8.5l-3 3', width: 1.5 },
+    ],
+    'chevron-down': [{ d: 'M4 6.5l4 4 4-4' }],
+    /* Four cells, one of them shaded by hatching rather than a slab. */
+    'format-cells': [
+        { d: SQUARE },
+        { d: CROSS },
+        { d: 'M9.5 11.5l2-2M9.5 13.5l4-4M11.5 13.5l2-2', width: 1 },
+    ],
+    // A padlock: the body, the shackle, the keyhole dot.
+    lock: [
+        { d: 'M3.5 7.5h9v6.5h-9z' },
+        { d: 'M5.5 7.5V5a2.5 2.5 0 0 1 5 0v2.5' },
+        { d: 'M8 10.2a.7.7 0 1 0 0 .1z', fill: true },
+    ],
+    // A sheet with a padlock over its corner: locked cells hold.
+    protect: [
+        { d: 'M2.5 2.5h7v3h-7zM2.5 5.5v8h5' },
+        { d: 'M2.5 5.5h7M5.5 2.5v11' },
+        { d: 'M9 10h5v4H9z' },
+        { d: 'M10 10V8.8a1.5 1.5 0 0 1 3 0V10' },
+    ],
+    // The same sheet, the shackle open.
+    unprotect: [
+        { d: 'M2.5 2.5h7v3h-7zM2.5 5.5v8h5' },
+        { d: 'M2.5 5.5h7M5.5 2.5v11' },
+        { d: 'M9 10h5v4H9z' },
+        { d: 'M10 10V8.8a1.5 1.5 0 0 1 3 0' },
+    ],
+    // A speech bubble, and the same bubble with a mark inside or beside it.
+    comment: [
+        { d: BUBBLE },
+        { d: 'M8 5v3', width: 1.5 },
+        { d: 'M8 10.5a.5.5 0 1 0 0 .1z', fill: true },
+    ],
+    'comment-delete': [
+        { d: BUBBLE },
+        { d: 'M6 5.5l4 4M10 5.5l-4 4' },
+    ],
+    'comment-prev': [
+        { d: BUBBLE },
+        { d: 'M9.5 5l-3 2.5 3 2.5' },
+    ],
+    'comment-next': [
+        { d: BUBBLE },
+        { d: 'M6.5 5l3 2.5-3 2.5' },
+    ],
+    'comments-all': [
+        { d: 'M2.5 2.5h7a1 1 0 0 1 1 1v4a1 1 0 0 1-1 1H6l-2 2v-2H2.5a1 1 0 0 1-1-1v-4a1 1 0 0 1 1-1z' },
+        { d: 'M12 6.5h1.5a1 1 0 0 1 1 1v4a1 1 0 0 1-1 1H13v2l-2-2H7.5a1 1 0 0 1-1-1v-1' },
+    ],
+    // Conditional formatting: a table with its bottom-right cell filled.
+    /* Conditional formatting: cells, one of them carrying a bar. */
+    cf: [
+        { d: SQUARE },
+        { d: CROSS },
+        { d: 'M3.8 4.5h2.4M3.8 6h1.4M9.3 10h3.4M9.3 11.5h2', width: 1.6 },
+    ],
+    'cf-greater': [{ d: 'M4 3.5l7 4.5-7 4.5' }],
+    'cf-less': [{ d: 'M12 3.5L5 8l7 4.5' }],
+    'cf-between': [{ d: 'M3 4v8M13 4v8M5.5 8h5' }, { d: 'M5.5 8l2-2M5.5 8l2 2M10.5 8l-2-2M10.5 8l-2 2' }],
+    'cf-equal': [{ d: 'M3.5 6h9M3.5 10h9' }],
+    'cf-text': [{ d: 'M3 12.5L6.5 3.5l3.5 9M4.2 9.5h4.6' }, { d: 'M12.5 8v4.5' }],
+    'cf-duplicates': [{ d: 'M2.5 2.5h7v7h-7z' }, { d: 'M6.5 6.5h7v7h-7z' }],
+    'cf-top': [{ d: 'M8 13V4M4.5 7.5L8 4l3.5 3.5' }, { d: 'M3 2.5h10' }],
+    'cf-bottom': [{ d: 'M8 3v9M4.5 8.5L8 12l3.5-3.5' }, { d: 'M3 13.5h10' }],
+    'cf-above': [{ d: 'M2.5 9.5h11', dash: '2 1.5' }, { d: 'M8 8V3M5.5 5.5L8 3l2.5 2.5' }],
+    'cf-below': [{ d: 'M2.5 6.5h11', dash: '2 1.5' }, { d: 'M8 8v5M5.5 10.5L8 13l2.5-2.5' }],
+    /* Data bars: three rows, the bar in each a heavier stroke. */
+    'cf-bar': [{ d: SQUARE }, { d: 'M2.5 6.2h11M2.5 9.8h11' }, { d: 'M4 4.3h7M4 8h3.5M4 11.7h8.5', width: 2 }],
+    /* Colour scale: three rows, dotted more densely down the stack. */
+    'cf-scale': [{ d: SQUARE }, { d: 'M2.5 6.2h11M2.5 9.8h11' }, { d: 'M6 4.3h.01M10 4.3h.01M4.7 8h.01M8 8h.01M11.3 8h.01M4 11.7h.01M6.5 11.7h.01M9.5 11.7h.01M12 11.7h.01', width: 1.6 }],
+    /* Icon set: a circle, a triangle, a diamond, in outline. */
+    'cf-icons': [{ d: 'M4.5 5.6a1.7 1.7 0 1 0 0-.01' }, { d: 'M8 3.6l1.9 3.4H6.1z' }, { d: 'M11.6 3.5l1.9 2.1-1.9 2.1-1.9-2.1z' }, { d: 'M3 12.5h10', width: 1 }],
+    // Merge: a table whose middle cells have become one, arrows meeting.
+    merge: [
+        { d: SQUARE },
+        { d: 'M2.5 6h11M2.5 10h11' },
+        { d: 'M5 8h6M5 8l1.5-1.5M5 8l1.5 1.5M11 8l-1.5-1.5M11 8l-1.5 1.5' },
+    ],
+    // Unmerge: the same table, the middle cell split again, arrows parting.
+    unmerge: [
+        { d: SQUARE },
+        { d: 'M2.5 6h11M2.5 10h11M8 6v4' },
+        { d: 'M3.5 8h2.5M6 8L4.8 6.8M6 8l-1.2 1.2M12.5 8H10M10 8l1.2-1.2M10 8l1.2 1.2' },
+    ],
+    // A cell with a tick and a cross beside it: what passes, what does not.
+    validation: [
+        { d: SQUARE },
+        { d: 'M2.5 6.5h11M8 2.5v11' },
+        { d: 'M3.8 10.3l1.4 1.4 2.2-2.6' },
+        { d: 'M9.6 9.1l2.3 2.3M11.9 9.1l-2.3 2.3' },
+    ],
+};
+/** The names, for tests and for anyone building their own toolbar. */
+export const RIBBON_ICON_NAMES = Object.keys(RIBBON_ICONS);

package/dist/sheet/ribbon.d.ts

@@ -0,0 +1,173 @@
+/**
+ * The ribbon, as data.
+ *
+ * Same shape of decision as SHEET_BINDINGS: a table that can be read in one
+ * screen and tested without mounting anything. `SvSheetRibbon.svelte` is only
+ * a renderer for it.
+ *
+ * Every item that acts on the sheet runs one of the action functions
+ * `shortcuts.ts` exports - the same ones the keymap binds. That is the whole
+ * point of the indirection: Ctrl+B and the Bold button are literally the same
+ * call, so they cannot come to disagree about what "bold the selection" means,
+ * and neither can drift when the format store changes underneath them.
+ *
+ * Items that need chrome the keyboard layer deliberately does not ship (a
+ * function picker, a Goal Seek dialog, Text to Columns options) carry no `run`
+ * and set `emits` instead. The renderer reports those through `onAction` and
+ * the host decides what a dialog looks like, which is the same split
+ * `setFormatDialogHandler` already makes.
+ *
+ * Layout is Excel's, and it is in the data too. A group is a block three
+ * rows high: a LARGE button (icon over label) takes a whole column, SMALL
+ * buttons stack three to a column, and each small item says which row it
+ * sits on. The renderer lays that out on a grid, which is what makes Cut /
+ * Copy / Paste Special line up under each other beside a tall Paste, the
+ * way they do in Excel, without per-group pixel widths.
+ */
+import type { GridCommandContext } from '@svgrid/grid/shortcuts';
+export { FONT_SIZES, applyBorders, type BorderPreset } from './shortcuts.js';
+import type { RibbonIconName } from './ribbon-icons.js';
+/** What the host has to render for one control. */
+export type RibbonItemKind = 
+/** Runs and forgets. */
+'button'
+/** Runs, and paints itself on when `isOn` reports true for the selection. */
+ | 'toggle'
+/** A dropdown showing the selection's current value; `run` receives the pick. */
+ | 'select'
+/**
+ * Excel's split button: the face applies the last value picked (or
+ * `initial`), the arrow opens a menu of `options`. A `palette` menu is
+ * the colour picker; otherwise it is a list, with an icon per entry.
+ */
+ | 'menu'
+/**
+ * Excel's plain menu button (Format, Sort & Filter): the face opens the
+ * list and each entry is an action of its own, raised through `emits`
+ * or run through `run(cmd, value)`. Entries with `heading` are the
+ * section labels Excel prints between the groups.
+ */
+ | 'dropdown';
+export type RibbonOption = {
+    value: string;
+    label: string;
+    /** List menus: the glyph beside the label. */
+    icon?: RibbonIconName;
+    /** Dropdowns: the entry raises this action rather than running the item. */
+    emits?: RibbonActionId;
+    /** Dropdowns: printed after the label, the way Excel prints Ctrl+1. */
+    keys?: string;
+    /** Dropdowns: a section label, not an entry. */
+    heading?: boolean;
+    /** Dropdowns: the entry is a toggle, lit while its action is active. */
+    toggle?: boolean;
+};
+export type RibbonItem = {
+    id: string;
+    /** The button face, or the label under a large button. */
+    label: string;
+    /** Long form for the tooltip and the accessible name. */
+    title: string;
+    /** Drawn on the face. Without one the face prints `label`, which is what
+     *  Bold, Italic and the number-format buttons want: B, I, $, %. */
+    icon?: RibbonIconName;
+    /** Shown after the title in the tooltip, the way Excel does it. */
+    keys?: string;
+    kind: RibbonItemKind;
+    /**
+     * Excel's two button sizes. A large button is an icon over a label and
+     * fills the group's height; a small one is a 24px strip. Large is the
+     * command a group exists for (Paste, Sort & Filter, Text to Columns);
+     * everything else is small.
+     */
+    size?: 'large' | 'small';
+    /** Small buttons only: which of the group's three rows this sits on. */
+    row?: 1 | 2 | 3;
+    /** Small buttons only: print the label beside the icon. */
+    wide?: boolean;
+    /** Run the action. Returns false when it declined (nothing selected, no
+     *  store attached), which the renderer uses to avoid claiming it worked. */
+    run?: (cmd: GridCommandContext, value?: string) => boolean;
+    /** Toggles only. */
+    isOn?: (cmd: GridCommandContext) => boolean;
+    /**
+     * Lit while this action is among the shell's active actions, for an item
+     * that runs rather than emits: Merge & Center's face lights while the
+     * active cell is merged, as Excel's does.
+     */
+    lit?: RibbonActionId;
+    /** Defaults to enabled. Reports false when the action has nothing to act
+     *  on, so the button greys out rather than doing nothing on click. */
+    isEnabled?: (cmd: GridCommandContext) => boolean;
+    /** `select` and `menu` only. */
+    options?: ReadonlyArray<RibbonOption>;
+    /** `select` only: the value the selection currently has, so the control
+     *  reads "Calibri" or "General" for the active cell rather than a blank. */
+    current?: (cmd: GridCommandContext) => string;
+    /** `menu` only: render `options` as Excel's colour grid. */
+    palette?: boolean;
+    /** Palette menus: the "No Fill" / "Automatic" entry at the top. */
+    none?: RibbonOption;
+    /** Menus: the value the face applies before anything has been picked.
+     *  Excel starts Fill Colour on yellow and Font Colour on red. */
+    initial?: string;
+    /** Set instead of `run` when the action needs chrome this layer does not
+     *  own. The renderer calls `onAction(emits, cmd)`. */
+    emits?: RibbonActionId;
+    /**
+     * Dropdowns only: Excel's split button. The face runs the item (Paste
+     * pastes) and the arrow opens the entries, each an action of its own;
+     * an entry without `emits` runs the item with its value.
+     */
+    split?: boolean;
+};
+/** Actions the ribbon delegates to the host rather than running itself. */
+export type RibbonActionId = 'paste-special' | 'format-cells' | 'find-replace' | 'insert-function' | 'name-manager' | 'text-to-columns' | 'remove-duplicates' | 'goal-seek' | 'insert-chart' | 'insert-table' | 'recalculate' | 'toggle-formulas' | 'sort-asc' | 'sort-desc' | 'toggle-filter' | 'freeze-panes' | 'unfreeze-panes' | 'hide-rows' | 'hide-columns' | 'unhide-rows' | 'unhide-columns' | 'row-height' | 'column-width' | 'autofit-rows' | 'autofit-columns' | 'paste-values' | 'paste-formulas' | 'paste-formats' | 'paste-transpose' | 'format-painter' | 'protect-sheet' | 'unprotect-sheet' | 'toggle-lock' | 'new-comment' | 'edit-comment' | 'delete-comment' | 'prev-comment' | 'next-comment' | 'toggle-comments' | 'data-validation' | 'open-list' | 'freeze-top-row' | 'freeze-first-column' | 'toggle-gridlines' | 'toggle-formula-bar' | 'toggle-headings' | 'toggle-ribbon' | 'cf-greater' | 'cf-less' | 'cf-between' | 'cf-equal' | 'cf-text' | 'cf-duplicates' | 'cf-top10' | 'cf-bottom10' | 'cf-above-average' | 'cf-below-average' | 'cf-data-bar' | 'cf-color-scale-3' | 'cf-color-scale-2' | 'cf-icon-set' | 'cf-clear-selection' | 'cf-clear-sheet' | 'cf-manage' | 'merge-center' | 'merge-across' | 'merge-cells' | 'unmerge-cells';
+export type RibbonGroup = {
+    id: string;
+    /** Printed under the group, which is what makes a ribbon a ribbon. */
+    label: string;
+    /** What the group's one button shows once the band has folded it. */
+    icon?: RibbonIconName;
+    /**
+     * How the small items are arranged.
+     *
+     * `grid` (the default) is Excel's column model: items on the same row
+     * line up in columns, so a stack of Cut / Copy / Paste Special is one
+     * neat column and AutoSum / Fill / Clear another. `flow` lets each row
+     * run freely, which is what the Font group needs: a wide font box next
+     * to a size box on row one, and a run of narrow B I U buttons under it,
+     * with nothing forcing the two rows into shared columns.
+     */
+    layout?: 'grid' | 'flow';
+    /** Excel's dialog box launcher: the small arrow in the group's corner
+     *  that opens the full dialog for what the group does. */
+    launcher?: RibbonActionId;
+    items: ReadonlyArray<RibbonItem>;
+};
+export type RibbonTab = {
+    id: string;
+    label: string;
+    groups: ReadonlyArray<RibbonGroup>;
+};
+/**
+ * Move the decimal count of a number-format pattern by `delta`.
+ *
+ * Exported because it is the fiddly part and deserves its own tests: the
+ * pattern can have a prefix and a suffix (`$#,##0.00`, `0.0%`), can have no
+ * decimal section at all, and must not go below zero or run away past the 30
+ * places Excel allows.
+ */
+export declare function withDecimals(pattern: string, delta: number): string | null;
+/**
+ * The fonts a spreadsheet user reaches for, with the stacks that make each
+ * render on a machine that lacks it. The empty value is the theme's own
+ * font, which is what "Default" means here and what a fresh cell has.
+ */
+export declare const FONT_FAMILIES: ReadonlyArray<{
+    value: string;
+    label: string;
+}>;
+export declare const RIBBON_TABS: ReadonlyArray<RibbonTab>;
+/** Every item across every tab, for tests and for a command palette. */
+export declare function ribbonItems(): ReadonlyArray<RibbonItem>;