@windstream/react-shared-components 0.2.10 → 0.2.12

package/dist/contentful/index.d.ts

@@ -826,6 +826,47 @@ declare const CartRetentionBanner: React.FC<{
     onBannerShown?: () => void;
 }>;
 
+declare const bgColorMap: {
+    readonly gray90: "#464646";
+    readonly green: "#24A76A";
+    readonly white: "#FFFFFF";
+};
+type BackgroundColor = keyof typeof bgColorMap;
+type IframeEmbedProps = {
+    /** The full URL of the third-party iframe to embed (e.g., Brand Featured badge URL). */
+    iframeUrl: string;
+    /** Optional HTML `id` for the wrapping `<section>`, useful for anchor linking or scroll-to navigation. */
+    anchorId?: string;
+    /** Optional background color applied behind the iframe. Defaults to `"transparent"` when not provided. */
+    backgroundColor?: BackgroundColor;
+    /** Optional initial/minimum height (in px) for the iframe before postMessage auto-resize kicks in. */
+    height?: number;
+};
+
+/**
+ * IframeEmbed — A generic, responsive iframe component for embedding third-party content
+ * such as Brand Featured badges, widgets, or any external HTML page.
+ *
+ * Features:
+ * - **Auto-resize:** Listens for `postMessage` events with an `{ iframeHeight: number }` payload
+ *   from the embedded page and adjusts the iframe height dynamically.
+ * - **Background color:** Supports predefined background colors (`gray90`, `green`, `white`)
+ *   behind the iframe, defaulting to transparent.
+ * - **Lazy loading:** The iframe uses `loading="lazy"` for performance.
+ * - **Anchor support:** An optional `anchorId` is applied to the wrapping `<section>` for
+ *   deep-linking or scroll-to navigation.
+ *
+ * @example
+ * ```tsx
+ * <IframeEmbed
+ *   iframeUrl="https://api.brandfeatured.com/badges/badge-news_dark.html?id=123"
+ *   backgroundColor="green"
+ *   anchorId="brand-badge"
+ * />
+ * ```
+ */
+declare const IframeEmbed: React__default.FC<IframeEmbedProps>;
+
 declare const toDocument: (v: unknown | null | undefined) => Document | null;
 
 /**
@@ -850,5 +891,5 @@ interface ProcessedChecklistItem {
 }
 declare function useProcessedChecklist<T extends boolean = false>(checklistData?: any, titlesOnly?: T, richTextOptions?: Options, richTextClassName?: string): T extends true ? string[] : ProcessedChecklistItem[];
 
-export { Accordion, AddressInputBanner, AnchoredBottomBanner, BlogCard, BlogGrid, BlogGridBase, BreadcrumbNavigation, Button, Callout, Cards, Carousel, CartRetentionBanner, ComparisonTable, CookieBanner, CtaCallout, DynamicTabs, EmailInputBlock, FindKinetic, FloatingBanner, Footer, ImagePromoBar, Modal, Navigation, PrimaryHero, ProductCard, SearchBlock, ShapeBackgroundWrapper, SimpleCard, TestimonialCard, Text, label1BoldOptions, renderContentfulRichText, renderContentfulRichTextTable, toDocument, useContentfulRichText, useProcessedChecklist };
-export type { AccordionProps, AddressInputBannerProps, AnchoredBottomBannerProps, BlogCardProps$2 as BlogCardProps, BlogGridBaseProps, BlogGridProps, BreadcrumbNavigationProps, ButtonProps, CalloutProps, CardsProps, CarouselProps, TypeCartRetentionBannerFields as CartRetentionBannerProps, ComparisonTableProps, TypeComponentRichTextFields as CookieBannerProps, CtaCalloutProps, DynamicTabsT, EmailInputBlockProps, FindKineticProps, FloatingBannerProps, FooterProps, ImagePromoBarProps, ModalProps, NavigationProps, PrimaryHeroProps, ProcessedChecklistItem, ProductCardProps, SearchBlockProps, ShapeBackgroundWrapperProps, SimpleCardProps, TestimonialCardProps, TextProps };
+export { Accordion, AddressInputBanner, AnchoredBottomBanner, BlogCard, BlogGrid, BlogGridBase, BreadcrumbNavigation, Button, Callout, Cards, Carousel, CartRetentionBanner, ComparisonTable, CookieBanner, CtaCallout, DynamicTabs, EmailInputBlock, FindKinetic, FloatingBanner, Footer, IframeEmbed, ImagePromoBar, Modal, Navigation, PrimaryHero, ProductCard, SearchBlock, ShapeBackgroundWrapper, SimpleCard, TestimonialCard, Text, label1BoldOptions, renderContentfulRichText, renderContentfulRichTextTable, toDocument, useContentfulRichText, useProcessedChecklist };
+export type { AccordionProps, AddressInputBannerProps, AnchoredBottomBannerProps, BlogCardProps$2 as BlogCardProps, BlogGridBaseProps, BlogGridProps, BreadcrumbNavigationProps, ButtonProps, CalloutProps, CardsProps, CarouselProps, TypeCartRetentionBannerFields as CartRetentionBannerProps, ComparisonTableProps, TypeComponentRichTextFields as CookieBannerProps, CtaCalloutProps, DynamicTabsT, EmailInputBlockProps, FindKineticProps, FloatingBannerProps, FooterProps, IframeEmbedProps, ImagePromoBarProps, ModalProps, NavigationProps, PrimaryHeroProps, ProcessedChecklistItem, ProductCardProps, SearchBlockProps, ShapeBackgroundWrapperProps, SimpleCardProps, TestimonialCardProps, TextProps };