@digital-b2c/coreui-kit 0.14.7 → 0.15.1

package/dist/index.d.cts

@@ -84,6 +84,7 @@ declare const svgs: {
     tiltedRight: string;
     xBlack: string;
     xWhite: string;
+    user: string;
 };
 type IconType = keyof typeof svgs;
 interface IconProps extends react__default.ComponentPropsWithRef<'svg'> {
@@ -399,6 +400,61 @@ declare const BlogPostContent: (({ className, body, children }: BlogPostContentP
     Body: ({ children }: BlogPostContentBodyProps) => react.JSX.Element;
 };
 
+interface SearchProps {
+    placeholder?: string;
+    /** Optional CTA. When it has a `url`, submitting navigates to `${url}?q=<query>`. */
+    searchCta?: ICta;
+    /** Called with the trimmed query when the search is submitted. */
+    onSearch?: (query: string) => void;
+    /**
+     * `pill` renders the persistent pill style; `expandable` (default) renders an
+     * icon button that expands into the input on click.
+     */
+    variant?: 'expandable' | 'pill';
+    className?: string;
+}
+
+declare const Search: ({ placeholder, searchCta, onSearch, variant, className, }: SearchProps) => react.JSX.Element;
+
+interface UserMenuItem {
+    label: string;
+    /** Renders the item as a link. */
+    url?: string;
+    isExternal?: boolean;
+    /** Called when the item is activated. */
+    onClick?: () => void;
+    /** `danger` renders the item in the notification-red treatment (e.g. Log out). */
+    variant?: 'default' | 'danger';
+}
+interface UserMenuUser {
+    /** Display name shown next to the avatar. */
+    label: string;
+    /** Optional link the button navigates to (used when `menuItems` is empty). */
+    url?: string;
+    isExternal?: boolean;
+    /** Optional avatar image; falls back to a default user icon. */
+    avatar?: IPicture;
+    /** Items shown in the dropdown menu opened by the button. */
+    menuItems?: UserMenuItem[];
+}
+interface UserMenuProps {
+    user: UserMenuUser;
+    className?: string;
+    /** Opens the menu above the button instead of below (e.g. in a footer). */
+    dropUp?: boolean;
+    /** Stretches the button to fill the width of its container. */
+    fullWidth?: boolean;
+}
+
+/**
+ * Reusable user / account button.
+ *
+ * - With `menuItems`, renders a button that toggles a dropdown menu (closes on
+ *   Escape or outside interaction).
+ * - Without `menuItems`, renders a plain link (when `url` is set) or button.
+ */
+declare const UserMenu: ({ user, className, dropUp, fullWidth }: UserMenuProps) => react.JSX.Element;
+
 interface AnchorProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
     isExternal?: boolean;
     renderLink?: (props: AnchorHTMLAttributes<HTMLAnchorElement> & {
@@ -638,23 +694,46 @@ interface BaseNavItem {
 interface NavLink {
     type: 'link';
     cta?: ICta;
+    /** Marks the item as the current page (adds the active treatment). */
+    isActive?: boolean;
+    variant?: 'subMenuSpacer';
 }
 interface NavDropdown extends BaseNavItem {
     type: 'dropdown';
     items: NavItem[];
     cta?: ICta;
+    /** Marks the item as the current page (adds the active treatment). */
+    isActive?: boolean;
 }
+/** A single top-level navigation entry, shared by the external and internal navigation. */
 type NavItem = NavLink | NavDropdown;
+/**
+ * Brand logos shown in the "unfolded" color bar at the top of the page.
+ * When omitted the color bars stay as thin 8px strips.
+ */
+interface NavigationBrandLogos {
+    lenscrafters?: IPicture;
+    forEyes?: IPicture;
+    optical?: IPicture;
+    pearleVision?: IPicture;
+}
 interface NavigationProps {
     className?: string;
-    variant?: 'transparent';
+    variant?: 'external' | 'internal' | '' | null;
+    transparent?: boolean;
     mainLogo?: string;
+    logoAlt?: string;
     homeCta?: string;
     loginCta?: ICta;
     rightButton?: ICta;
     navigationItems?: {
         items: NavItem[];
     };
+    user?: UserMenuUser;
+    searchPlaceholder?: string;
+    searchCta?: ICta;
+    onSearch?: (query: string) => void;
+    brandLogos?: NavigationBrandLogos;
 }
 
 declare const Navigation: (props: NavigationProps) => react.JSX.Element;
@@ -978,6 +1057,21 @@ declare const TextCenterWithMedia: (({ className, title, thumbnail, videoUrl, lo
     Title: ({ children }: TextCenterWithMediaTitleProps) => react.JSX.Element;
 };
 
+interface QuoteSectionBlockItem {
+    quoteLogo: string;
+    bodyText: ReactNode;
+    displayPhoto: string;
+    displayName: string;
+    jobTitleLogo: string;
+}
+interface QuoteSectionBlockProps {
+    className?: string;
+    title?: string;
+    items?: QuoteSectionBlockItem[];
+}
+
+declare const QuoteSectionBlock: ({ className, title, items }: QuoteSectionBlockProps) => react.JSX.Element | null;
+
 type IntersectionObserverOptions = {
     threshold?: number | number[];
     rootMargin?: string;
@@ -1003,4 +1097,4 @@ type SlotMap = Record<string, SlotComponent>;
  */
 declare function resolveCompoundSlots(children: ReactNode, slots: SlotMap): Record<string, ReactNode>;
 
-export { Anchor, type AnchorProps, Badge, type BadgeProps, BlogCardGrid, type BlogCardGridProps, BlogPost, BlogPostContent, type BlogPostContentProps, type BlogPostProps, BlogSearchResultsList, type BlogSearchResultsListProps, BrandsStrip, type BrandsStripProps, Button, type ButtonProps, Card, CardCollection, type CardCollectionProps, type CardProps, ConditionalWrapper, type ConditionalWrapperProps, ContactModule, type ContactModuleProps, Container, type ContainerProps, CountingCard, type CountingCardProps, EventList, type EventListProps, FeaturedNewsHighlights, type FeaturedNewsHighlightsProps, FilterBar, type FilterBarProps, type FilterOption, Footer, type FooterProps, GlobalSearchResultsList, type GlobalSearchResultsListProps, type GridItemProps, type GridProps, HeroBanner, HeroBannerCarousel, type HeroBannerCarouselProps, type HeroBannerProps, type ICta, type ICtaHoverLogo, type ICtaIcon, type ICtaLogo, type IFooterSupportGroup, type IPicture, Icon, type IconType, InfoCard, type InfoCardProps, Input, type InputProps, InternalBrandsTab, type InternalBrandsTabProps, MiniBanner, type MiniBannerProps, MiniSectionCta, type MiniSectionCtaProps, Navigation, type NavigationProps, NewsCard, NewsCardList, type NewsCardListProps, type NewsCardProps, Pagination, type PaginationProps, Picture, type PictureProps, PracticeCard, type PracticeCardProps, PracticePathCards, type PracticePathCardsProps, ResourceCardItem, type ResourceCardItemProps, type ResourceItem, type ResourceItemType, type ResourceView, ResourcesGridList, type ResourcesGridListProps, Sidebar, type SidebarCategory, type SidebarProps, type SortOption, type TButtonVariant, Teaser5050With3Text, type Teaser5050With3TextProps, Teaser5050WithCta, type Teaser5050WithCtaProps, TextBody, type TextBodyProps, TextCenterCtaInBottom, type TextCenterCtaInBottomProps, TextCenterWithMedia, type TextCenterWithMediaProps, TextEvent, type TextEventProps, UpcomingEventCard, type UpcomingEventCardProps, resolveCompoundSlots, svgs, useIntersectionObserver, useIsAtTop };
+export { Anchor, type AnchorProps, Badge, type BadgeProps, BlogCardGrid, type BlogCardGridProps, BlogPost, BlogPostContent, type BlogPostContentProps, type BlogPostProps, BlogSearchResultsList, type BlogSearchResultsListProps, BrandsStrip, type BrandsStripProps, Button, type ButtonProps, Card, CardCollection, type CardCollectionProps, type CardProps, ConditionalWrapper, type ConditionalWrapperProps, ContactModule, type ContactModuleProps, Container, type ContainerProps, CountingCard, type CountingCardProps, EventList, type EventListProps, FeaturedNewsHighlights, type FeaturedNewsHighlightsProps, FilterBar, type FilterBarProps, type FilterOption, Footer, type FooterProps, GlobalSearchResultsList, type GlobalSearchResultsListProps, type GridItemProps, type GridProps, HeroBanner, HeroBannerCarousel, type HeroBannerCarouselProps, type HeroBannerProps, type ICta, type ICtaHoverLogo, type ICtaIcon, type ICtaLogo, type IFooterSupportGroup, type IPicture, Icon, type IconType, InfoCard, type InfoCardProps, Input, type InputProps, InternalBrandsTab, type InternalBrandsTabProps, type UserMenuItem as InternalNavMenuItem, MiniBanner, type MiniBannerProps, MiniSectionCta, type MiniSectionCtaProps, type NavItem, Navigation, type NavigationBrandLogos, type NavigationProps, type UserMenuUser as NavigationUser, NewsCard, NewsCardList, type NewsCardListProps, type NewsCardProps, Pagination, type PaginationProps, Picture, type PictureProps, PracticeCard, type PracticeCardProps, PracticePathCards, type PracticePathCardsProps, QuoteSectionBlock, type QuoteSectionBlockProps, ResourceCardItem, type ResourceCardItemProps, type ResourceItem, type ResourceItemType, type ResourceView, ResourcesGridList, type ResourcesGridListProps, Search, type SearchProps, Sidebar, type SidebarCategory, type SidebarProps, type SortOption, type TButtonVariant, Teaser5050With3Text, type Teaser5050With3TextProps, Teaser5050WithCta, type Teaser5050WithCtaProps, TextBody, type TextBodyProps, TextCenterCtaInBottom, type TextCenterCtaInBottomProps, TextCenterWithMedia, type TextCenterWithMediaProps, TextEvent, type TextEventProps, UpcomingEventCard, type UpcomingEventCardProps, UserMenu, type UserMenuItem, type UserMenuProps, type UserMenuUser, resolveCompoundSlots, svgs, useIntersectionObserver, useIsAtTop };

package/dist/index.d.ts

@@ -84,6 +84,7 @@ declare const svgs: {
     tiltedRight: string;
     xBlack: string;
     xWhite: string;
+    user: string;
 };
 type IconType = keyof typeof svgs;
 interface IconProps extends react__default.ComponentPropsWithRef<'svg'> {
@@ -399,6 +400,61 @@ declare const BlogPostContent: (({ className, body, children }: BlogPostContentP
     Body: ({ children }: BlogPostContentBodyProps) => react.JSX.Element;
 };
 
+interface SearchProps {
+    placeholder?: string;
+    /** Optional CTA. When it has a `url`, submitting navigates to `${url}?q=<query>`. */
+    searchCta?: ICta;
+    /** Called with the trimmed query when the search is submitted. */
+    onSearch?: (query: string) => void;
+    /**
+     * `pill` renders the persistent pill style; `expandable` (default) renders an
+     * icon button that expands into the input on click.
+     */
+    variant?: 'expandable' | 'pill';
+    className?: string;
+}
+
+declare const Search: ({ placeholder, searchCta, onSearch, variant, className, }: SearchProps) => react.JSX.Element;
+
+interface UserMenuItem {
+    label: string;
+    /** Renders the item as a link. */
+    url?: string;
+    isExternal?: boolean;
+    /** Called when the item is activated. */
+    onClick?: () => void;
+    /** `danger` renders the item in the notification-red treatment (e.g. Log out). */
+    variant?: 'default' | 'danger';
+}
+interface UserMenuUser {
+    /** Display name shown next to the avatar. */
+    label: string;
+    /** Optional link the button navigates to (used when `menuItems` is empty). */
+    url?: string;
+    isExternal?: boolean;
+    /** Optional avatar image; falls back to a default user icon. */
+    avatar?: IPicture;
+    /** Items shown in the dropdown menu opened by the button. */
+    menuItems?: UserMenuItem[];
+}
+interface UserMenuProps {
+    user: UserMenuUser;
+    className?: string;
+    /** Opens the menu above the button instead of below (e.g. in a footer). */
+    dropUp?: boolean;
+    /** Stretches the button to fill the width of its container. */
+    fullWidth?: boolean;
+}
+
+/**
+ * Reusable user / account button.
+ *
+ * - With `menuItems`, renders a button that toggles a dropdown menu (closes on
+ *   Escape or outside interaction).
+ * - Without `menuItems`, renders a plain link (when `url` is set) or button.
+ */
+declare const UserMenu: ({ user, className, dropUp, fullWidth }: UserMenuProps) => react.JSX.Element;
+
 interface AnchorProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
     isExternal?: boolean;
     renderLink?: (props: AnchorHTMLAttributes<HTMLAnchorElement> & {
@@ -638,23 +694,46 @@ interface BaseNavItem {
 interface NavLink {
     type: 'link';
     cta?: ICta;
+    /** Marks the item as the current page (adds the active treatment). */
+    isActive?: boolean;
+    variant?: 'subMenuSpacer';
 }
 interface NavDropdown extends BaseNavItem {
     type: 'dropdown';
     items: NavItem[];
     cta?: ICta;
+    /** Marks the item as the current page (adds the active treatment). */
+    isActive?: boolean;
 }
+/** A single top-level navigation entry, shared by the external and internal navigation. */
 type NavItem = NavLink | NavDropdown;
+/**
+ * Brand logos shown in the "unfolded" color bar at the top of the page.
+ * When omitted the color bars stay as thin 8px strips.
+ */
+interface NavigationBrandLogos {
+    lenscrafters?: IPicture;
+    forEyes?: IPicture;
+    optical?: IPicture;
+    pearleVision?: IPicture;
+}
 interface NavigationProps {
     className?: string;
-    variant?: 'transparent';
+    variant?: 'external' | 'internal' | '' | null;
+    transparent?: boolean;
     mainLogo?: string;
+    logoAlt?: string;
     homeCta?: string;
     loginCta?: ICta;
     rightButton?: ICta;
     navigationItems?: {
         items: NavItem[];
     };
+    user?: UserMenuUser;
+    searchPlaceholder?: string;
+    searchCta?: ICta;
+    onSearch?: (query: string) => void;
+    brandLogos?: NavigationBrandLogos;
 }
 
 declare const Navigation: (props: NavigationProps) => react.JSX.Element;
@@ -978,6 +1057,21 @@ declare const TextCenterWithMedia: (({ className, title, thumbnail, videoUrl, lo
     Title: ({ children }: TextCenterWithMediaTitleProps) => react.JSX.Element;
 };
 
+interface QuoteSectionBlockItem {
+    quoteLogo: string;
+    bodyText: ReactNode;
+    displayPhoto: string;
+    displayName: string;
+    jobTitleLogo: string;
+}
+interface QuoteSectionBlockProps {
+    className?: string;
+    title?: string;
+    items?: QuoteSectionBlockItem[];
+}
+
+declare const QuoteSectionBlock: ({ className, title, items }: QuoteSectionBlockProps) => react.JSX.Element | null;
+
 type IntersectionObserverOptions = {
     threshold?: number | number[];
     rootMargin?: string;
@@ -1003,4 +1097,4 @@ type SlotMap = Record<string, SlotComponent>;
  */
 declare function resolveCompoundSlots(children: ReactNode, slots: SlotMap): Record<string, ReactNode>;
 
-export { Anchor, type AnchorProps, Badge, type BadgeProps, BlogCardGrid, type BlogCardGridProps, BlogPost, BlogPostContent, type BlogPostContentProps, type BlogPostProps, BlogSearchResultsList, type BlogSearchResultsListProps, BrandsStrip, type BrandsStripProps, Button, type ButtonProps, Card, CardCollection, type CardCollectionProps, type CardProps, ConditionalWrapper, type ConditionalWrapperProps, ContactModule, type ContactModuleProps, Container, type ContainerProps, CountingCard, type CountingCardProps, EventList, type EventListProps, FeaturedNewsHighlights, type FeaturedNewsHighlightsProps, FilterBar, type FilterBarProps, type FilterOption, Footer, type FooterProps, GlobalSearchResultsList, type GlobalSearchResultsListProps, type GridItemProps, type GridProps, HeroBanner, HeroBannerCarousel, type HeroBannerCarouselProps, type HeroBannerProps, type ICta, type ICtaHoverLogo, type ICtaIcon, type ICtaLogo, type IFooterSupportGroup, type IPicture, Icon, type IconType, InfoCard, type InfoCardProps, Input, type InputProps, InternalBrandsTab, type InternalBrandsTabProps, MiniBanner, type MiniBannerProps, MiniSectionCta, type MiniSectionCtaProps, Navigation, type NavigationProps, NewsCard, NewsCardList, type NewsCardListProps, type NewsCardProps, Pagination, type PaginationProps, Picture, type PictureProps, PracticeCard, type PracticeCardProps, PracticePathCards, type PracticePathCardsProps, ResourceCardItem, type ResourceCardItemProps, type ResourceItem, type ResourceItemType, type ResourceView, ResourcesGridList, type ResourcesGridListProps, Sidebar, type SidebarCategory, type SidebarProps, type SortOption, type TButtonVariant, Teaser5050With3Text, type Teaser5050With3TextProps, Teaser5050WithCta, type Teaser5050WithCtaProps, TextBody, type TextBodyProps, TextCenterCtaInBottom, type TextCenterCtaInBottomProps, TextCenterWithMedia, type TextCenterWithMediaProps, TextEvent, type TextEventProps, UpcomingEventCard, type UpcomingEventCardProps, resolveCompoundSlots, svgs, useIntersectionObserver, useIsAtTop };
+export { Anchor, type AnchorProps, Badge, type BadgeProps, BlogCardGrid, type BlogCardGridProps, BlogPost, BlogPostContent, type BlogPostContentProps, type BlogPostProps, BlogSearchResultsList, type BlogSearchResultsListProps, BrandsStrip, type BrandsStripProps, Button, type ButtonProps, Card, CardCollection, type CardCollectionProps, type CardProps, ConditionalWrapper, type ConditionalWrapperProps, ContactModule, type ContactModuleProps, Container, type ContainerProps, CountingCard, type CountingCardProps, EventList, type EventListProps, FeaturedNewsHighlights, type FeaturedNewsHighlightsProps, FilterBar, type FilterBarProps, type FilterOption, Footer, type FooterProps, GlobalSearchResultsList, type GlobalSearchResultsListProps, type GridItemProps, type GridProps, HeroBanner, HeroBannerCarousel, type HeroBannerCarouselProps, type HeroBannerProps, type ICta, type ICtaHoverLogo, type ICtaIcon, type ICtaLogo, type IFooterSupportGroup, type IPicture, Icon, type IconType, InfoCard, type InfoCardProps, Input, type InputProps, InternalBrandsTab, type InternalBrandsTabProps, type UserMenuItem as InternalNavMenuItem, MiniBanner, type MiniBannerProps, MiniSectionCta, type MiniSectionCtaProps, type NavItem, Navigation, type NavigationBrandLogos, type NavigationProps, type UserMenuUser as NavigationUser, NewsCard, NewsCardList, type NewsCardListProps, type NewsCardProps, Pagination, type PaginationProps, Picture, type PictureProps, PracticeCard, type PracticeCardProps, PracticePathCards, type PracticePathCardsProps, QuoteSectionBlock, type QuoteSectionBlockProps, ResourceCardItem, type ResourceCardItemProps, type ResourceItem, type ResourceItemType, type ResourceView, ResourcesGridList, type ResourcesGridListProps, Search, type SearchProps, Sidebar, type SidebarCategory, type SidebarProps, type SortOption, type TButtonVariant, Teaser5050With3Text, type Teaser5050With3TextProps, Teaser5050WithCta, type Teaser5050WithCtaProps, TextBody, type TextBodyProps, TextCenterCtaInBottom, type TextCenterCtaInBottomProps, TextCenterWithMedia, type TextCenterWithMediaProps, TextEvent, type TextEventProps, UpcomingEventCard, type UpcomingEventCardProps, UserMenu, type UserMenuItem, type UserMenuProps, type UserMenuUser, resolveCompoundSlots, svgs, useIntersectionObserver, useIsAtTop };