apex-grid 3.0.1 → 3.2.0

package/custom-elements.json

@@ -806,6 +806,37 @@
               "default": "0",
               "description": "1-based column index used to populate `aria-colindex`. Accounts for the\nauto-rendered selection + expansion columns ahead of the data columns."
             },
+            {
+              "kind": "field",
+              "name": "decorationVersion",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "0",
+              "description": "Reactive token forwarded from StateController.decorationVersion.\nChanging it re-runs willUpdate so module-driven cell decoration is\nre-evaluated when it changes (e.g. while dragging a selection range). Stays\n`0` for the community grid, so cells are never re-decorated there."
+            },
+            {
+              "kind": "field",
+              "name": "#decoratedKeys",
+              "privacy": "private",
+              "type": {
+                "text": "string[]"
+              },
+              "default": "[]",
+              "description": "Decoration attribute keys applied on the previous update, for cleanup."
+            },
+            {
+              "kind": "method",
+              "name": "#applyDecoration",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Reflects module-contributed decoration attributes (see CellDecorator)\nonto the cell host, reconciling against the previous update so attributes\nthat are no longer present are removed. Inert for the community grid:\n`state.decorateCell` returns `null` with no modules, so nothing is set."
+            },
             {
               "kind": "field",
               "name": "#handleClick",
@@ -1319,6 +1350,10 @@
               "description": "Grid edge/shadow override. Default is a flat 1px hairline edge; set to `var(--ag-shadow-card)` for the elevated card look, or `none` to remove it.",
               "name": "--ag-grid-shadow"
             },
+            {
+              "description": "Host card background. Defaults to a subtle light gradient; override with a flat color (or use `theme=\"dark\"`) for dark themes.",
+              "name": "--ag-grid-bg"
+            },
             {
               "description": "Grid card background (must be opaque).",
               "name": "--ag-surface"
@@ -2492,6 +2527,20 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "bodyPointerHandler",
+              "privacy": "protected",
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "PointerEvent"
+                  }
+                }
+              ],
+              "description": "Forwards body-cell pointer interactions (press / drag-over / release) to\nfeature modules via StateController.handleCellInteraction. Gated on\nthere being at least one registered module so the community grid does no\nper-event work (it registers none). The seam a range-selection feature\nbuilds on."
+            },
             {
               "kind": "method",
               "name": "renderHeaderRow",
@@ -2791,6 +2840,13 @@
               "description": "Enables drag-and-drop column reordering on the column headers.",
               "fieldName": "columnReordering",
               "attribute": "column-reordering"
+            },
+            {
+              "type": {
+                "text": "string"
+              },
+              "description": "Space-separated theme flags. `dark` opts into the built-in dark palette; `tinted` mixes `--ag-brand` into the chrome surfaces. Combine as `theme=\"dark tinted\"`.",
+              "name": "theme"
             }
           ],
           "superclass": {
@@ -3029,7 +3085,7 @@
                 {
                   "name": "e",
                   "type": {
-                    "text": "Event"
+                    "text": "MouseEvent"
                   }
                 }
               ]
@@ -3423,6 +3479,26 @@
               "default": "null",
               "description": "The column key currently being edited in this row, or `null`."
             },
+            {
+              "kind": "field",
+              "name": "decorationVersion",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "0",
+              "description": "Reactive token from StateController.decorationVersion, forwarded to\neach cell so a decoration-only change re-renders the row's cells. Stays `0`\nfor the community grid."
+            },
+            {
+              "kind": "field",
+              "name": "#presented",
+              "privacy": "private",
+              "type": {
+                "text": "PresentedRow | null"
+              },
+              "default": "null",
+              "description": "Result of the feature-module row presenter for the current update, or\n`null` when no module renders this row full-width (the normal case).\nComputed in willUpdate and consumed in render."
+            },
             {
               "kind": "field",
               "name": "ariaRowOffset",
@@ -6157,6 +6233,10 @@
                   "type": {
                     "text": "ColumnConfiguration<T>"
                   }
+                },
+                {
+                  "name": "additive",
+                  "default": "false"
                 }
               ]
             },
@@ -6477,6 +6557,118 @@
               ],
               "description": "Look up a feature controller contributed by a GridFeatureModule,\nby its module id. Returns `undefined` when no such module is registered."
             },
