@spteck/react-controls-v2 2.2.9 → 2.3.1

package/dist/hooks/useBrandCenterFonts.d.ts

@@ -0,0 +1,51 @@
+import { IBrandCenterFont } from '../abstractions/IBrandCenterFonts';
+
+/** Options for the useBrandCenterFonts hook */
+export interface IUseBrandCenterFontsOptions {
+    /** SharePoint site URL (e.g. "https://contoso.sharepoint.com/sites/brand").
+     *  When omitted the hook reads it from `pageContext.web.absoluteUrl`. */
+    siteUrl?: string;
+    /** If true the hook will NOT fetch from Brand Center;
+     *  use `fonts` to supply a static list instead. */
+    disabled?: boolean;
+    /** Provide brand fonts directly instead of fetching from the API.
+     *  Useful for testing or when fonts are already available. */
+    fonts?: IBrandCenterFont[];
+}
+/** Return value of useBrandCenterFonts */
+export interface IUseBrandCenterFontsReturn {
+    /** Available Brand Center fonts (or Fluent UI defaults if Brand Center is not configured) */
+    fonts: IBrandCenterFont[];
+    /** Font family names ready for CSS / TypographyControl.fontFamily */
+    fontFamilyNames: string[];
+    /** The organization's default font (if any) */
+    defaultFont: IBrandCenterFont | undefined;
+    /** Whether data is currently being fetched */
+    loading: boolean;
+    /** Error message, if the fetch failed */
+    error: string | undefined;
+    /** Whether Brand Center fonts are configured for this tenant */
+    isBrandCenterAvailable: boolean;
+    /** Re-fetch fonts from the API */
+    refresh: () => Promise<void>;
+}
+/**
+ * React hook that loads fonts from the SharePoint Brand Center and
+ * injects `@font-face` rules so they can be used anywhere in the app
+ * — including with `TypographyControl`'s `fontFamily` prop.
+ *
+ * @example
+ * ```tsx
+ * const { fontFamilyNames, defaultFont, loading } = useBrandCenterFonts();
+ *
+ * if (loading) return <Spinner />;
+ *
+ * return (
+ *   <TypographyControl fontFamily={defaultFont?.name} fontSize="l">
+ *     Hello from Brand Center
+ *   </TypographyControl>
+ * );
+ * ```
+ */
+export declare const useBrandCenterFonts: (options?: IUseBrandCenterFontsOptions) => IUseBrandCenterFontsReturn;
+//# sourceMappingURL=useBrandCenterFonts.d.ts.map