@ichicraft/widgets-widget-base 1.16.4 → 1.16.5

package/README.md

@@ -9,6 +9,11 @@ All notable changes to this project will be documented here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.16.5 - 2026-06-01
+
+-   Added `BuddyRenderOptions` interface, passed by the host to `BaseWidget.renderBuddy` to describe the slot the widget is about to render into.
+-   Added optional `options` parameter to `BaseWidget.renderBuddy`, of type `BuddyRenderOptions`. Contains an `allowRichRendering` boolean that signals whether the slot has room for richer rendering than the standard buddy icon button — letting the widget decide synchronously between custom and default rendering.
+
 ## 1.16.4 - 2026-05-27
 
 -   Added `header` property to `WidgetDesignContext` interface, exposing the header's `textColor`, `iconColor`, `activeTextColor` and `activeIconColor` from the user's theme.

package/lib/BaseWidget.d.ts

@@ -1,13 +1,18 @@
-import { ExportData, ValidationResult, WidgetContext } from './types';
+import { BuddyRenderOptions, ExportData, ValidationResult, WidgetContext } from './types';
 export default abstract class BaseWidget {
     protected readonly context: WidgetContext;
     constructor(context: WidgetContext);
     abstract init(): Promise<void>;
     abstract render(domElement: HTMLDivElement): void;
     /** Render function for the widget buddy component.
+     *  @param domElement The DOM element to render into.
+     *  @param options Slot information from the host (e.g. whether the slot has
+     *      room for richer rendering than the standard buddy button). The
+     *      argument is optional for backwards compatibility — older hosts may
+     *      call `renderBuddy` without it.
      *  @returns Whether or not the buddy is using custom rendering.
      */
-    renderBuddy?(domElement: HTMLDivElement): boolean;
+    renderBuddy?(domElement: HTMLDivElement, options?: BuddyRenderOptions): boolean;
     verifyPersistedUserConfiguration?(config: string): Promise<boolean>;
     renderUserConfigurationForm?(domElement: HTMLDivElement): void;
     validateUserConfigurationForm?(): ValidationResult;

package/lib/types/index.d.ts

@@ -409,6 +409,20 @@ export interface WidgetBuddyContext {
      */
     registerOnBuddyClick: (onClick: () => void) => void;
 }
+/**
+ * Options passed by the host to `BaseWidget.renderBuddy` describing the slot
+ * the widget is about to render into. Lets the widget decide synchronously
+ * how rich its buddy rendering can afford to be.
+ */
+export interface BuddyRenderOptions {
+    /**
+     * Whether the buddy slot has enough room for a richer rendering than the
+     * standard buddy icon button. When `false`, the widget should either fall
+     * back on the host's default buddy button (by returning `false` from
+     * `renderBuddy`) or render a minimal icon that fits the standard slot.
+     */
+    allowRichRendering: boolean;
+}
 /**
  * Widget variant context providing metadata and functionality offered by the widget board. A widget variant is
  * a widget that's been installed by an administrator from within the board administration.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.16.4",
+    "version": "1.16.5",
     "description": "Part of the Widget Development Kit for building widgets for Bloom Intranet",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",