@pantheon-systems/pds-toolkit-react 2.0.0-alpha.7 → 2.0.0-alpha.71

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

@@ -1,31 +0,0 @@
-import { HeadingLevelCommon } from '../../../libs/types/custom-types';
-import './card-heading.css';
-/**
- * Prop types for CardHeading
- */
-export interface CardHeadingProps {
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * 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?: HeadingLevelCommon;
-    /**
-     * Heading text.
-     */
-    text?: string;
-}
-/**
- * CardHeading UI component
- */
-export declare const CardHeading: ({ className, fontSize, fontWeight, level, text, ...props }: CardHeadingProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/cards/CardSelectGroup/CardSelectGroup.d.ts

@@ -1,60 +0,0 @@
-import { ComponentPropsWithoutRef, ReactNode } from 'react';
-import './card-select-group.css';
-export interface CardOption {
-    /**
-     * Option description
-     */
-    description?: string | ReactNode;
-    /**
-     * Unique ID for the option
-     * @default ''
-     */
-    id?: string;
-    /**
-     * Option label
-     */
-    label: string | ReactNode;
-    /**
-     * Option value
-     */
-    value: string;
-}
-export interface CardSelectGroupProps extends Omit<ComponentPropsWithoutRef<'fieldset'>, 'onChange'> {
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * Optional initial selected option value
-     */
-    defaultValue?: string;
-    /**
-     * Unique ID for the card select group
-     */
-    id: string;
-    /**
-     * Label for the card select group
-     */
-    label: string;
-    /**
-     * Display of the component label. `hidden` visually hides the label but keeps it accessible to screen readers.
-     */
-    labelDisplay?: 'left' | 'center' | 'hidden';
-    /**
-     * Column layout of the cards at breakpoints medium and above.
-     */
-    layout?: 'auto' | 'twoAcross' | 'threeAcross';
-    /**
-     * Callback function that will return the updated value from the instance when it changes.
-     * Function should have the shape of: `(value) => { <do stuff here> } `.
-     */
-    onChange?: (value: string) => void;
-    /**
-     * Array of card options
-     */
-    options?: CardOption[];
-}
-/**
- * CardSelectGroup UI component
- */
-export declare const CardSelectGroup: ({ className, defaultValue, id, label, labelDisplay, layout, onChange, options, ...props }: CardSelectGroupProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/cards/EmptyStateCard/EmptyStateCard.d.ts

@@ -1,36 +0,0 @@
-import { ComponentPropsWithoutRef, ReactNode } from 'react';
-import { HeadingLevelCommon } from '../../../libs/types/custom-types';
-import './empty-state-card.css';
-/**
- * Prop types for EmptyStateCard
- */
-export interface EmptyStateCardProps extends ComponentPropsWithoutRef<'div'> {
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     *  Heading level or `span`.
-     */
-    headingLevel?: HeadingLevelCommon;
-    /**
-     * Heading text.
-     */
-    headingText: string;
-    /**
-     * Whether the link is external or not.
-     */
-    isLinkExternal?: boolean;
-    /**
-     * A link element using the router of your choice.
-     */
-    linkContent: ReactNode;
-    /**
-     * Summary paragraph.
-     */
-    summary: string;
-}
-/**
- * EmptyStateCard UI component
- */
-export declare const EmptyStateCard: ({ className, headingLevel, headingText, isLinkExternal, linkContent, summary, ...props }: EmptyStateCardProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/cards/LinksCard/LinksCard.d.ts

@@ -1,29 +0,0 @@
-import { ComponentPropsWithoutRef, ReactNode } from 'react';
-import { HeadingLevelCommon } from '../../../libs/types/custom-types';
-import './links-card.css';
-/**
- * Prop types for LinksCard
- */
-interface LinksCardProps extends ComponentPropsWithoutRef<'div'> {
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * Heading level
-     */
-    headingLevel?: HeadingLevelCommon;
-    /**
-     * Link Card heading
-     */
-    headingText: string;
-    /**
-     * Array of links
-     */
-    linkItems?: ReactNode[];
-}
-/**
- * Links Card UI component
- */
-export declare const LinksCard: ({ className, headingLevel, headingText, linkItems, ...props }: LinksCardProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/cards/LinksCard/links-card-sample-data.d.ts

@@ -1,2 +0,0 @@
-import { ReactNode } from 'react';
-export declare const fiveItems: ReactNode[];

package/dist/components/cards/NewSiteCard/NewSiteCard.d.ts

@@ -1,61 +0,0 @@
-import { ComponentPropsWithoutRef, ReactElement } from 'react';
-import { BadgeColor } from '../../badges/Badge/Badge';
-import './new-site-card.css';
-interface BadgeValueType {
-    color: BadgeColor;
-    label: string;
-}
-export declare const badgeTypes: {
-    [key: string]: BadgeValueType;
-};
-type ActualPlatformIconType = 'drupal' | 'drupal7' | 'front-end-sites' | 'gatsby' | 'gatsby-wp' | 'google' | 'import-custom' | 'microsoft' | 'next' | 'next-drupal' | 'next-wp' | 'splunk' | 'sumo-logic' | 'wordpress';
-type PantheonIconType = 'pantheon';
-type PlatformIconType = ActualPlatformIconType | PantheonIconType;
-type IconVariantType = 'bitbucket' | 'github' | 'gitlab';
-type IconType = IconVariantType | PlatformIconType;
-/**
- * Prop types for NewSiteCard
- */
-interface NewSiteCardProps extends ComponentPropsWithoutRef<'div'> {
-    /**
-     * Optional indicator badge type. Choose from only early-access at this time.
-     */
-    badge?: 'early-access';
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * Icon. Accepts any platform type from PlatformIcon or github, gitlab, bitbucket from Icon.
-     */
-    icon?: IconType;
-    /**
-     * Text for screen readers when link opens in new window
-     */
-    newWindowString?: string;
-    /**
-     * The primary link for the selection card.
-     */
-    selectionLink: ReactElement;
-    /**
-     * Card subtitle
-     */
-    subtitle?: string;
-    /**
-     * Card summary
-     */
-    summary?: string;
-    /**
-     * Array of supplemental links. Maximum of 2.
-     */
-    supplementalLinks?: ReactElement[];
-    /**
-     * Card title
-     */
-    title: string;
-}
-/**
- * NewSiteCard UI component
- */
-export declare const NewSiteCard: ({ badge, className, icon, newWindowString, selectionLink, subtitle, summary, supplementalLinks, title, ...props }: NewSiteCardProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/cards/PaymentCard/PaymentCard.d.ts

@@ -1,47 +0,0 @@
-import { ComponentPropsWithoutRef } from 'react';
-import './payment-card.css';
-/**
- * Prop types for PaymentCard
- */
-export interface PaymentCardProps extends ComponentPropsWithoutRef<'div'> {
-    /**
-     * The name of the cardholder.
-     */
-    cardholderName?: string;
-    /**
-     * The last four digits of the card number.
-     */
-    cardNumber?: number;
-    /**
-     * The type of payment icon to display.
-     */
-    cardType?: 'visa' | 'mastercard' | 'amex' | 'discover';
-    /**
-     * A string for the lower left corner.
-     */
-    cardUsage?: string;
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * Function for when “view details” is clicked
-     */
-    detailsCallback?: () => void;
-    /**
-     * Translation string for “view details”
-     */
-    detailsLabel?: string;
-    /**
-     * Expiration date of the card in MM/YY format.
-     */
-    expDate?: string;
-    /**
-     * Function for when this card is selected
-     */
-    selectionCallback?: () => void;
-}
-/**
- * PaymentCard UI component
- */
-export declare const PaymentCard: ({ cardholderName, cardNumber, cardType, cardUsage, className, detailsCallback, detailsLabel, expDate, selectionCallback, ...props }: PaymentCardProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/cards/PricingCard/PricingCard.d.ts

@@ -1,95 +0,0 @@
-import { ComponentPropsWithoutRef } from 'react';
-import { HeadingLevelCommon } from '../../../libs/types/custom-types';
-import { ListItems } from '../../ComparisonList/ComparisonList';
-import './pricing-card.css';
-interface PrimaryCallToAction {
-    buttonAction?: () => void;
-    disabled?: boolean;
-    label?: string;
-    linkTarget?: string;
-    linkUrl?: string;
-    type?: 'button' | 'link';
-    variant?: 'primary' | 'secondary';
-}
-interface SecondaryCallToAction {
-    buttonAction?: () => void;
-    label?: string;
-    linkTarget?: string;
-    linkUrl?: string;
-    type?: 'button' | 'link';
-}
-interface PlanPricingData {
-    customActionLabel?: string;
-    label?: string;
-    listItems?: ListItems[];
-    listLabel?: string;
-    price?: string;
-    priceDetails?: string;
-    pricePrefix?: string;
-    savingsBadgeLabel?: string;
-    savingsDetails?: string;
-}
-interface StatusBadgeLabels {
-    currentPlan?: string;
-    mostPopular?: string;
-}
-interface PricingCardProps extends ComponentPropsWithoutRef<'div'> {
-    /**
-     * The primary call to action.
-     */
-    actionPrimary?: PrimaryCallToAction;
-    /**
-     * An optional secondary call to action.
-     */
-    actionSecondary?: SecondaryCallToAction;
-    /**
-     * Additional class names for the card item.
-     */
-    className?: string;
-    /**
-     * Additional class names for the card container.
-     */
-    containerClassName?: string;
-    /**
-     * Has comparison list. Will be rendered below the card if true.
-     * Add corresponding `comparisonListId` to each planPricingData object.
-     */
-    hasComparisonList?: boolean;
-    /**
-     * Heading level for the plan name.
-     */
-    headingLevel?: HeadingLevelCommon;
-    /**
-     * Optional function to handle the change event of the select input. Only valid when multiple tiers of planPricingData are present.
-     */
-    onTierChange?: (value: any) => void;
-    /**
-     * A brief description of the plan.
-     */
-    planDescription?: string;
-    /**
-     * The name of the plan.
-     */
-    planName?: string;
-    /**
-     * Plan pricing data. An array of objects.
-     */
-    planPricingData: PlanPricingData[];
-    /**
-     * Label for the plan size select dropdown. Available to screen readers only. Provide translation string if needed.
-     */
-    selectLabel?: string;
-    /**
-     * Status badge labels. Provide translation strings if needed.
-     */
-    statusBadgeLabels: StatusBadgeLabels;
-    /**
-     * Status badge type. Leave empty for no badge. Only one badge of each type should be used in a group of Pricing Cards.
-     */
-    statusBadgeType?: 'currentPlan' | 'mostPopular';
-}
-/**
- * PricingCard UI component
- */
-export declare const PricingCard: ({ actionPrimary, actionSecondary, className, hasComparisonList, headingLevel, onTierChange, planDescription, planName, planPricingData, selectLabel, statusBadgeLabels, statusBadgeType, ...props }: PricingCardProps) => import("react/jsx-runtime").JSX.Element;
-export {};

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

@@ -1,50 +0,0 @@
-import { ComponentPropsWithoutRef, ReactNode } from 'react';
-import { HeadingLevelCommon, SiteStatus } from '../../../libs/types/custom-types';
-import './site-card.css';
-/**
- * Prop types for SiteCard
- */
-export interface SiteCardProps extends ComponentPropsWithoutRef<'div'> {
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * Translatable text for the "Go to" link.
-     */
-    gotoText?: string;
-    /**
-     * Heading level of the card title.
-     */
-    headingLevel?: HeadingLevelCommon;
-    /**
-     * Callback for when the card is clicked.
-     * Should only be used for special handling of restricted sites.
-     * Will override the default link behavior if provided.
-     */
-    onClick?: () => void;
-    /**
-     * 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;
-}
-/**
- * SiteCard UI component
- */
-export declare const SiteCard: ({ className, gotoText, headingLevel, onClick, siteImage, siteLink, siteName, sitePlan, siteStatus, ...props }: SiteCardProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/footer/FooterHeading/FooterHeading.d.ts

@@ -1,22 +0,0 @@
-import { ComponentPropsWithoutRef } from 'react';
-import type { HeadingLevelCommon } from '../../../libs/types/custom-types';
-import './footer-heading.css';
-interface FooterHeadingProps {
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     *  Heading level
-     */
-    headingLevel?: HeadingLevelCommon;
-    /**
-     * Heading text
-     */
-    headingText: string;
-}
-/**
- * Footer Heading UI component
- */
-export declare const FooterHeading: ({ className, headingLevel, headingText, ...props }: FooterHeadingProps & ComponentPropsWithoutRef<HeadingLevelCommon>) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/footer/FooterLinks/FooterLinks.d.ts

@@ -1,26 +0,0 @@
-import { ComponentPropsWithoutRef, ReactNode } from 'react';
-import type { HeadingLevelCommon } from '../../../libs/types/custom-types';
-import './footer-links.css';
-interface FooterLinksProps extends ComponentPropsWithoutRef<'div'> {
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     *  Heading level
-     */
-    headingLevel?: HeadingLevelCommon;
-    /**
-     * Heading text
-     */
-    headingText: string;
-    /**
-     * Array of links
-     */
-    linkItems?: ReactNode[];
-}
-/**
- * Footer Links UI component
- */
-export declare const FooterLinks: ({ className, headingLevel, headingText, linkItems, ...props }: FooterLinksProps) => import("react/jsx-runtime").JSX.Element;
-export {};

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

@@ -1,34 +0,0 @@
-import { ComponentPropsWithoutRef, ReactNode } from 'react';
-import { ContainerWidth } from '../../../libs/types/custom-types';
-import './site-footer.css';
-interface SiteFooterProps extends ComponentPropsWithoutRef<'footer'> {
-    /**
-     * HTML element to render. Use 'footer' for standalone usage or 'div' when nested inside another footer landmark.
-     */
-    as?: 'footer' | 'div';
-    /**
-     * Footer content.
-     */
-    children?: ReactNode;
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * PDS container width.
-     */
-    containerWidth?: ContainerWidth;
-    /**
-     * Should the footer have a top border?
-     */
-    hasTopBorder?: boolean;
-    /**
-     * Legal policy links.
-     */
-    legalLinks?: Array<'privacy' | 'dataSubjectRequest' | 'cookiePolicy' | 'termsOfUse' | 'acceptableUse' | 'accessibilityStatement'>;
-}
-/**
- * SiteFooter UI component
- */
-export declare const SiteFooter: ({ as: Element, children, className, containerWidth, hasTopBorder, legalLinks, ...props }: SiteFooterProps) => import("react/jsx-runtime").JSX.Element;
-export {};

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

@@ -1 +0,0 @@
-export declare const docsFooterContent: import("react/jsx-runtime").JSX.Element;

package/dist/components/navigation/DashboardNav/DashboardNav.d.ts

@@ -1,35 +0,0 @@
-import { ComponentPropsWithoutRef } from 'react';
-import { DashboardNavItemProps } from './DashboardNavItem';
-import './dashboard-nav.css';
-/**
- * Prop types for DashboardNav
- */
-export interface DashboardNavProps extends ComponentPropsWithoutRef<'nav'> {
-    /**
-     * Aria label for the navigation.
-     */
-    ariaLabel: string;
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * Labels for translatable strings.
-     */
-    labels?: {
-        submenu: string;
-        toggle: string;
-    };
-    /**
-     * Menu items to render.
-     */
-    menuItems: DashboardNavItemProps[];
-    /**
-     * Text to display in the mobile menu trigger button when no active link is found.
-     */
-    mobileMenuSelectTextFallback?: string;
-}
-/**
- * DashboardNav UI component
- */
-export declare const DashboardNav: ({ ariaLabel, className, labels, menuItems, mobileMenuSelectTextFallback, ...props }: DashboardNavProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/navigation/DashboardNav/DashboardNavItem.d.ts

@@ -1,24 +0,0 @@
-import { NavigationItem } from '../../../libs/types/navigation-types';
-import { PDSIcon } from '../../icons/Icon/Icon';
-import './dashboard-nav.css';
-export interface DashboardNavItemProps extends NavigationItem {
-    /**
-     * Icon to display next to the link content.
-     */
-    icon?: PDSIcon;
-    /**
-     * Flag indicating whether the sidebar is expanded.
-     */
-    isSidebarExpanded?: boolean;
-    /**
-     * Labels for translatable strings.
-     */
-    labels?: {
-        submenu: string;
-        toggle: string;
-    };
-}
-/**
- * DashboardNavItem UI component
- */
-export declare const DashboardNavItem: ({ icon, isActive, isSidebarExpanded, labels, linkContent, links, }: DashboardNavItemProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/navigation/NavMenu/NavMenu.d.ts

@@ -1,33 +0,0 @@
-import { ComponentPropsWithoutRef } from 'react';
-import { NavMenuItem } from '../../../libs/types/navigation-types';
-import './nav-menu.css';
-/**
- * Prop types for NavMenu
- */
-interface NavMenuProps extends ComponentPropsWithoutRef<'nav'> {
-    /**
-     * Aria label for `nav` element.
-     */
-    ariaLabel: string;
-    /**
-     * Additional class names
-     */
-    className?: string;
-    /**
-     * Color scheme.
-     */
-    colorType?: 'default' | 'reverse';
-    /**
-     * Menu Items.
-     */
-    menuItems?: NavMenuItem[];
-    /**
-     *  Mobile menu will be enabled when viewport is at or below this number in pixels.
-     */
-    mobileMenuMaxWidth?: number;
-}
-/**
- * NavMenu UI component
- */
-export declare const NavMenu: ({ ariaLabel, className, colorType, menuItems, mobileMenuMaxWidth, ...props }: NavMenuProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/navigation/NavMenu/NavMenuDropdown.d.ts

@@ -1,24 +0,0 @@
-import { ComponentPropsWithoutRef } from 'react';
-import { NavMenuItem } from '../../../libs/types/navigation-types';
-/**
- * Prop types for NavMenuDropdown
- */
-interface NavMenuDropdownProps extends ComponentPropsWithoutRef<'button'> {
-    /**
-     * Dropdown items.
-     */
-    items?: NavMenuItem[];
-    /**
-     * Dropdown label.
-     */
-    label?: string;
-    /**
-     * Mobile menu will be enabled when viewport is at or below this number in pixels.
-     */
-    mobileMenuMaxWidth?: number;
-}
-/**
- * NavMenuDropdown UI component
- */
-export declare const NavMenuDropdown: ({ items, label, mobileMenuMaxWidth, }: NavMenuDropdownProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/navigation/SideNavCompact/SideNavCompact.d.ts

@@ -1,53 +0,0 @@
-import { ComponentPropsWithoutRef, ReactElement } from 'react';
-import { NavigationItem } from '../../../libs/types/navigation-types';
-import './side-nav-compact.css';
-export type SideNavCompactItem = NavigationItem & {
-    /**
-     * A boolean indicating whether the item is a submenu.
-     */
-    path?: string;
-};
-/**
- * Prop types for SideNavCompact
- */
-export interface SideNavCompactProps extends ComponentPropsWithoutRef<'nav'> {
-    /**
-     * Aria label for the navigation.
-     */
-    ariaLabel: string;
-    /**
-     * Additional class names
-     */
-    className?: 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.
-     */
-    headingText?: string | ReactElement;
-    /**
-     * Labels for translatable strings.
-     */
-    labels?: {
-        submenu: string;
-        toggle: string;
-    };
-    /**
-     * Menu items to render.
-     */
-    menuItems: SideNavCompactItem[];
-    /**
-     *  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.
-     */
-    mobileMenuSelectTextFallback?: string;
-}
-/**
- * SideNavCompact UI component
- */
-export declare const SideNavCompact: ({ ariaLabel, className, hasMobileMenu, headingText, labels, menuItems, mobileMenuMaxWidth, mobileMenuSelectTextFallback, ...props }: SideNavCompactProps) => import("react/jsx-runtime").JSX.Element;