@pantheon-systems/pds-toolkit-react 1.0.0-dev.274 → 1.0.0-dev.275

package/_dist/components/VideoEmbed/VideoEmbed.d.ts

@@ -7,11 +7,16 @@ export interface VideoEmbedProps extends ComponentPropsWithoutRef<'div'> {
     /**
      * Video hosting platform.
      */
-    platform?: 'youtube' | 'vimeo';
+    platform: 'vimeo' | 'wistia' | 'youtube';
     /**
      * Video ID to embed.
      */
     videoId: string;
+    /**
+     * Video title to display. This is for the title prop on the video iframe.
+     * If none is provided it will default to `"[platform] video player"`
+     */
+    videoTitle?: string;
     /**
      * Additional class names
      */
@@ -20,4 +25,4 @@ export interface VideoEmbedProps extends ComponentPropsWithoutRef<'div'> {
 /**
  * VideoEmbed UI component
  */
-export declare const VideoEmbed: ({ platform, videoId, className, ...props }: VideoEmbedProps) => React.JSX.Element;
+export declare const VideoEmbed: ({ platform, videoId, videoTitle, className, ...props }: VideoEmbedProps) => React.JSX.Element;

package/_dist/components/navigation/SideNav/SideNav.d.ts

@@ -9,10 +9,6 @@ export interface SideNavProps extends ComponentPropsWithoutRef<'nav'> {
      * Aria label for the navigation.
      */
     ariaLabel: string;
-    /**
-     * Whether the menu should be rendered as a mobile menu when the viewport is at or below the mobileMenuMaxWidth.
-     */
-    hasMobileMenu?: boolean;
     /**
      * Heading text. If a link is passed, it will be rendered as a link.
      */
@@ -28,10 +24,6 @@ export interface SideNavProps extends ComponentPropsWithoutRef<'nav'> {
      * Menu items to render.
      */
     menuItems: NavigationItem[];
-    /**
-     *  Mobile menu will be enabled when viewport is at or below this number in pixels.
-     */
-    mobileMenuMaxWidth?: number;
     /**
      * Text to display in the mobile menu trigger button when no active link is found.
      */
@@ -44,4 +36,4 @@ export interface SideNavProps extends ComponentPropsWithoutRef<'nav'> {
 /**
  * SideNav UI component
  */
-export declare const SideNav: ({ ariaLabel, hasMobileMenu, headingText, labels, menuItems, mobileMenuMaxWidth, mobileMenuSelectTextFallback, className, ...props }: SideNavProps) => React.JSX.Element;
+export declare const SideNav: ({ ariaLabel, headingText, labels, menuItems, mobileMenuSelectTextFallback, className, ...props }: SideNavProps) => React.JSX.Element;

package/_dist/components/navigation/navigation-utilities.d.ts

@@ -1,9 +1,90 @@
-import React, { ReactElement } from 'react';
+import React, { ReactElement, ReactNode } from 'react';
 import { PDSIcon } from '@components/icons/Icon/Icon';
 import { NavigationItem } from '@components/navigation/navigation-types';
-export declare const isActiveItem: (item: NavigationItem) => boolean;
-export declare const isActiveTrail: (item: NavigationItem) => boolean;
+/**
+ * Recursively searches through navigation items to find the first active link
+ * @param items - Array of navigation items to search through
+ * @returns The active link element, or null if no active link is found or if the active item is a string
+ * @example
+ * const activeLink = getActiveLink(menuItems);
+ */
 export declare const getActiveLink: (items: NavigationItem[]) => ReactElement | null;
+/**
+ * Extracts a string representation from linkContent, whether it's a string or React element
+ * @param linkContent - The link content to extract string from (string or React element)
+ * @returns String representation of the link content
+ * @example
+ * const linkText = getLinkContentString(<Link>Home</Link>); // Returns "Home"
+ * const linkText = getLinkContentString("About"); // Returns "About"
+ */
 export declare const getLinkContentString: (linkContent: ReactElement | string) => string;
+/**
+ * Determines if a navigation item is currently active
+ * @param item - The navigation item to check
+ * @returns True if the item is active, false otherwise
+ * @description Checks for active state via:
+ * - The `isActive` property on the item
+ * - The presence of 'pds-isActive' class on the link element
+ * - Returns false for string-based items
+ * @example
+ * const isActive = isActiveItem(navigationItem);
+ */
+export declare const isActiveItem: (item: NavigationItem) => boolean;
+/**
+ * Determines if a navigation item or any of its children are in the active trail
+ * @param item - The navigation item to check (including its children)
+ * @returns True if the item or any child is active, false otherwise
+ * @description Recursively checks the item and all child items for active state
+ * @example
+ * const inActiveTrail = isActiveTrail(parentItem); // True if parent or any child is active
+ */
+export declare const isActiveTrail: (item: NavigationItem) => boolean;
+/**
+ * Checks if the provided content is an interactive element (link, button, etc.)
+ * @param content - The React content to examine
+ * @returns True if the content is an interactive element, false otherwise
+ * @description Currently detects:
+ * - Native anchor elements (`<a>`)
+ * - React Router Link components (by displayName)
+ * @example
+ * const isInteractive = isInteractiveElement(<Link to="/home">Home</Link>); // true
+ * const isInteractive = isInteractiveElement(<span>Label</span>); // false
+ * const isInteractive = isInteractiveElement("Plain text"); // false
+ */
+export declare const isInteractiveElement: (content: ReactNode) => boolean;
+/**
+ * Processes navigation link content based on its type and available child links
+ * @param linkContent - The link content to process (string or React element)
+ * @param links - Optional array of child navigation items
+ * @returns Processed link content
+ * @description
+ * - If linkContent is a string and child links exist, clones the first child link with the string as label
+ * - Otherwise returns the linkContent as-is
+ * @example
+ * // With string and child links - uses first child as template
+ * const processed = processNavLinkContent("Home", [{ linkContent: <Link to="/home" /> }]);
+ *
+ * // With React element - returns as-is
+ * const processed = processNavLinkContent(<Link to="/about">About</Link>);
+ */
 export declare const processNavLinkContent: (linkContent: ReactElement | string, links?: NavigationItem[]) => ReactElement | string;
+/**
+ * Processes side navigation global items with optional icons and specialized markup structure
+ * @param baseClass - Base CSS class for styling
+ * @param linkContent - The link content to process (string or React element)
+ * @param links - Optional array of child navigation items
+ * @param icon - Optional PDS icon to include
+ * @returns Processed navigation item with icon and proper markup structure, or null
+ * @description
+ * Creates a structured navigation item with:
+ * - Icon support with proper CSS classes
+ * - Consistent markup structure for global navigation
+ * - Template behavior for string content with child links
+ * @example
+ * // String with icon and child links
+ * const item = processSideNavGlobalLinkContent('nav', 'Home', childLinks, 'home');
+ *
+ * // React element with icon
+ * const item = processSideNavGlobalLinkContent('nav', <Link to="/about">About</Link>, null, 'info');
+ */
 export declare const processSideNavGlobalLinkContent: (baseClass: string, linkContent: ReactElement | string, links?: NavigationItem[], icon?: PDSIcon) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;

package/_dist/css/component-css/pds-empty-state-card.css

@@ -1 +1 @@
-.pds-empty-state-card{background-color:var(--pds-color-card-background);border-radius:.375rem;box-shadow:var(--pds-elevation-raised);color:var(--pds-color-foreground-default);display:flex;flex-direction:column;justify-content:space-between;padding:1.563rem}.pds-empty-state-card__cta{display:inline-block;margin-block-start:.512rem}
+.pds-empty-state-card{background-color:var(--pds-color-card-background);border-radius:.375rem;box-shadow:var(--pds-elevation-raised);color:var(--pds-color-fg-default);display:flex;flex-direction:column;justify-content:space-between;padding:1.563rem}.pds-empty-state-card__cta{display:inline-block;margin-block-start:.512rem}