@mintplayer/ng-spark 22.8.0 → 22.10.0

package/types/mintplayer-ng-spark-attribute-description.d.ts

@@ -0,0 +1,30 @@
+import * as _angular_core from '@angular/core';
+import { TranslatedString } from '@mintplayer/ng-spark/models';
+
+type SparkAttributeDescriptionPosition = 'top' | 'bottom' | 'start' | 'end';
+/**
+ * The [i] beside an attribute label: a focusable button whose tooltip shows the attribute's
+ * `description` (#348). Renders nothing when the model declares no description, so every label
+ * site can include it unconditionally.
+ *
+ * Accessibility comes from `*bsTooltip`: it opens on hover AND focus, closes on Escape, and sets
+ * `aria-describedby` on the button while open. The button's own name is the description text, so
+ * a screen reader announces the help on focus without waiting for the tooltip.
+ *
+ * Clicks are stopped: the [i] lives inside sortable grid headers and `<label for>` elements, and
+ * must neither toggle the sort nor move focus into the input.
+ */
+declare class SparkAttributeDescriptionComponent {
+    /** The attribute's `description`; `undefined` (the common case) renders nothing. */
+    description: _angular_core.InputSignal<TranslatedString | undefined>;
+    /** Where the tooltip opens relative to the [i]. */
+    position: _angular_core.InputSignal<SparkAttributeDescriptionPosition>;
+    /** Resolved for the current language; re-evaluates when the user switches language. */
+    text: _angular_core.Signal<string>;
+    onClick(event: MouseEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkAttributeDescriptionComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkAttributeDescriptionComponent, "spark-attribute-description", never, { "description": { "alias": "description"; "required": false; "isSignal": true; }; "position": { "alias": "position"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+export { SparkAttributeDescriptionComponent };
+export type { SparkAttributeDescriptionPosition };

package/types/mintplayer-ng-spark-models.d.ts

@@ -123,6 +123,8 @@ interface EntityAttributeDefinition {
     id: string;
     name: string;
     label?: TranslatedString;
+    /** Help text rendered as an [i] tooltip beside the label. Absent when the model declares none. */
+    description?: TranslatedString;
     dataType: string;
     isRequired: boolean;
     isVisible: boolean;
@@ -265,6 +267,8 @@ interface QueryResult {
 interface SparkCellColumn {
     name: string;
     label?: TranslatedString;
+    /** Help text rendered as an [i] tooltip in the column header. Absent when the model declares none. */
+    description?: TranslatedString;
     dataType: string;
     isArray?: boolean;
     renderer?: string;

package/types/mintplayer-ng-spark-renderers.d.ts

@@ -17,10 +17,12 @@ declare function rendererValue(attr: PersistentObjectAttribute | undefined): any
 /**
  * The renderer-facing value of a query-result cell.
  *
- * A grid row carries no nested objects to fall back to — a projection is flat by construction —
- * so this is deliberately not the same function as {@link rendererValue}. Keeping them separate
- * is what stops a renderer silently receiving `undefined` because it was written against the
- * attribute shape.
+ * A cell is a single channel: whatever a renderer needs is already on `value` — for a single-child
+ * AsDetail column that is the nested PersistentObject itself, put there by the server so this
+ * matches what {@link rendererValue} falls through to on a detail page. There is nothing to fall
+ * back to, which is why this is deliberately not the same function: keeping them separate is what
+ * stops a renderer silently receiving `undefined` because it was written against the attribute
+ * shape's `object` / `objects` fields, which a row does not carry.
  */
 declare function cellValue(value: QueryResultItemValue | undefined): any;