@toolbox-web/grid 2.6.0 → 2.7.1

package/lib/core/internal/aria.d.ts

@@ -10,8 +10,12 @@ export interface AriaState {
     colCount: number;
     /** Last set aria-label */
     ariaLabel: string | undefined;
+    /** Last set aria-labelledby */
+    ariaLabelledBy: string | undefined;
     /** Last set aria-describedby */
     ariaDescribedBy: string | undefined;
+    /** Last set aria-roledescription */
+    ariaRoleDescription: string | undefined;
     /** Last source row count announced via `dataLoaded`; used to suppress duplicate announcements */
     lastAnnouncedSourceCount: number;
 }

package/lib/core/types.d.ts

@@ -2493,12 +2493,36 @@ export interface GridConfig<TRow = any> {
      *
      * If not provided and `shell.header.title` is set, the title is used automatically.
      *
+     * If [`gridAriaLabelledBy`](#gridarialabelledby) is also set, `aria-labelledby`
+     * takes precedence per WAI-ARIA accessible-name computation and `aria-label`
+     * is omitted.
+     *
      * @example
      * ```ts
      * gridConfig = { gridAriaLabel: 'Employee data' };
      * ```
      */
     gridAriaLabel?: string;
+    /**
+     * ID of an element that labels the grid.
+     * Sets `aria-labelledby` on the grid's internal table element so screen
+     * readers can use the referenced element's text as the accessible name —
+     * useful when the grid already sits next to a heading.
+     *
+     * Per WAI-ARIA accessible-name precedence, `aria-labelledby` takes priority
+     * over `aria-label` and over the auto-derived shell title. When this option
+     * is set, the grid omits `aria-label` to avoid conflicting names.
+     *
+     * @example
+     * ```html
+     * <h2 id="grid-heading">Employees</h2>
+     * <tbw-grid></tbw-grid>
+     * ```
+     * ```ts
+     * gridConfig = { gridAriaLabelledBy: 'grid-heading' };
+     * ```
+     */
+    gridAriaLabelledBy?: string;
     /**
      * ID of an element that describes the grid.
      * Sets `aria-describedby` on the grid's internal table element.
@@ -2513,6 +2537,25 @@ export interface GridConfig<TRow = any> {
      * ```
      */
     gridAriaDescribedBy?: string;
+    /**
+     * Override the screen-reader-announced role name for the grid via
+     * `aria-roledescription`. Useful for localization (e.g. `"Tabell"` in
+     * Norwegian) or domain-specific naming (e.g. `"Employee table"`).
+     *
+     * :::caution
+     * Per [WAI-ARIA 1.2](https://www.w3.org/TR/wai-aria-1.2/#aria-roledescription),
+     * the value should still describe a grid-like widget. Overriding with an
+     * unrelated label confuses assistive-technology users about the available
+     * interactions (cell navigation, sort, etc.). Leave unset to use the
+     * default role name announced by the AT.
+     * :::
+     *
+     * @example
+     * ```ts
+     * gridConfig = { gridAriaRoleDescription: 'Employee table' };
+     * ```
+     */
+    gridAriaRoleDescription?: string;
     /**
      * Accessibility configuration for screen reader announcements.
      *

package/lib/features/sticky-rows.d.ts

@@ -0,0 +1,9 @@
+import { StickyRowsConfig } from '../plugins/sticky-rows';
+declare module '../core/types' {
+    interface FeatureConfig {
+        /** Pin selected data rows below the header as the user scrolls past them. */
+        stickyRows?: StickyRowsConfig;
+    }
+}
+/** @internal Type anchor — forces bundlers to preserve this module's FeatureConfig augmentation when re-exported. */
+export type _Augmentation = true;

package/lib/features/sticky-rows.js

@@ -0,0 +1,2 @@
+import{StickyRowsPlugin as o}from"@toolbox-web/grid/plugins/sticky-rows";import{registerFeature as i}from"@toolbox-web/grid/features/registry";i("stickyRows",i=>new o(i??{isSticky:()=>!1}));
+//# sourceMappingURL=sticky-rows.js.map

package/lib/features/sticky-rows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sticky-rows.js","sources":["../../../../../libs/grid/src/lib/features/sticky-rows.ts"],"sourcesContent":["/**\n * Sticky Rows feature for @toolbox-web/grid\n *\n * @example\n * ```typescript\n * import '@toolbox-web/grid/features/sticky-rows';\n *\n * grid.gridConfig = { features: { stickyRows: { isSticky: 'isSection' } } };\n * ```\n */\n\nimport { StickyRowsPlugin, type StickyRowsConfig } from '../plugins/sticky-rows';\nimport { registerFeature } from './registry';\n\ndeclare module '../core/types' {\n  interface FeatureConfig {\n    /** Pin selected data rows below the header as the user scrolls past them. */\n    stickyRows?: StickyRowsConfig;\n  }\n}\n\nregisterFeature('stickyRows', (config) => {\n  // `stickyRows` requires an `isSticky` value — `boolean` shorthand is not\n  // meaningful. The TS type prevents `true`/`false` callers from compiling;\n  // at runtime we coerce to a no-op predicate for safety.\n  const options = (config as StickyRowsConfig | undefined) ?? { isSticky: () => false };\n  return new StickyRowsPlugin(options);\n});\n\n/** @internal Type anchor — forces bundlers to preserve this module's FeatureConfig augmentation when re-exported. */\nexport type _Augmentation = true;\n"],"names":["registerFeature","config","StickyRowsPlugin","isSticky"],"mappings":"+IAqBAA,EAAgB,aAAeC,GAKtB,IAAIC,EADMD,GAA2C,CAAEE,SAAU,KAAM"}