@harshit-wander/component-lib 0.1.0 → 1.0.0

package/dist/index.d.ts

@@ -1,13 +1,26 @@
 import * as react from 'react';
 import { HTMLAttributes, FormHTMLAttributes, ReactNode, ElementType } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as styled_components from 'styled-components';
 
+/** A single partner brand to render as a logo card. */
 interface Brand {
+    /** Image URL for the brand's logo. Rendered as the `src` of an `<img>`. */
     logo: string;
+    /** Brand name. Used as the image `alt` text and rendered as the visible label. */
     name: string;
+    /**
+     * Optional URL. When provided, the card becomes an anchor that opens in a new
+     * tab with `rel="noopener noreferrer"`. Omit to render a non-interactive card.
+     */
     href?: string;
 }
+/**
+ * Props for the `BrandLogo` component.
+ *
+ * Extends `HTMLAttributes<HTMLElement>` so consumers can pass standard DOM
+ * attributes (`className`, `style`, `aria-*`, `data-*`, event handlers). They
+ * are forwarded to the root element — `<a>` when `href` is set, `<div>` otherwise.
+ */
 interface BrandLogoProps extends HTMLAttributes<HTMLElement>, Brand {
 }
 
@@ -52,16 +65,25 @@ interface DestinationCardProps extends HTMLAttributes<HTMLElement> {
     href?: string | undefined;
 }
 
-declare const DestinationCard: react.ForwardRefExoticComponent<DestinationCardProps & react.RefAttributes<HTMLAnchorElement>>;
+declare const DestinationCard: react.ForwardRefExoticComponent<DestinationCardProps & react.RefAttributes<HTMLElement>>;
 
 interface EventBannerProps extends HTMLAttributes<HTMLElement> {
-    image: string;
+    imageUrl: string;
     alt: string;
     href?: string | undefined;
 }
 
 declare const EventBanner: react.ForwardRefExoticComponent<EventBannerProps & react.RefAttributes<HTMLDivElement>>;
 
