@arc-ui/community-components 3.3.0 → 3.4.0

package/lib/index.d.cts

@@ -14,6 +14,7 @@ import { InformationCardProps } from '@arc-ui/components/InformationCard';
 import { TypographyCardProps } from '@arc-ui/components/TypographyCard';
 import { TemplateBannerProps } from '@arc-ui/components/TemplateBanner';
 import { TagProps } from '@arc-ui/components/Tag';
+import { ReactPlayerProps } from 'react-player/types';
 
 interface AccordionHeadingProps {
     /**
@@ -649,5 +650,57 @@ interface PromoListingThumbnailSignpostProps extends SectionHeadingProps {
     thumbnailList: ThumbnailSignpostProps[];
 }
 
-export { Accordion, ActionTile, ArticleSidebar, Author, BannerWithTabs, ContentInfoWidget, CopyLead, DownloadList, FAQs, FeaturePost, Highlights, InlineLinkGroup, LinkTile, ProductNavigation, PromoListing, PromoListingThumbnailSignpost, Quote, SectionHeading, Statistics, Summary, ThumbnailSignpost };
-export type { AccordionProps, ActionTileProps, ArticleSidebarProps, AuthorProps, BannerWithTabsProps, ContentInfoWidgetProps, CopyLeadProps, DownloadListProps, FAQsProps, FeaturePostProps, HighlightsProps, InlineLinkGroupItem, InlineLinkGroupProps, LinkTileProps, ListProps, ProductNavigationProps, PromoListingProps, PromoListingThumbnailSignpostProps, QuoteProps, SectionHeadingProps, StatisticsProps, SummaryProps, ThumbnailSignpostProps };
+type PlayerProps = Pick<ReactPlayerProps, "onReady" | "onPlay" | "onStart" | "onPause" | "onEnded" | "onError" | "src">;
+
+interface VideoCardPlayerProps {
+    player: PlayerProps;
+    orientation: "portrait" | "landscape";
+    playIconSize: "s" | "l";
+    thumbnail?: ReactPlayerProps["light"];
+    children?: React$1.ReactNode;
+}
+
+interface VideoHeroCardContentProps {
+    title: string;
+    label: string;
+    description: string | ReactNode;
+    background: "dark" | "light";
+    videoDate?: string;
+    duration?: string;
+    subtitleAvailabilityText?: string;
+}
+
+declare const VideoHeroCard: ({ content, thumbnailImg, player, ...props }: VideoHeroCardProps) => JSX.Element;
+interface VideoHeroCardProps {
+    /**
+     * Content for the video card.
+     */
+    content: Omit<VideoHeroCardContentProps, "background">;
+    /**
+     * Thumbnail for the video hero card.
+     */
+    thumbnailImg: string;
+    /**
+     * Configuration for the video player.
+     */
+    player: VideoCardPlayerProps["player"];
+}
+
+declare const VideoPortraitCard: ({ thumbnail, player, ...props }: VideoPortraitCardProps) => JSX.Element;
+interface VideoPortraitCardProps {
+    /**
+     * Thumbnail content, video will autoplay if omitted.
+     */
+    thumbnail?: {
+        title: string;
+        label: string;
+        img: string;
+    };
+    /**
+     * Configuration for the video player.
+     */
+    player: VideoCardPlayerProps["player"];
+}
+
+export { Accordion, ActionTile, ArticleSidebar, Author, BannerWithTabs, ContentInfoWidget, CopyLead, DownloadList, FAQs, FeaturePost, Highlights, InlineLinkGroup, LinkTile, ProductNavigation, PromoListing, PromoListingThumbnailSignpost, Quote, SectionHeading, Statistics, Summary, ThumbnailSignpost, VideoHeroCard, VideoPortraitCard };
+export type { AccordionProps, ActionTileProps, ArticleSidebarProps, AuthorProps, BannerWithTabsProps, ContentInfoWidgetProps, CopyLeadProps, DownloadListProps, FAQsProps, FeaturePostProps, HighlightsProps, InlineLinkGroupItem, InlineLinkGroupProps, LinkTileProps, ListProps, ProductNavigationProps, PromoListingProps, PromoListingThumbnailSignpostProps, QuoteProps, SectionHeadingProps, StatisticsProps, SummaryProps, ThumbnailSignpostProps, VideoHeroCardProps, VideoPortraitCardProps };

