@turquoisehealth/pit-viper 2.214.0 → 2.216.0

package/pv-components/dist/vue/base/components/base/PvFilterPanel/types.d.ts

@@ -25,6 +25,8 @@ export interface PvFilterPanelOption {
     /** Explicit raw filter value. Prefer this over metadata.rawValue or scoped value parsing for new consumers. */
     rawValue?: PvFilterPanelOptionRawValue;
     resultCount?: PvFilterPanelResultCount | null;
+    /** Optional section label used to group options under a heading in section-aware UIs (e.g. PvFilterModal). */
+    section?: string;
     subduedText?: string;
     subText?: string;
     totalChildCount?: number;
@@ -34,6 +36,22 @@ export interface PvFilterPanelFilterGroup {
     fields: string[];
     label: string;
 }
+/**
+ * Describes a section heading in section-aware UIs (e.g. PvFilterModal). Options are grouped by their
+ * `section` value; the matching def is forwarded to the section header renderer so it can decide how
+ * to display the heading. Configured per column via `colDef.context.filterSectionDefs`.
+ *
+ * Only `key`/`label` are typed; put anything else the renderer needs (icon, tooltip, counter, badge…)
+ * on `metadata` so new display needs don't require changing this type.
+ */
+export interface PvFilterPanelSectionDef {
+    /** Section key matching an option's `section` value. */
+    key: string;
+    /** Display label for the section heading. Defaults to `key`. */
+    label?: string;
+    /** Arbitrary display data forwarded to the section header renderer (e.g. icon, tooltip, count). */
+    metadata?: Record<string, unknown>;
+}
 export interface PvFilterPanelAggregateFieldHierarchy {
     /** Field represented by this hierarchy node. Parent/child relationships are determined by nesting. */
     field: string;
@@ -97,6 +115,18 @@ export interface PvFilterPanelColDefContext {
      * Optional renderer to override the default filter options list
      */
     filterOptionsRenderer?: Component;
+    /**
+     * Section heading defs for section-aware UIs (e.g. PvFilterModal), keyed by section value. Supplies
+     * the label and any extra display data (via `metadata`) forwarded to `filterSectionHeaderRenderer`.
+     * Also determines section order; sections present in the options but absent here render last.
+     */
+    filterSectionDefs?: PvFilterPanelSectionDef[];
+    /**
+     * Optional renderer for section headings in section-aware UIs (e.g. PvFilterModal). Receives
+     * `{ colDef, field, section, options }` and replaces the default section label text, allowing
+     * hover tooltips, counters, or custom markup. Sections come from each option's `section` field.
+     */
+    filterSectionHeaderRenderer?: Component;
     /**
      * An optional description to show in the tooltip explaining how the dropdown values are sorted
      */
@@ -337,6 +367,8 @@ export interface PvFilterPanelResolvedFilter {
     filterGroupOptions?: PvFilterPanelGroupOption[];
     filterHeaderRenderer?: Component;
     filterOptionsRenderer?: Component;
+    filterSectionDefs?: PvFilterPanelSectionDef[];
+    filterSectionHeaderRenderer?: Component;
     filterOptionsSortDescription?: string;
     filterOptionsSortTooltip?: string;
     hideOptionsSortDescription?: boolean;