+            {
+              "kind": "method",
+              "name": "applyModuleTransforms",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "T[]"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "rows",
+                  "type": {
+                    "text": "T[]"
+                  }
+                }
+              ],
+              "description": "Runs the post-pipeline row transforms contributed by feature modules\nimplementing RowTransformer, in registration order. Returns the\ninput unchanged when no such module is registered — the community grid path\nis a no-op pass-through."
+            },
+            {
+              "kind": "method",
+              "name": "presentRow",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "PresentedRow | null"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "T"
+                  }
+                },
+                {
+                  "name": "ctx",
+                  "type": {
+                    "text": "RowPresenterContext<T>"
+                  }
+                }
+              ],
+              "description": "Asks feature modules implementing RowPresenter whether they render\nthe given row as full-width custom content (e.g. a group header). Returns\nthe first non-null result, or `null` when no module owns the row."
+            },
+            {
+              "kind": "field",
+              "name": "#decorationVersion",
+              "privacy": "private",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Monotonic token bumped by bumpDecoration whenever module-driven cell\ndecoration changes. Forwarded down to each cell as a reactive property so a\ndecoration-only change (e.g. dragging a selection range) re-renders cells\nwithout re-running the data pipeline. Always `0` for the community grid."
+            },
+            {
+              "kind": "field",
+              "name": "decorationVersion",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "bumpDecoration",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Signals that CellDecorator output may have changed. Bumps the\ndecorationVersion and requests a host update so cells re-run their\ndecoration. Called by feature modules after mutating decoration state."
+            },
+            {
+              "kind": "method",
+              "name": "decorateCell",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "CellDecoration | null"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "ctx",
+                  "type": {
+                    "text": "CellDecoratorContext<T>"
+                  }
+                }
+              ],
+              "description": "Collects per-cell decoration contributed by feature modules implementing\nCellDecorator, merging their attribute maps (later modules win on a\nkey clash). Returns `null` when no module decorates the cell — the community\ngrid path, where each cell applies nothing."
+            },
+            {
+              "kind": "method",
+              "name": "handleCellInteraction",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "interaction",
+                  "type": {
+                    "text": "CellInteraction<T>"
+                  }
+                }
+              ],
+              "description": "Forwards a body-cell pointer interaction to every feature module that\nimplements CellInteractionHandler. No-op for the community grid\n(no modules); the grid only calls this when modules are registered."
+            },
             {
               "kind": "method",
               "name": "hostConnected",
@@ -7458,8 +7650,114 @@
     {
       "kind": "javascript-module",
       "path": "src/internal/feature-module.ts",
-      "declarations": [],
-      "exports": []
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "isRowTransformer",
+          "return": {
+            "type": {
+              "text": "controller is RowTransformer<T>"
+            }
+          },
+          "parameters": [
+            {
+              "name": "controller",
+              "type": {
+                "text": "unknown"
+              }
+            }
+          ],
+          "description": "Runtime type-guard for RowTransformer."
+        },
+        {
+          "kind": "function",
+          "name": "isRowPresenter",
+          "return": {
+            "type": {
+              "text": "controller is RowPresenter<T>"
+            }
+          },
+          "parameters": [
+            {
+              "name": "controller",
+              "type": {
+                "text": "unknown"
+              }
+            }
+          ],
+          "description": "Runtime type-guard for RowPresenter."
+        },
+        {
+          "kind": "function",
+          "name": "isCellDecorator",
+          "return": {
+            "type": {
+              "text": "controller is CellDecorator<T>"
+            }
+          },
+          "parameters": [
+            {
+              "name": "controller",
+              "type": {
+                "text": "unknown"
+              }
+            }
+          ],
+          "description": "Runtime type-guard for CellDecorator."
+        },
+        {
+          "kind": "function",
+          "name": "isCellInteractionHandler",
+          "return": {
+            "type": {
+              "text": "controller is CellInteractionHandler<T>"
+            }
+          },
+          "parameters": [
+            {
+              "name": "controller",
+              "type": {
+                "text": "unknown"
+              }
+            }
+          ],
+          "description": "Runtime type-guard for CellInteractionHandler."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "isRowTransformer",
+          "declaration": {
+            "name": "isRowTransformer",
+            "module": "src/internal/feature-module.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isRowPresenter",
+          "declaration": {
+            "name": "isRowPresenter",
+            "module": "src/internal/feature-module.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isCellDecorator",
+          "declaration": {
+            "name": "isCellDecorator",
+            "module": "src/internal/feature-module.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isCellInteractionHandler",
+          "declaration": {
+            "name": "isCellInteractionHandler",
+            "module": "src/internal/feature-module.ts"
+          }
+        }
+      ]
     },
     {
       "kind": "javascript-module",
@@ -7743,6 +8041,54 @@
             "module": "./export.js"
           }
         },
+        {
+          "kind": "js",
+          "name": "CellDecoration",
+          "declaration": {
+            "name": "CellDecoration",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "CellDecorator",
+          "declaration": {
+            "name": "CellDecorator",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "CellDecoratorContext",
+          "declaration": {
+            "name": "CellDecoratorContext",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "CellInteraction",
+          "declaration": {
+            "name": "CellInteraction",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "CellInteractionHandler",
+          "declaration": {
+            "name": "CellInteractionHandler",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "CellInteractionKind",
+          "declaration": {
+            "name": "CellInteractionKind",
+            "module": "./feature-module.js"
+          }
+        },
         {
           "kind": "js",
           "name": "GridFeatureModule",
@@ -7751,6 +8097,70 @@
             "module": "./feature-module.js"
           }
         },
+        {
+          "kind": "js",
+          "name": "PresentedRow",
+          "declaration": {
+            "name": "PresentedRow",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "RowPresenter",
+          "declaration": {
+            "name": "RowPresenter",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "RowPresenterContext",
+          "declaration": {
+            "name": "RowPresenterContext",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "RowTransformer",
+          "declaration": {
+            "name": "RowTransformer",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isCellDecorator",
+          "declaration": {
+            "name": "isCellDecorator",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isCellInteractionHandler",
+          "declaration": {
+            "name": "isCellInteractionHandler",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isRowPresenter",
+          "declaration": {
+            "name": "isRowPresenter",
+            "module": "./feature-module.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isRowTransformer",
+          "declaration": {
+            "name": "isRowTransformer",
+            "module": "./feature-module.js"
+          }
+        },
         {
           "kind": "js",
           "name": "registerComponent",
@@ -7767,6 +8177,14 @@
             "module": "./types.js"
           }
         },
+        {
+          "kind": "js",
+          "name": "ColumnConfiguration",
+          "declaration": {
+            "name": "ColumnConfiguration",
+            "module": "./types.js"
+          }
+        },
         {
           "kind": "js",
           "name": "GridHost",
@@ -7774,6 +8192,22 @@
             "name": "GridHost",
             "module": "./types.js"
           }
+        },
+        {
+          "kind": "js",
+          "name": "Keys",
+          "declaration": {
+            "name": "Keys",
+            "module": "./types.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "getDisplayColumns",
+          "declaration": {
+            "name": "getDisplayColumns",
+            "module": "./utils.js"
+          }
         }
       ]
     },

package/docs/assets/hierarchy.js

@@ -1 +1 @@
-window.hierarchyData = "eJyVkctqwzAQRf9l1kqbWPID7VLjdQOBboIXwprYoopkpGkxBP97cQvFDaaJN7Oaq3Pm6grBe4ogT4LvmNhyluZFzSDg2WJDxrsI8gpZPk2nLggS9j0OB9Vi2SnXoq4+0REweDdOg0zSjMFHsCDBOMJwVg3G56XIU0cXCwwaq2IECRT1Znpj85uDkQEvxAxdHt+qofeBXvsft/+xt+uPIcWWz5BreGthDJrOWB3QgTzxQtQTne9m9BcVcSqvRGtL7wiHe1UvJNaaCJF8m4hkwaTShnxY5/In89gnpHkxgx9Ua5yaaj2SIryDvdlee36W1+M4fgGn4Ark"
+window.hierarchyData = "eJyVkbFqwzAQht/lZqVNakk22lrjuYFAl+BBWBdbVJGMdC2G4HcvbqG4wTTxctP9+r77dYEYAiVQR55xxreSiWJXM4h4ctiQDT6BuoDMp+n1GUHBc4/DXrdYdtq3aKpP9AQM3q03oJ6EZPARHSiwnjCedIPpcSny0NHZAYPG6ZRAASWzmd7Y/OZgZJAVc3R5eKuGPkR67X/c/sder9+H5Fs5Q67hrYUxaDrrTEQP6pgVeT3RMz6jv+iEU3klOlcGTzjcqnohsdaEc/FtwsWCSWUshbjO5U/mvk8QxW4G3+vWej3VeiBNeAN7tb32fJnX4zh+AcGzCvA="