package/lib/index.d.mts

@@ -14,6 +14,7 @@ import { InformationCardProps } from '@arc-ui/components/InformationCard';
 import { TypographyCardProps } from '@arc-ui/components/TypographyCard';
 import { TemplateBannerProps } from '@arc-ui/components/TemplateBanner';
 import { TagProps } from '@arc-ui/components/Tag';
+import { ReactPlayerProps } from 'react-player/types';
 
 interface AccordionHeadingProps {
     /**
@@ -649,5 +650,57 @@ interface PromoListingThumbnailSignpostProps extends SectionHeadingProps {
     thumbnailList: ThumbnailSignpostProps[];
 }
 
-export { Accordion, ActionTile, ArticleSidebar, Author, BannerWithTabs, ContentInfoWidget, CopyLead, DownloadList, FAQs, FeaturePost, Highlights, InlineLinkGroup, LinkTile, ProductNavigation, PromoListing, PromoListingThumbnailSignpost, Quote, SectionHeading, Statistics, Summary, ThumbnailSignpost };
-export type { AccordionProps, ActionTileProps, ArticleSidebarProps, AuthorProps, BannerWithTabsProps, ContentInfoWidgetProps, CopyLeadProps, DownloadListProps, FAQsProps, FeaturePostProps, HighlightsProps, InlineLinkGroupItem, InlineLinkGroupProps, LinkTileProps, ListProps, ProductNavigationProps, PromoListingProps, PromoListingThumbnailSignpostProps, QuoteProps, SectionHeadingProps, StatisticsProps, SummaryProps, ThumbnailSignpostProps };
+type PlayerProps = Pick<ReactPlayerProps, "onReady" | "onPlay" | "onStart" | "onPause" | "onEnded" | "onError" | "src">;
+
+interface VideoCardPlayerProps {
+    player: PlayerProps;
+    orientation: "portrait" | "landscape";
+    playIconSize: "s" | "l";
+    thumbnail?: ReactPlayerProps["light"];
+    children?: React$1.ReactNode;
+}
+
+interface VideoHeroCardContentProps {
+    title: string;
+    label: string;
+    description: string | ReactNode;
+    background: "dark" | "light";
+    videoDate?: string;
+    duration?: string;
+    subtitleAvailabilityText?: string;
+}
+
+declare const VideoHeroCard: ({ content, thumbnailImg, player, ...props }: VideoHeroCardProps) => JSX.Element;
+interface VideoHeroCardProps {
+    /**
+     * Content for the video card.
+     */
+    content: Omit<VideoHeroCardContentProps, "background">;
+    /**
+     * Thumbnail for the video hero card.
+     */
+    thumbnailImg: string;
+    /**
+     * Configuration for the video player.
+     */
+    player: VideoCardPlayerProps["player"];
+}
+
+declare const VideoPortraitCard: ({ thumbnail, player, ...props }: VideoPortraitCardProps) => JSX.Element;
+interface VideoPortraitCardProps {
+    /**
+     * Thumbnail content, video will autoplay if omitted.
+     */
+    thumbnail?: {
+        title: string;
+        label: string;
+        img: string;
+    };
+    /**
+     * Configuration for the video player.
+     */
+    player: VideoCardPlayerProps["player"];
+}
+
+export { Accordion, ActionTile, ArticleSidebar, Author, BannerWithTabs, ContentInfoWidget, CopyLead, DownloadList, FAQs, FeaturePost, Highlights, InlineLinkGroup, LinkTile, ProductNavigation, PromoListing, PromoListingThumbnailSignpost, Quote, SectionHeading, Statistics, Summary, ThumbnailSignpost, VideoHeroCard, VideoPortraitCard };
+export type { AccordionProps, ActionTileProps, ArticleSidebarProps, AuthorProps, BannerWithTabsProps, ContentInfoWidgetProps, CopyLeadProps, DownloadListProps, FAQsProps, FeaturePostProps, HighlightsProps, InlineLinkGroupItem, InlineLinkGroupProps, LinkTileProps, ListProps, ProductNavigationProps, PromoListingProps, PromoListingThumbnailSignpostProps, QuoteProps, SectionHeadingProps, StatisticsProps, SummaryProps, ThumbnailSignpostProps, VideoHeroCardProps, VideoPortraitCardProps };