@pie-players/pie-section-player 1.0.0-beta.1 → 1.0.0-beta.2

package/dist/components/shared/card-title.d.ts

@@ -0,0 +1,18 @@
+import { SectionPlayerCardTitleContext, SectionPlayerCardTitleFormatter } from '../../contracts/card-title-formatters.js';
+export type ResolvedCardTitle = {
+    text: string;
+    visible: boolean;
+};
+/**
+ * The title a card renders for a host's `hooks.cardTitleFormatter` return.
+ *
+ * Hiding takes an explicit `{ visible: false }`, the shape a tool context
+ * resolver hides a tool with, because `null`, `undefined` and an empty string
+ * already mean "keep the default": a host computing its title from data it may
+ * lack returns one of them, and that host must keep getting "Question N".
+ *
+ * A hidden title keeps its text. The heading stays in the outline, visually
+ * hidden: it is the card's name for assistive technology, and item content
+ * nests its own headings one level below it.
+ */
+export declare function resolveCardTitle(formatter: SectionPlayerCardTitleFormatter | null | undefined, context: SectionPlayerCardTitleContext): ResolvedCardTitle;

package/dist/contracts/card-title-formatters.d.ts

@@ -13,4 +13,11 @@ export type SectionPlayerPassageTitleContext = {
     defaultTitle: string;
 };
 export type SectionPlayerCardTitleContext = SectionPlayerItemTitleContext | SectionPlayerPassageTitleContext;
-export type SectionPlayerCardTitleFormatter = (context: SectionPlayerCardTitleContext) => string | null | undefined;
+/**
+ * A non-empty string becomes the card's title. `{ visible: false }` hides it
+ * visually; the heading stays, carrying `defaultTitle`. Anything else, a throw
+ * included, keeps `defaultTitle`.
+ */
+export type SectionPlayerCardTitleFormatter = (context: SectionPlayerCardTitleContext) => string | {
+    visible: false;
+} | null | undefined;