+interface EventVideoBannerProps extends HTMLAttributes<HTMLElement> {
+    posterUrl: string;
+    videoUrl: string;
+    alt: string;
+    href?: string | undefined;
+}
+
+declare const EventVideoBanner: react.ForwardRefExoticComponent<EventVideoBannerProps & react.RefAttributes<HTMLDivElement>>;
+
 interface ValueItem {
     title: string;
     bullets: string[];
@@ -84,7 +106,7 @@ interface ExploreCardProps extends HTMLAttributes<HTMLElement> {
     href?: string | undefined;
 }
 
-declare const ExploreCard: react.ForwardRefExoticComponent<ExploreCardProps & react.RefAttributes<HTMLAnchorElement>>;
+declare const ExploreCard: react.ForwardRefExoticComponent<ExploreCardProps & react.RefAttributes<HTMLElement>>;
 
 interface FaqItem {
     question: string;
@@ -99,10 +121,9 @@ interface FaqExpandableProps extends Omit<HTMLAttributes<HTMLElement>, 'onToggle
 declare const FaqExpandable: react.ForwardRefExoticComponent<FaqExpandableProps & react.RefAttributes<HTMLElement>>;
 
 interface FeatureCardProps extends HTMLAttributes<HTMLElement> {
-    title: string;
-    description: string;
-    illustration: string;
-    illustrationAlt?: string | undefined;
+    heading: string;
+    description?: string | undefined;
+    imageUrl?: string | undefined;
 }
 
 declare const FeatureCard: react.ForwardRefExoticComponent<FeatureCardProps & react.RefAttributes<HTMLElement>>;
@@ -150,7 +171,7 @@ interface PackageCardProps extends HTMLAttributes<HTMLElement> {
     href?: string | undefined;
 }
 
-declare const PackageCard: react.ForwardRefExoticComponent<PackageCardProps & react.RefAttributes<HTMLAnchorElement>>;
+declare const PackageCard: react.ForwardRefExoticComponent<PackageCardProps & react.RefAttributes<HTMLElement>>;
 
 type SectionHeaderAlign = 'left' | 'center';
 interface SectionHeaderProps extends HTMLAttributes<HTMLElement> {
@@ -198,7 +219,7 @@ interface TripCategoryCardProps extends HTMLAttributes<HTMLElement> {
     href?: string | undefined;
 }
 
-declare const TripCategoryCard: react.ForwardRefExoticComponent<TripCategoryCardProps & react.RefAttributes<HTMLAnchorElement>>;
+declare const TripCategoryCard: react.ForwardRefExoticComponent<TripCategoryCardProps & react.RefAttributes<HTMLElement>>;
 
 interface Warrior {
     icon: ReactNode | string;
@@ -228,10 +249,7 @@ interface BrandsSectionProps extends HTMLAttributes<HTMLElement> {
     brands: Brand[];
 }
 
-declare const BrandsSection: {
-    ({ heading, subheading, brands, ...rest }: BrandsSectionProps): react_jsx_runtime.JSX.Element;
-    displayName: string;
-};
+declare const BrandsSection: react.ForwardRefExoticComponent<BrandsSectionProps & react.RefAttributes<HTMLElement>>;
 
 interface NavCategoryItem {
     label: string;
@@ -257,7 +275,17 @@ interface MobileCta {
 interface CategoryNavbarProps extends HTMLAttributes<HTMLElement> {
     logo: string | ReactNode;
     logoHref?: string;
-    categories: NavCategory[];
+    /**
+     * Categories rendered horizontally in the desktop bar (visible on `md`+ screens).
+     * Each entry may have its own `items[]` mega-menu dropdown.
+     */
+    desktopCategories: NavCategory[];
+    /**
+     * Categories rendered inside the mobile hamburger drawer (visible on screens
+     * below `md`). Independent from `desktopCategories` so the two can show
+     * different sets of links — typically more entries in the mobile drawer.
+     */
+    mobileCategories: NavCategory[];
     searchHref?: string;
     phoneNumber?: string | undefined;
     LinkComponent?: ElementType | undefined;
@@ -266,6 +294,12 @@ interface CategoryNavbarProps extends HTMLAttributes<HTMLElement> {
     onMobileOpenChange?: (next: boolean) => void;
     mobileFooterLinks?: MobileFooterLink[] | undefined;
     mobileCta?: MobileCta | undefined;
+    /**
+     * Whether the navbar sticks to the top of the viewport on scroll.
+     * Defaults to `true`. Set to `false` when composing inside a shared sticky
+     * parent (e.g. `SiteHeader`).
+     */
+    sticky?: boolean | undefined;
 }
 
 declare const CategoryNavbar: react.ForwardRefExoticComponent<CategoryNavbarProps & react.RefAttributes<HTMLElement>>;
@@ -311,14 +345,25 @@ interface DestinationsSectionProps extends HTMLAttributes<HTMLElement> {
 
 declare const DestinationsSection: react.ForwardRefExoticComponent<DestinationsSectionProps & react.RefAttributes<HTMLElement>>;
 
-interface EventCarouselItem {
-    image: string;
+interface EventCarouselImageItem {
+    imageUrl: string;
     alt: string;
     href?: string | undefined;
 }
-interface EventCarouselProps extends HTMLAttributes<HTMLElement> {
-    events: EventCarouselItem[];
+interface EventCarouselVideoItem {
+    posterUrl: string;
+    videoUrl: string;
+    alt: string;
+    href?: string | undefined;
 }
+type BaseProps = HTMLAttributes<HTMLElement>;
+type EventCarouselProps = (BaseProps & {
+    variant?: 'image';
+    events: EventCarouselImageItem[];
+}) | (BaseProps & {
+    variant: 'video';
+    events: EventCarouselVideoItem[];
+});
 
 declare const EventCarousel: react.ForwardRefExoticComponent<EventCarouselProps & react.RefAttributes<HTMLElement>>;
 
@@ -343,7 +388,7 @@ interface FaqSectionProps extends HTMLAttributes<HTMLElement> {
 }
 
 declare const FaqSection: {
-    ({ heading, subheading, faqs, singleOpen, ...rest }: FaqSectionProps): react_jsx_runtime.JSX.Element;
+    ({ heading, subheading, faqs, singleOpen, className, ...rest }: FaqSectionProps): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
 
@@ -416,6 +461,50 @@ type HeroProps = (HeroBase & {
 
 declare const Hero: react.ForwardRefExoticComponent<HeroProps & react.RefAttributes<HTMLElement>>;
 
+interface HomeHeroReview {
+    /** Brand logo URL (e.g. Google, TripAdvisor, Facebook). Rendered as a 40×40 square. */
+    logoUrl: string;
+    /** Accessible label for the logo (brand name). */
+    alt: string;
+    /** Numeric rating, e.g. 4.9. Rendered to one decimal. */
+    rating: number;
+    /** Total reviews count, e.g. 6626. Rendered with thousands separators. */
+    reviewCount: number;
+}
+interface HomeHeroTypewriterOptions {
+    /** Milliseconds between each typed character. Default 80. */
+    typeSpeedMs?: number;
+    /** Milliseconds between each deleted character. Default 40. */
+    deleteSpeedMs?: number;
+    /** Milliseconds to hold the fully-typed phrase before deleting. Default 1500. */
+    pauseFullMs?: number;
+    /** Milliseconds to hold empty before starting the next phrase. Default 300. */
+    pauseEmptyMs?: number;
+}
+interface HomeHeroProps extends HTMLAttributes<HTMLElement> {
+    /** Source URL for the background `<video>`. Plays muted, autoplay, looped, inline. */
+    videoUrl: string;
+    /** Poster image URL shown before the video loads and on browsers that block autoplay. */
+    posterUrl: string;
+    /** Static heading. White, bold, large. */
+    title: string;
+    /**
+     * Subtitle phrases that cycle via a typewriter effect — each one types in,
+     * pauses, then erases before the next begins. Pass a single-element array to
+     * effectively get a static (non-cycling) subtitle.
+     */
+    cyclingPhrases: string[];
+    /** Optional fine-tuning of the typewriter timings. */
+    typewriter?: HomeHeroTypewriterOptions;
+    /**
+     * Brand rating badges shown in the bottom strip. Provide 0–N entries; the
+     * strip is hidden when empty.
+     */
+    reviews?: HomeHeroReview[];
+}
+
+declare const HomeHero: react.ForwardRefExoticComponent<HomeHeroProps & react.RefAttributes<HTMLElement>>;
+
 interface NavLink {
     label: string;
     href: string;
@@ -430,6 +519,12 @@ interface NavbarProps extends HTMLAttributes<HTMLElement> {
     phoneNumber?: string | undefined;
     phoneIcon?: ReactNode;
     LinkComponent?: ElementType | undefined;
+    /**
+     * Whether the navbar sticks to the top of the viewport on scroll.
+     * Defaults to `true`. Set to `false` when composing the navbar inside a
+     * shared sticky parent (e.g. `SiteHeader`).
+     */
+    sticky?: boolean | undefined;
 }
 
 declare const Navbar: react.ForwardRefExoticComponent<NavbarProps & react.RefAttributes<HTMLElement>>;
@@ -440,10 +535,7 @@ interface OfficesSectionProps extends HTMLAttributes<HTMLElement> {
     locations: LocationItem[];
 }
 
-declare const OfficesSection: {
-    ({ heading, subheading, locations, ...rest }: OfficesSectionProps): react_jsx_runtime.JSX.Element;
-    displayName: string;
-};
+declare const OfficesSection: react.ForwardRefExoticComponent<OfficesSectionProps & react.RefAttributes<HTMLElement>>;
 
 interface PackageItem {
     image: string;
@@ -469,16 +561,33 @@ interface PackagesCarouselProps extends HTMLAttributes<HTMLElement> {
 
 declare const PackagesCarousel: react.ForwardRefExoticComponent<PackagesCarouselProps & react.RefAttributes<HTMLElement>>;
 
+/**
+ * Stacked-navbar shell. Renders {@link Navbar} (hidden on mobile) above
+ * {@link CategoryNavbar}; the outer wrapper is the only sticky element so the
+ * two children stack together on scroll instead of overlapping.
+ *
+ * Pass props to each child via `navbar` / `categoryNavbar`. The `sticky` field
+ * on those nested props is ignored — it's controlled by this component.
+ */
+interface SiteHeaderProps extends HTMLAttributes<HTMLDivElement> {
+    navbar: Omit<NavbarProps, 'sticky'>;
+    categoryNavbar: Omit<CategoryNavbarProps, 'sticky'>;
+    /**
+     * Whether the outer `<header>` itself sticks to the top of the viewport on
+     * scroll. Defaults to `true`.
+     */
+    sticky?: boolean | undefined;
+}
+
+declare const SiteHeader: react.ForwardRefExoticComponent<SiteHeaderProps & react.RefAttributes<HTMLDivElement>>;
+
 interface TeamSectionProps extends HTMLAttributes<HTMLElement> {
     heading: string;
     subheading?: string;
     members: TeamMember[];
 }
 
-declare const TeamSection: {
-    ({ heading, subheading, members, ...rest }: TeamSectionProps): react_jsx_runtime.JSX.Element;
-    displayName: string;
-};
+declare const TeamSection: react.ForwardRefExoticComponent<TeamSectionProps & react.RefAttributes<HTMLElement>>;
 
 interface TestimonialItem {
     thumbnail: string;
@@ -536,10 +645,7 @@ interface ValuesSectionProps extends HTMLAttributes<HTMLElement> {
     singleOpen?: boolean;
 }
 
-declare const ValuesSection: {
-    ({ heading, subheading, values, singleOpen, ...rest }: ValuesSectionProps): react_jsx_runtime.JSX.Element;
-    displayName: string;
-};
+declare const ValuesSection: react.ForwardRefExoticComponent<ValuesSectionProps & react.RefAttributes<HTMLElement>>;
 
 interface WarriorsSectionProps extends HTMLAttributes<HTMLElement> {
     heading: string;
@@ -547,16 +653,12 @@ interface WarriorsSectionProps extends HTMLAttributes<HTMLElement> {
     warriors: Warrior[];
 }
 
-declare const WarriorsSection: {
-    ({ heading, subheading, warriors, ...rest }: WarriorsSectionProps): react_jsx_runtime.JSX.Element;
-    displayName: string;
-};
+declare const WarriorsSection: react.ForwardRefExoticComponent<WarriorsSectionProps & react.RefAttributes<HTMLElement>>;
 
 interface WhyChooseFeature {
-    title: string;
-    description: string;
-    illustration: string;
-    illustrationAlt?: string | undefined;
+    heading: string;
+    description?: string | undefined;
+    imageUrl?: string | undefined;
 }
 interface WhyChooseSectionProps extends HTMLAttributes<HTMLElement> {
     heading: string;
@@ -566,13 +668,6 @@ interface WhyChooseSectionProps extends HTMLAttributes<HTMLElement> {
 declare const WhyChooseSection: react.ForwardRefExoticComponent<WhyChooseSectionProps & react.RefAttributes<HTMLElement>>;
 
 declare const theme: {
-    readonly typography: {
-        readonly sectionHeading: styled_components.RuleSet<object>;
-        readonly sectionSubheading: styled_components.RuleSet<object>;
-        readonly cardTitle: styled_components.RuleSet<object>;
-        readonly cardBody: styled_components.RuleSet<object>;
-        readonly cardLabel: styled_components.RuleSet<object>;
-    };
     readonly layout: {
         readonly sectionPadding: "32px 24px";
         readonly cardPadding: "24px";
@@ -628,4 +723,4 @@ declare const theme: {
 };
 type Theme = typeof theme;
 
-export { BottomNav, type BottomNavItem, type BottomNavProps, type Brand, BrandLogo, type BrandLogoProps, BrandsSection, type BrandsSectionProps, CategoryNavbar, type CategoryNavbarProps, ContactForm, type ContactFormCountryCode, type ContactFormDestination, type ContactFormProps, type ContactFormValues, ContactSection, type ContactSectionProps, CtaBanner, type CtaBannerCta, type CtaBannerProps, DestinationCard, type DestinationCardProps, type DestinationItem, DestinationsSection, type DestinationsSectionProps, EventBanner, type EventBannerProps, EventCarousel, type EventCarouselItem, type EventCarouselProps, ExpandableValueCard, type ExpandableValueCardProps, ExploreCard, type ExploreCardProps, type ExploreItem, ExploreSection, type ExploreSectionProps, FaqExpandable, type FaqExpandableProps, type FaqItem, FaqSection, type FaqSectionProps, FeatureCard, type FeatureCardProps, Footer, type FooterColumn, type FooterContact, type FooterLink, type FooterProps, type FooterSocialLink, GalleryPhoto, type GalleryPhotoData, type GalleryPhotoProps, GallerySection, type GallerySectionProps, Hero, type HeroProps, type HeroReview, type HeroVariant, LocationCard, type LocationCardProps, type LocationItem, type MonthTab, MonthTabs, type MonthTabsProps, type NavCategory, type NavCategoryItem, type NavLink, Navbar, type NavbarProps, OfficesSection, type OfficesSectionProps, PackageCard, type PackageCardProps, type PackageItem, PackagesCarousel, type PackagesCarouselProps, SectionHeader, type SectionHeaderAlign, type SectionHeaderProps, TeamInfoCard, type TeamInfoCardProps, type TeamMember, TeamSection, type TeamSectionProps, type TeamSocialLink, TestimonialCard, type TestimonialCardProps, type TestimonialItem, TestimonialsCarousel, type TestimonialsCarouselProps, TextSection, type TextSectionAlign, type TextSectionProps, type Theme, TripCategoryCard, type TripCategoryCardProps, type TripsCategoryItem, TripsCategorySection, type TripsCategorySectionCta, type TripsCategorySectionProps, type ValueItem, ValuesSection, type ValuesSectionProps, type Warrior, WarriorCard, type WarriorCardProps, WarriorsSection, type WarriorsSectionProps, type WhyChooseFeature, WhyChooseSection, type WhyChooseSectionProps, theme };
+export { BottomNav, type BottomNavItem, type BottomNavProps, type Brand, BrandLogo, type BrandLogoProps, BrandsSection, type BrandsSectionProps, CategoryNavbar, type CategoryNavbarProps, ContactForm, type ContactFormCountryCode, type ContactFormDestination, type ContactFormProps, type ContactFormValues, ContactSection, type ContactSectionProps, CtaBanner, type CtaBannerCta, type CtaBannerProps, DestinationCard, type DestinationCardProps, type DestinationItem, DestinationsSection, type DestinationsSectionProps, EventBanner, type EventBannerProps, EventCarousel, type EventCarouselImageItem, type EventCarouselProps, type EventCarouselVideoItem, EventVideoBanner, type EventVideoBannerProps, ExpandableValueCard, type ExpandableValueCardProps, ExploreCard, type ExploreCardProps, type ExploreItem, ExploreSection, type ExploreSectionProps, FaqExpandable, type FaqExpandableProps, type FaqItem, FaqSection, type FaqSectionProps, FeatureCard, type FeatureCardProps, Footer, type FooterColumn, type FooterContact, type FooterLink, type FooterProps, type FooterSocialLink, GalleryPhoto, type GalleryPhotoData, type GalleryPhotoProps, GallerySection, type GallerySectionProps, Hero, type HeroProps, type HeroReview, type HeroVariant, HomeHero, type HomeHeroProps, type HomeHeroReview, type HomeHeroTypewriterOptions, LocationCard, type LocationCardProps, type LocationItem, type MonthTab, MonthTabs, type MonthTabsProps, type NavCategory, type NavCategoryItem, type NavLink, Navbar, type NavbarProps, OfficesSection, type OfficesSectionProps, PackageCard, type PackageCardProps, type PackageItem, PackagesCarousel, type PackagesCarouselProps, SectionHeader, type SectionHeaderAlign, type SectionHeaderProps, SiteHeader, type SiteHeaderProps, TeamInfoCard, type TeamInfoCardProps, type TeamMember, TeamSection, type TeamSectionProps, type TeamSocialLink, TestimonialCard, type TestimonialCardProps, type TestimonialItem, TestimonialsCarousel, type TestimonialsCarouselProps, TextSection, type TextSectionAlign, type TextSectionProps, type Theme, TripCategoryCard, type TripCategoryCardProps, type TripsCategoryItem, TripsCategorySection, type TripsCategorySectionCta, type TripsCategorySectionProps, type ValueItem, ValuesSection, type ValuesSectionProps, type Warrior, WarriorCard, type WarriorCardProps, WarriorsSection, type WarriorsSectionProps, type WhyChooseFeature, WhyChooseSection, type WhyChooseSectionProps, theme };