@iqworksai/common-components 0.1.21 → 0.1.22

package/dist/components/Favicons/index.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Products that have favicon icons available.
+ * Add new product keys here as icon assets are added.
+ */
+export type FaviconProductKey = 'iqworks';
+export type FaviconFormat = 'svg' | 'png';
+export type FaviconTheme = 'dark' | 'light';
+export interface FaviconData {
+    /** Data URL for use in <link rel="icon"> href */
+    dataUrl: string;
+    /** Direct URL to the asset file */
+    url: string;
+    /** Raw SVG string (only for SVG format) */
+    raw?: string;
+    /** The format of the favicon */
+    format: FaviconFormat;
+    /** The theme variant */
+    theme: FaviconTheme;
+}
+export interface GetFaviconOptions {
+    /** Favicon format: 'svg' (default) or 'png' */
+    format?: FaviconFormat;
+    /** Theme variant: 'dark' (default) or 'light' */
+    theme?: FaviconTheme;
+}
+/**
+ * Get favicon data for a product.
+ *
+ * @param product - The product key (e.g., 'iqworks')
+ * @param options - Optional format and theme settings
+ * @returns FaviconData object with dataUrl, url, and raw SVG (if applicable)
+ *
+ * @example
+ * ```tsx
+ * // Get SVG favicon (default)
+ * const favicon = getFavicon('iqworks');
+ *
+ * // Use in document head
+ * <link rel="icon" type="image/svg+xml" href={favicon.dataUrl} />
+ *
+ * // Get PNG favicon for light theme
+ * const pngFavicon = getFavicon('iqworks', { format: 'png', theme: 'light' });
+ * ```
+ */
+export declare function getFavicon(product: FaviconProductKey, options?: GetFaviconOptions): FaviconData | null;
+/**
+ * Get all available favicon product keys
+ */
+export declare function getAvailableFaviconProducts(): FaviconProductKey[];
+/**
+ * Check if a product has a favicon available
+ */
+export declare function hasFavicon(product: string): product is FaviconProductKey;
+export interface UseFaviconOptions extends GetFaviconOptions {
+    /** Whether to apply the favicon to the document (default: true) */
+    apply?: boolean;
+}
+/**
+ * React hook to set the document favicon for a product.
+ * Automatically updates the favicon when the product or options change.
+ *
+ * @param product - The product key (e.g., 'iqworks')
+ * @param options - Optional format, theme, and apply settings
+ * @returns The favicon data object
+ *
+ * @example
+ * ```tsx
+ * function App() {
+ *   // Automatically sets the document favicon
+ *   useFavicon('iqworks');
+ *
+ *   return <div>...</div>;
+ * }
+ *
+ * // With options
+ * useFavicon('iqworks', { format: 'png', theme: 'light' });
+ *
+ * // Get data without applying
+ * const favicon = useFavicon('iqworks', { apply: false });
+ * ```
+ */
+export declare function useFavicon(product: FaviconProductKey, options?: UseFaviconOptions): FaviconData | null;
+//# sourceMappingURL=index.d.ts.map

package/dist/components/Favicons/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/Favicons/index.tsx"],"names":[],"mappings":"AAYA;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC;AAG1C,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,KAAK,CAAC;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAsC5C,MAAM,WAAW,WAAW;IAC1B,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,2CAA2C;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,MAAM,EAAE,aAAa,CAAC;IACtB,wBAAwB;IACxB,KAAK,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,iDAAiD;IACjD,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,iBAAiB,EAC1B,OAAO,GAAE,iBAAsB,GAC9B,WAAW,GAAG,IAAI,CA4BpB;AAED;;GAEG;AACH,wBAAgB,2BAA2B,IAAI,iBAAiB,EAAE,CAEjE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,IAAI,iBAAiB,CAExE;AAED,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,mEAAmE;IACnE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,iBAAiB,EAC1B,OAAO,GAAE,iBAAsB,GAC9B,WAAW,GAAG,IAAI,CAwBpB"}