@sisense/sdk-ui 2.31.1 → 2.32.0

package/dist/packages/sdk-ui/src/domains/widgets/components/filter-widget/types.d.ts

@@ -3,7 +3,7 @@ import type { FilterWidgetChangeEvent } from '../../../../domains/widgets/change
 import type { WidgetContainerStyleOptions } from '../../../../types';
 import type { WidgetConfig } from '../widget/types';
 /**
- * Rendering type for the FilterWidget.
+ * `FilterWidgetFilterType` selects the rendering type for a filter widget.
  *
  * - `'members'`      — searchable member-select dropdown. Implemented.
  * - `'dateRange'`    — date-range picker. Planned.
@@ -12,8 +12,9 @@ import type { WidgetConfig } from '../widget/types';
  * - `'condition'`    — conditional / formula filter builder. Planned.
  *
  * @example
- * ```tsx
- * <FilterWidget attribute={DM.Commerce.Country} filterType="members" />
+ * The following selects the member-select dropdown rendering:
+ * ```ts
+ * const filterType: FilterWidgetFilterType = 'members';
  * ```
  *
  * @beta
@@ -33,26 +34,9 @@ export type FilterWidgetFilterType = 'members' | 'dateRange' | 'period' | 'numer
  */
 export declare const filterWidgetFilterTypeLabels: Record<FilterWidgetFilterType, string>;
 /**
- * Props for the FilterWidget component.
- *
- * @example
- * ```tsx
- * const [filter, setFilter] = useState<Filter | null>(null);
- *
- * return (
- *   <FilterWidget
- *     attribute={DM.Commerce.Country}
- *     title="Country"
- *     isMultiselect={true}
- *     filter={filter}
- *     onChange={(event) => {
- *       if (event.type === 'filter/changed') {
- *         setFilter(event.payload.filter);
- *       }
- *     }}
- *   />
- * );
- * ```
+ * `FilterWidgetProps` configures a filter widget — a compact, dashboard-embeddable
+ * control that lets users filter a dashboard by selecting values for a single
+ * dimension, without opening the full filter panel.
  *
  * @beta
  */
@@ -151,4 +135,14 @@ export interface FilterWidgetProps {
      * @internal
      */
     containerless?: boolean;
+    /**
+     * Calls the provided callback each time the widget finishes rendering with
+     * fetched data — on initial load and again whenever it re-enters a ready
+     * state after a reload (e.g. dimension change, refetch). Use this to signal
+     * to a host application that the widget content is committed to the DOM.
+     *
+     * @category Widget
+     * @internal
+     */
+    onReady?: () => void;
 }

package/dist/packages/sdk-ui/src/domains/widgets/components/pivot-table-widget/types.d.ts

@@ -72,10 +72,9 @@ export interface PivotTableWidgetProps {
     /**
      * Widget identifier
      *
-     * The optional property which is only meaningful for some internal features (for example Excel export).
+     * Used to identify the widget when exporting its data (for example, the "Download as Excel" action).
      *
      * @category Widget
-     * @internal
      */
     id?: string;
     /**

package/dist/packages/sdk-ui/src/domains/widgets/components/widget/types.d.ts

@@ -46,15 +46,29 @@ export type WidgetConfig = {
             enabled?: boolean;
         };
         /**
-         * Configuration for downloading an Excel file.
+         * Configuration for the "Download as Excel" action, which adds an item to the
+         * widget's header menu that exports the widget's underlying data as an Excel (XLSX) file.
          *
-         * @sisenseInternal
+         * @example
+         * Enable Excel download for a widget:
+         * ```ts
+         * const widgetConfig: WidgetConfig = {
+         *   actions: {
+         *     downloadExcel: {
+         *       enabled: true,
+         *     },
+         *   },
+         * };
+         * ```
          */
         downloadExcel?: {
             /**
-             * Determines whether the possibility to download Excel is enabled.
+             * Whether the "Download as Excel" action is enabled for the widget.
              *
-             * If not specified, the default value is `false`.
+             * Note: the widget's `id` is required for Excel export to work, as it is
+             * used to build the export request. Without it, the export fails.
+             *
+             * @default false
              */
             enabled?: boolean;
         };