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

package/_dist/components/CTASlice/CTASlice.d.ts

@@ -1,34 +1,51 @@
-export function CTASlice({ backgroundColor, containerWidth, headingLevel, headingText, leadText, primaryLink, secondaryLink, className, ...props }: {
-    [x: string]: any;
-    backgroundColor?: string;
-    containerWidth?: string;
-    headingLevel?: string;
-    headingText: any;
-    leadText: any;
-    primaryLink: any;
-    secondaryLink: any;
-    className: any;
-}): React.JSX.Element;
-export namespace CTASlice {
-    namespace propTypes {
-        export let backgroundColor: PropTypes.Requireable<string>;
-        export { ContainerWidth as containerWidth };
-        export let headingLevel: PropTypes.Requireable<string>;
-        export let headingText: PropTypes.Validator<string>;
-        export let leadText: PropTypes.Requireable<string>;
-        export let primaryLink: PropTypes.Validator<NonNullable<PropTypes.InferProps<{
-            text: PropTypes.Requireable<string>;
-            url: PropTypes.Requireable<string>;
-            target: PropTypes.Requireable<string>;
-        }>>>;
-        export let secondaryLink: PropTypes.Requireable<PropTypes.InferProps<{
-            text: PropTypes.Requireable<string>;
-            url: PropTypes.Requireable<string>;
-            target: PropTypes.Requireable<string>;
-        }>>;
-        export let className: PropTypes.Requireable<string>;
-    }
+import React, { ComponentPropsWithoutRef } from 'react';
+import { ContainerWidth, HeadingLevel } from '@libs/types/custom-types';
+import './../buttons/Button/button.css';
+import './cta-slice.css';
+interface CTASliceProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Background color of slice
+     */
+    backgroundColor?: 'default' | 'secondary';
+    /**
+     * PDS container width.
+     */
+    containerWidth?: ContainerWidth;
+    /**
+     *  Heading level
+     */
+    headingLevel?: HeadingLevel;
+    /**
+     * Heading text
+     */
+    headingText: string;
+    /**
+     * Further explain block
+     */
+    leadText?: string;
+    /**
+     * Primary link.
+     */
+    primaryLink: {
+        text: string;
+        url: string;
+        target: '_self' | '_blank';
+    };
+    /**
+     * Optional secondary link
+     */
+    secondaryLink?: {
+        text: string;
+        url: string;
+        target: '_self' | '_blank';
+    };
+    /**
+     * Additional class names
+     */
+    className?: string;
 }
-import React from 'react';
-import PropTypes from 'prop-types';
-import { ContainerWidth } from '@libs/components/customPropTypes';
+/**
+ * CTA Slice UI component
+ */
+export declare const CTASlice: ({ backgroundColor, containerWidth, headingLevel, headingText, leadText, primaryLink, secondaryLink, className, ...props }: CTASliceProps) => React.JSX.Element;
+export {};

package/_dist/components/PlatformIcon/PlatformIcon.d.ts

