@pantheon-systems/pds-toolkit-react 1.0.0-dev.185 → 1.0.0-dev.186

package/_dist/components/footer/SiteFooter/SiteFooter.d.ts

@@ -1,18 +1,26 @@
-export function SiteFooter({ containerWidth, children, legalLinks, className, ...props }: {
-    [x: string]: any;
-    containerWidth?: string;
-    children: any;
-    legalLinks?: string[];
-    className: any;
-}): React.JSX.Element;
-export namespace SiteFooter {
-    namespace propTypes {
-        export { ContainerWidth as containerWidth };
-        export let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        export let legalLinks: PropTypes.Requireable<string[]>;
-        export let className: PropTypes.Requireable<string>;
-    }
+import React, { ComponentPropsWithoutRef } from 'react';
+import { ContainerWidth } from '@libs/types/custom-types';
+import './site-footer.css';
+interface SiteFooterProps extends ComponentPropsWithoutRef<'footer'> {
+    /**
+     * PDS container width.
+     */
+    containerWidth?: ContainerWidth;
+    /**
+     * Footer content.
+     */
+    children?: React.ReactNode;
+    /**
+     * Legal policy links.
+     */
+    legalLinks?: Array<'privacy' | 'dataSubjectRequest' | 'cookiePolicy' | 'termsOfUse' | 'acceptableUse' | 'accessibilityStatement'>;
+    /**
+     * Additional class names
+     */
+    className?: string;
 }
-import React from 'react';
-import { ContainerWidth } from '@libs/components/customPropTypes';
-import PropTypes from 'prop-types';
+/**
+ * SiteFooter UI component
+ */
+export declare const SiteFooter: ({ containerWidth, children, legalLinks, className, ...props }: SiteFooterProps) => React.JSX.Element;
+export {};

package/_dist/components/footer/SiteFooter/footer-content.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const docsFooterContent: React.JSX.Element;

package/_dist/components/inputs/Combobox/Combobox.d.ts

@@ -2,10 +2,10 @@ import React, { ChangeEvent, ComponentPropsWithoutRef, FocusEvent, ReactNode } f
 import { ValidationStatus } from '../input-types';
 import './combobox.css';
 type LabelStrings = {
-    clearButton: string;
-    inputInstructions: string;
-    searchShortcut: string;
-    triggerButton: string;
+    clearButton?: string;
+    inputInstructions?: string;
+    searchShortcut?: string;
+    triggerButton?: string;
 };
 export type ComboboxOption = {
     label: string;

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

@@ -1,69 +1,70 @@
-export function DashboardSearch({ disabled, id, isLoading, label, labelStrings, loadingText, noResultsText, onFocus, onOptionSelect, placeholder, siteList, horizontalOffset, className, ...props }: {
-    [x: string]: any;
+import React, { ComponentPropsWithoutRef } from 'react';
+import { SiteOption } from './SiteOptionDisplay';
+import './dashboard-search.css';
+type LabelStrings = {
+    clearButton?: string;
+    inputInstructions?: string;
+    openSearchButton?: string;
+};
+/**
+ * Prop types for DashboardSearch
+ */
+export interface DashboardSearchProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Is the search input disabled?
+     */
     disabled?: boolean;
-    id: any;
+    /**
+     * ID for the component.
+     */
+    id?: string;
+    /**
+     * Is the site data still loading?
+     */
     isLoading?: boolean;
+    /**
+     * Label for the input. Will be rendered as an aria-label.
+     */
     label?: string;
-    labelStrings?: {
-        clearButton: string;
-        inputInstructions: string;
-        openSearchButton: string;
-    };
+    /**
+     * Translation strings for various labels or other visually-hidden text.
+     */
+    labelStrings?: LabelStrings;
+    /**
+     * Text to display when site options are still loading.
+     */
     loadingText?: string;
+    /**
+     * Text to display when no results are found.
+     */
     noResultsText?: string;
-    onFocus: any;
-    onOptionSelect: any;
+    /**
+     * Optional callback function when the search input field is focused.
+     */
+    onFocus?: () => void;
+    /**
+     * Callback when an option is selected. Returns the selected option object.
+     */
+    onOptionSelect?: (option: SiteOption) => void;
+    /**
+     * Optional placeholder text to display when the input field is empty.
+     */
     placeholder?: string;
-    siteList: any;
+    /**
+     * Array of sites to search through.
+     */
+    siteList?: SiteOption[];
+    /**
+     * Offset for the starting right position for the search input in rems.
+     */
     horizontalOffset?: number;
-    className: any;
-}): React.JSX.Element;
-export namespace DashboardSearch {
-    namespace propTypes {
-        let disabled: PropTypes.Requireable<boolean>;
-        let id: PropTypes.Requireable<string>;
-        let isLoading: PropTypes.Requireable<boolean>;
-        let label: PropTypes.Requireable<string>;
-        let labelStrings: PropTypes.Requireable<PropTypes.InferProps<{
-            /**
-             * Clear button label
-             */
-            clearButton: PropTypes.Requireable<string>;
-            /**
-             * Input instructions
-             */
-            inputInstructions: PropTypes.Requireable<string>;
-            /**
-             * Open search button label
-             */
-            openSearchButton: PropTypes.Requireable<string>;
-        }>>;
-        let loadingText: PropTypes.Requireable<string>;
-        let noResultsText: PropTypes.Requireable<string>;
-        let onFocus: PropTypes.Requireable<(...args: any[]) => any>;
-        let onOptionSelect: PropTypes.Requireable<(...args: any[]) => any>;
-        let placeholder: PropTypes.Requireable<string>;
-        let siteList: PropTypes.Requireable<PropTypes.InferProps<{
-            /**
-             * Site ID
-             */
-            id: PropTypes.Requireable<string>;
-            /**
-             * Site name.
-             */
-            name: PropTypes.Requireable<string>;
-            /**
-             * Site status
-             */
-            status: PropTypes.Requireable<string>;
-            /**
-             * Site type
-             */
-            type: PropTypes.Requireable<string>;
-        }>[]>;
-        let horizontalOffset: PropTypes.Requireable<number>;
-        let className: PropTypes.Requireable<string>;
-    }
+    /**
+     * Additional class names
+     */
+    className?: string;
 }
-import React from 'react';
-import PropTypes from 'prop-types';
+/**
+ * DashboardSearch UI component
+ */
+export declare const DashboardSearch: ({ disabled, id, isLoading, label, labelStrings, loadingText, noResultsText, onFocus, onOptionSelect, placeholder, siteList, horizontalOffset, className, ...props }: DashboardSearchProps) => React.JSX.Element;
+export {};

package/_dist/components/navigation/DashboardSearch/SiteOptionDisplay.d.ts

@@ -1,10 +1,34 @@
-export function SiteOptionDisplay({ option }: {
-    option: any;
-}): React.JSX.Element;
-export namespace SiteOptionDisplay {
-    namespace propTypes {
-        let option: PropTypes.Requireable<object>;
-    }
+import React, { ComponentPropsWithoutRef } from 'react';
+export type SiteOption = {
+    /**
+     * Machine name of the site.
+     */
+    machineName?: string;
+    /**
+     * Name of the site.
+     */
+    name: string;
+    /**
+     * Site active status.
+     */
+    status?: 'active' | 'frozen';
+    /**
+     * Site type.
+     */
+    type?: 'drupal' | 'wordpress' | 'gatsby' | 'nextjs';
+};
+/** Site option display props. */
+export interface SiteOptionDisplayProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Site option to display.
+     */
+    option: SiteOption;
+    /**
+     * Additional class names
+     */
+    className?: string;
 }
-import React from 'react';
-import PropTypes from 'prop-types';
+/**
+ * UI component to display site options.
+ */
+export declare const SiteOptionDisplay: ({ option, className, ...props }: SiteOptionDisplayProps) => React.JSX.Element;

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

@@ -0,0 +1,43 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import { PDSIcon } from '@components/Icon/Icon';
+import { TabMenuDropdownProps } from './TabMenuDropdown';
+import { NavigationItem } from '@components/navigation/navigation-types';
+import './tab-menu.css';
+type DropdownSettings = Omit<TabMenuDropdownProps, 'links'>;
+export type TabMenuItemProps = NavigationItem & {
+    /**
+     * Settings for dropdown menu. Leave null if no dropdown is needed.
+     */
+    dropdownSettings?: DropdownSettings;
+    /**
+     * Icon to display next to the link content.
+     */
+    icon?: PDSIcon;
+    /**
+     * Promote active child link to the top level.
+     * If true, the top-level menu will display the active child link instead of the parent link. If using this approach, it is recommended to also include the parent link as the first child link.
+     */
+    promoteActiveChildLink?: boolean;
+};
+/**
+ * Prop types for TabMenu.
+ */
+export interface TabMenuProps extends ComponentPropsWithoutRef<'nav'> {
+    /**
+     * Aria label for the navigation.
+     */
+    ariaLabel: string;
+    /**
+     * Menu items to render.
+     */
+    menuItems?: TabMenuItemProps[];
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * TabMenu UI component.
+ */
+export declare const TabMenu: ({ ariaLabel, menuItems, className, ...props }: TabMenuProps) => React.JSX.Element;
+export {};

package/_dist/components/navigation/TabMenu/TabMenuDropdown.d.ts

@@ -0,0 +1,33 @@
+import React from 'react';
+import { NavigationItem } from '@components/navigation/navigation-types';
+import './tab-menu.css';
+export type TabMenuDropdownProps = {
+    /**
+     * Button label for the dropdown trigger.
+     */
+    buttonLabel?: string;
+    /**
+     * Label for the dropdown filter. Leave null if no filter is needed.
+     */
+    filterLabel?: string;
+    /**
+     * Placeholder for the dropdown filter.
+     */
+    filterPlaceholder?: string;
+    /**
+     * Links to display in the dropdown.
+     */
+    links?: NavigationItem[];
+    /**
+     * Minimum number of items to enable filtering.
+     */
+    minFilterItems?: number;
+    /**
+     * Text to display when no results are found.
+     */
+    noResultsText?: string;
+};
+/**
+ * TabMenuDropdown UI component
+ */
+export declare const TabMenuDropdown: ({ buttonLabel, filterLabel, filterPlaceholder, links, minFilterItems, noResultsText, }: TabMenuDropdownProps) => React.JSX.Element;

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

@@ -13,16 +13,6 @@ export type NavigationItem = {
      */
     links?: NavigationItem[];
 };
-export type SingleLevelNavigationItem = {
-    /**
-     * A boolean indicating whether the item is the active item.
-     */
-    isActive?: boolean;
-    /**
-     * Link content — a fully-formed link element using the router of your choice.
-     */
-    linkContent: JSX.Element;
-};
 export type FlattenedNavigationItem = {
     /**
      * A boolean indicating whether the item is the active item.