@@ -1,13 +1,12 @@
-export function PlatformIcon({ platformType, className, ...props }: {
-    [x: string]: any;
-    platformType: any;
-    className: any;
-}): React.JSX.Element;
-export namespace PlatformIcon {
-    namespace propTypes {
-        let platformType: PropTypes.Requireable<string>;
-        let className: PropTypes.Requireable<string>;
-    }
+import React, { ComponentPropsWithoutRef } from 'react';
+import './platform-icon.css';
+type PlatformType = 'drupal' | 'drupal7' | 'front-end-sites' | 'gatsby' | 'gatsby-wp' | 'import-custom' | 'next' | 'next-drupal' | 'next-wp' | 'wordpress';
+interface PlatformIconProps extends ComponentPropsWithoutRef<'div'> {
+    platformType: PlatformType;
+    className?: string;
 }
-import React from 'react';
-import PropTypes from 'prop-types';
+/**
+ * PlatformIcon UI component
+ */
+export declare const PlatformIcon: ({ platformType, className, ...props }: PlatformIconProps) => React.JSX.Element;
+export {};

package/_dist/components/Stepper/Stepper.d.ts

@@ -1,46 +1,49 @@
-export function Stepper({ steps, translatableLabels, className, ...props }: {
-    [x: string]: any;
-    steps: any;
-    translatableLabels?: {
-        step: string;
-        completed: string;
-        hasError: string;
-        next: string;
-    };
-    className: any;
-}): React.JSX.Element;
-export namespace Stepper {
-    namespace propTypes {
-        let steps: PropTypes.Requireable<PropTypes.InferProps<{
-            /**
-             * Callback function to return to a previously completed step.
-             */
-            callback: PropTypes.Requireable<(...args: any[]) => any>;
-            /**
-             * If the step has an error.
-             */
-            hasError: PropTypes.Requireable<boolean>;
-            /**
-             * Id for the step.
-             */
-            id: PropTypes.Requireable<string>;
-            /**
-             * If the step is the current active step.
-             */
-            isCurrent: PropTypes.Requireable<boolean>;
-            /**
-             * The label for the step.
-             */
-            label: PropTypes.Validator<string>;
-        }>[]>;
-        let translatableLabels: PropTypes.Requireable<PropTypes.InferProps<{
-            step: PropTypes.Requireable<string>;
-            completed: PropTypes.Requireable<string>;
-            hasError: PropTypes.Requireable<string>;
-            next: PropTypes.Requireable<string>;
-        }>>;
-        let className: PropTypes.Requireable<string>;
-    }
+import React, { ComponentPropsWithoutRef } from 'react';
+import './stepper.css';
+interface Step {
+    /**
+     * Callback function to return to a previously completed step.
+     */
+    callback?: (step: Step) => void;
+    /**
+     * If the step has an error.
+     */
+    hasError?: boolean;
+    /**
+     * Id for the step.
+     */
+    id?: string;
+    /**
+     * If the step is the current active step.
+     */
+    isCurrent?: boolean;
+    /**
+     * The label for the step.
+     */
+    label: string;
 }
-import React from 'react';
-import PropTypes from 'prop-types';
+interface TranslatableLabels {
+    step: string;
+    completed: string;
+    hasError: string;
+    next: string;
+}
+interface StepperProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * An array of step objects
+     */
+    steps: Step[];
+    /**
+     * Translatable strings for visually-hidden text.
+     */
+    translatableLabels?: TranslatableLabels;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * Stepper UI component
+ */
+export declare const Stepper: ({ steps, translatableLabels, className, ...props }: StepperProps) => React.JSX.Element;
+export {};

package/_dist/components/cards/Card/Card.d.ts

@@ -1,30 +1,29 @@
-export function Card({ bodyText, headingLevel, headingText, image, isClickable, kickerText, primaryLink, secondaryLink, className, ...props }: {
-    [x: string]: any;
-    bodyText: any;
-    headingLevel?: string;
-    headingText: any;
-    image: any;
-    isClickable?: boolean;
-    kickerText: any;
-    primaryLink: any;
-    secondaryLink: any;
-    className: any;
-}): React.JSX.Element;
-export namespace Card {
-    namespace propTypes {
-        let bodyText: PropTypes.Requireable<NonNullable<PropTypes.ReactNodeLike>>;
-        let headingLevel: PropTypes.Requireable<string>;
-        let headingText: PropTypes.Validator<string>;
-        let image: PropTypes.Requireable<PropTypes.InferProps<{
-            src: PropTypes.Requireable<string>;
-            alt: PropTypes.Requireable<string>;
-        }>>;
-        let isClickable: PropTypes.Requireable<boolean>;
-        let kickerText: PropTypes.Requireable<string>;
-        let primaryLink: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
-        let secondaryLink: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        let className: PropTypes.Requireable<string>;
-    }
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import { GridGapOptions } from '@layouts/layout-types';
+import './card.css';
+export type CardBackground = 'default' | 'transparent';
+/**
+ * Prop types for Card
+ */
+export interface CardProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Background color or gradient for the card.
+     */
+    background?: CardBackground;
+    /**
+     * Child elements to be assigned to named slots.
+     */
+    children: ReactNode;
+    /**
+     * Relative padding for the `main` slot.
+     */
+    padding?: GridGapOptions;
+    /**
+     * Additional class names
+     */
+    className?: string;
 }
-import React from 'react';
-import PropTypes from 'prop-types';
+/**
+ * Card UI component
+ */
+export declare const Card: ({ background, children, padding, className, ...props }: CardProps) => React.JSX.Element;

package/_dist/components/cards/CardHeading/CardHeading.d.ts

@@ -0,0 +1,32 @@
+import React from 'react';
+import { HeadingLevel } from '@libs/types/custom-types';
+import './card-heading.css';
+/**
+ * Prop types for CardHeading
+ */
+export interface CardHeadingProps {
+    /**
+     * Font size of the heading. Default is `XL`.
+     */
+    fontSize?: 'L' | 'XL';
+    /**
+     * Font weight of the heading. Default is `bold`.
+     */
+    fontWeight?: 'bold' | 'semibold';
+    /**
+     *  Heading level or `span`.
+     */
+    level?: HeadingLevel;
+    /**
+     * Heading text.
+     */
+    text?: string;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * CardHeading UI component
+ */
+export declare const CardHeading: ({ fontSize, fontWeight, level, text, className, ...props }: CardHeadingProps) => React.JSX.Element;

package/_dist/components/cards/SiteCard/SiteCard.d.ts

@@ -1,25 +1,45 @@
-export function SiteCard({ headingLevel, gotoText, siteImage, siteLink, siteName, sitePlan, siteStatus, className, ...props }: {
-    [x: string]: any;
-    headingLevel?: string;
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import { HeadingLevel } from '@libs/types/custom-types';
+import { SiteStatus } from '@libs/types/custom-types';
+import './site-card.css';
+/**
+ * Prop types for SiteCard
+ */
+export interface SiteCardProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Translatable text for the "Go to" link.
+     */
     gotoText?: string;
-    siteImage: any;
-    siteLink: any;
-    siteName: any;
-    sitePlan: any;
-    siteStatus: any;
-    className: any;
-}): React.JSX.Element;
-export namespace SiteCard {
-    namespace propTypes {
-        let headingLevel: PropTypes.Requireable<string>;
-        let gotoText: PropTypes.Requireable<string>;
-        let siteImage: PropTypes.Requireable<string>;
-        let siteLink: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
-        let siteName: PropTypes.Requireable<string>;
-        let sitePlan: PropTypes.Requireable<string>;
-        let siteStatus: PropTypes.Requireable<string>;
-        let className: PropTypes.Requireable<string>;
-    }
+    /**
+     * Heading level of the card title.
+     */
+    headingLevel?: HeadingLevel;
+    /**
+     * Image URL for the site.
+     */
+    siteImage?: string;
+    /**
+     * Link to the site dashboard.
+     */
+    siteLink: ReactNode;
+    /**
+     * Name of the site.
+     */
+    siteName?: string;
+    /**
+     * Plan of the site.
+     */
+    sitePlan?: string;
+    /**
+     * Status of the site.
+     */
+    siteStatus?: SiteStatus;
+    /**
+     * Additional class names
+     */
+    className?: string;
 }
-import React from 'react';
-import PropTypes from 'prop-types';
+/**
+ * SiteCard UI component
+ */
+export declare const SiteCard: ({ gotoText, headingLevel, siteImage, siteLink, siteName, sitePlan, siteStatus, className, ...props }: SiteCardProps) => React.JSX.Element;

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,35 @@
-export function SiteOptionDisplay({ option }: {
-    option: any;
-}): React.JSX.Element;
-export namespace SiteOptionDisplay {
-    namespace propTypes {
-        let option: PropTypes.Requireable<object>;
-    }
+import React, { ComponentPropsWithoutRef } from 'react';
+import { SiteStatus } from '@libs/types/custom-types';
+export type SiteOption = {
+    /**
+     * Machine name of the site.
+     */
+    machineName?: string;
+    /**
+     * Name of the site.
+     */
+    name: string;
+    /**
+     * Site active status.
+     */
+    status?: SiteStatus;
+    /**
+     * 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 {};