@pantheon-systems/pds-toolkit-react 1.0.0-dev.19 → 1.0.0-dev.190

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

@@ -0,0 +1,64 @@
+export function PricingCard({ actionPrimary, actionSecondary, hasComparisonList, onTierChange, planDescription, planName, planPricingData, statusBadgeLabels, selectLabel, statusBadgeType, className, ...props }: {
+    [x: string]: any;
+    actionPrimary: any;
+    actionSecondary: any;
+    hasComparisonList?: boolean;
+    onTierChange: any;
+    planDescription: any;
+    planName: any;
+    planPricingData: any;
+    statusBadgeLabels?: {
+        currentPlan: string;
+        mostPopular: string;
+    };
+    selectLabel?: string;
+    statusBadgeType: any;
+    className: any;
+}): React.JSX.Element;
+export namespace PricingCard {
+    namespace propTypes {
+        let actionPrimary: PropTypes.Requireable<PropTypes.InferProps<{
+            type: PropTypes.Requireable<string>;
+            variant: PropTypes.Requireable<string>;
+            label: PropTypes.Requireable<string>;
+            buttonAction: PropTypes.Requireable<(...args: any[]) => any>;
+            linkUrl: PropTypes.Requireable<string>;
+            linkTarget: PropTypes.Requireable<string>;
+            disabled: PropTypes.Requireable<boolean>;
+        }>>;
+        let actionSecondary: PropTypes.Requireable<PropTypes.InferProps<{
+            type: PropTypes.Requireable<string>;
+            label: PropTypes.Requireable<string>;
+            buttonAction: PropTypes.Requireable<(...args: any[]) => any>;
+            linkUrl: PropTypes.Requireable<string>;
+            linkTarget: PropTypes.Requireable<string>;
+        }>>;
+        let hasComparisonList: PropTypes.Requireable<boolean>;
+        let onTierChange: PropTypes.Requireable<(...args: any[]) => any>;
+        let planDescription: PropTypes.Requireable<string>;
+        let planName: PropTypes.Requireable<string>;
+        let planPricingData: PropTypes.Requireable<PropTypes.InferProps<{
+            customActionLabel: PropTypes.Requireable<string>;
+            label: PropTypes.Requireable<string>;
+            price: PropTypes.Requireable<string>;
+            priceDetails: PropTypes.Requireable<string>;
+            savingsBadgeLabel: PropTypes.Requireable<string>;
+            savingsDetails: PropTypes.Requireable<string>;
+            listLabel: PropTypes.Requireable<string>;
+            listItems: PropTypes.Requireable<PropTypes.InferProps<{
+                text: PropTypes.Requireable<string>;
+                type: PropTypes.Requireable<string>;
+            }>[]>;
+        }>[]>;
+        let selectLabel: PropTypes.Requireable<string>;
+        let statusBadgeLabels: PropTypes.Requireable<PropTypes.InferProps<{
+            currentPlan: PropTypes.Requireable<string>;
+            mostPopular: PropTypes.Requireable<string>;
+        }>>;
+        let statusBadgeType: PropTypes.Requireable<string>;
+        let className: PropTypes.Requireable<string>;
+        let containerClassName: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

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

@@ -0,0 +1,45 @@
+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;
+    /**
+     * 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;
+}
+/**
+ * SiteCard UI component
+ */
+export declare const SiteCard: ({ gotoText, headingLevel, siteImage, siteLink, siteName, sitePlan, siteStatus, className, ...props }: SiteCardProps) => React.JSX.Element;

package/_dist/components/expansion-panels/ExpansionPanel/ExpansionPanel.d.ts

@@ -0,0 +1,32 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './expansion-panel.css';
+/**
+ * Prop types for ExpansionPanel
+ */
+interface ExpansionPanelProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * The content of the expansion panel.
+     */
+    children?: ReactNode;
+    /**
+     * The ID of the expansion panel. If not provided, a unique ID will be generated.
+     */
+    id?: string;
+    /**
+     * Whether the expansion panel is open or not.
+     */
+    isOpen?: boolean;
+    /**
+     * The summary label of the expansion panel.
+     */
+    summary?: string | ReactNode;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * ExpansionPanel UI component
+ */
+export declare const ExpansionPanel: ({ children, id, isOpen, summary, className, ...props }: ExpansionPanelProps) => React.JSX.Element;
+export {};

package/_dist/components/expansion-panels/ExpansionPanelGroup/ExpansionPanelGroup.d.ts

@@ -0,0 +1,24 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './expansion-panel-group.css';
+/**
+ * Prop types for ExpansionPanelGroup
+ */
+interface ExpansionPanelGroupProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * The content of the expansion panel group. This should be a series of ExpansionPanel components.
+     */
+    children?: ReactNode;
+    /**
+     * The display type of the expansion panel group.
+     */
+    displayType?: 'standard' | 'no-border' | 'stacked';
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * ExpansionPanelGroup UI component
+ */
+export declare const ExpansionPanelGroup: ({ children, displayType, className, ...props }: ExpansionPanelGroupProps) => React.JSX.Element;
+export {};

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

@@ -0,0 +1,15 @@
+export function FooterHeading({ headingLevel, headingText, className, ...props }: {
+    [x: string]: any;
+    headingLevel?: string;
+    headingText: any;
+    className: any;
+}): React.JSX.Element;
+export namespace FooterHeading {
+    namespace propTypes {
+        let headingLevel: PropTypes.Requireable<string>;
+        let headingText: PropTypes.Validator<string>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

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

@@ -0,0 +1,17 @@
+export function FooterLinks({ headingLevel, headingText, linkItems, className, ...props }: {
+    [x: string]: any;
+    headingLevel: any;
+    headingText: any;
+    linkItems: any;
+    className: any;
+}): React.JSX.Element;
+export namespace FooterLinks {
+    namespace propTypes {
+        let headingLevel: PropTypes.Requireable<string>;
+        let headingText: PropTypes.Validator<string>;
+        let linkItems: PropTypes.Requireable<PropTypes.ReactNodeLike[]>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

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

@@ -0,0 +1,26 @@
+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;
+}
+/**
+ * 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/Checkbox/Checkbox.d.ts

@@ -0,0 +1,92 @@
+import React, { ComponentPropsWithoutRef, ChangeEvent, FocusEvent } from 'react';
+import { ValidationStatus } from '../input-types';
+import './checkbox.css';
+/**
+ * Prop types for Checkbox
+ */
+export interface CheckboxProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Checked state of the input. Used to set the checked status of the input field when controlled. Cannot be used in conjunction with the `defaultChecked` prop.
+     */
+    checked?: boolean;
+    /**
+     * Default checked state. Setting this prop automatically makes the input uncontrolled. Cannot be used with the checked prop.
+     */
+    defaultChecked?: boolean;
+    /**
+     * Is the field disabled?
+     */
+    disabled?: boolean;
+    /**
+     * The ID of the checkbox.
+     */
+    id: string;
+    /**
+     * Indeterminate state
+     */
+    indeterminate?: boolean;
+    /**
+     * Additional props for the `<input>` element.
+     */
+    inputProps?: ComponentPropsWithoutRef<'input'>;
+    /**
+     * Width of the input field. Accepts a number in pixels. Leave blank for width: 100%.
+     */
+    inputWidth?: number;
+    /**
+     * Input label.
+     */
+    label: string;
+    /**
+     * Input message. Used to provide supplemental text. Will be displayed below the input field.
+     */
+    message?: string;
+    /**
+     * Name attribute of the checkbox.
+     */
+    name?: string;
+    /**
+     * Indent level of the checkbox. Visual styles for creating nested checkboxes. Styles are only applied when the checkbox is an ancestor of a div with the class `pds-checkbox-group`.
+     */
+    nestingLevel?: 0 | 1 | 2;
+    /**
+     * onBlur event handler
+     */
+    onBlur?: (e: FocusEvent<HTMLInputElement>) => void;
+    /**
+     * onChange event handler
+     */
+    onChange?: (e: ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * onFocus event handler
+     */
+    onFocus?: (e: FocusEvent<HTMLInputElement>) => void;
+    /**
+     * Is the field required?
+     */
+    required?: boolean;
+    /**
+     * Should the label be visible? If false, it will render for screen readers only.
+     */
+    showLabel?: boolean;
+    /**
+     * Validation message for the input field based on the validation status.
+     */
+    validationMessage?: string;
+    /**
+     * Validation status of the input field.
+     */
+    validationStatus?: ValidationStatus;
+    /**
+     * Value attribute of the checkbox.
+     */
+    value?: string;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * Checkbox UI component
+ */
+export declare const Checkbox: React.ForwardRefExoticComponent<CheckboxProps & React.RefAttributes<HTMLInputElement>>;

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

@@ -0,0 +1,60 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import { ValidationStatus } from '../input-types';
+import '../CheckboxGroup/checkbox-group.css';
+/**
+ * Prop types for CheckboxFieldset
+ */
+export interface CheckboxGroupWrapperProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Individual checkboxes to be rendered within the group.
+     */
+    children: React.ReactNode;
+    /**
+     * Is the field disabled?
+     */
+    disabled?: boolean;
+    /**
+     * Additional props for the `<fieldset>` element.
+     */
+    fieldsetProps?: ComponentPropsWithoutRef<'fieldset'>;
+    /**
+     * The ID of the checkbox group.
+     */
+    id: string;
+    /**
+     * Width of the field. Accepts a number in pixels. Leave blank for width: 100%.
+     */
+    inputWidth?: number;
+    /**
+     * Field label. Will be rendered as the fieldset legend.
+     */
+    label: string;
+    /**
+     * Input message. Used to provide supplemental text. Will be displayed below the field.
+     */
+    message?: string;
+    /**
+     * Is the field required?
+     */
+    required?: boolean;
+    /**
+     * Should the label (legend) be visible? If false, it will render for screen readers only.
+     */
+    showLabel?: boolean;
+    /**
+     * Validation message for the input field based on the validation status.
+     */
+    validationMessage?: string;
+    /**
+     * Validation status of the input field.
+     */
+    validationStatus?: ValidationStatus;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * CheckboxFieldset UI component
+ */
+export declare const CheckboxFieldset: ({ children, disabled, fieldsetProps, id, inputWidth, label, message, required, showLabel, validationMessage, validationStatus, className, ...props }: CheckboxGroupWrapperProps) => React.JSX.Element;

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

@@ -0,0 +1,76 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import { ValidationStatus } from '../input-types';
+import './checkbox-group.css';
+export type CheckboxOption = {
+    checked?: boolean;
+    disabled?: boolean;
+    id?: string;
+    label: string;
+    name?: string;
+    value: string;
+};
+/**
+ * Prop types for CheckboxGroup
+ */
+export interface CheckboxGroupProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Is the field disabled?
+     */
+    disabled?: boolean;
+    /**
+     * Additional props for the `<fieldset>` element.
+     */
+    fieldsetProps?: ComponentPropsWithoutRef<'fieldset'>;
+    /**
+     * The ID of the checkbox group.
+     */
+    id: string;
+    /**
+     * Width of the field. Accepts a number in pixels. Leave blank for width: 100%.
+     */
+    inputWidth?: number;
+    /**
+     * Field label. Will be rendered as the fieldset legend.
+     */
+    label: string;
+    /**
+     * Input message. Used to provide supplemental text. Will be displayed below the field.
+     */
+    message?: string;
+    /**
+     * onGroupBlur function. Called when all checkboxes have lost focus. Provides an array of checked values.
+     */
+    onGroupBlur?: (checkedOptions: string[]) => void;
+    /**
+     * onValueChange function. Called when the value of any checkbox changes. Provides an array of checked values.
+     */
+    onValueChange?: (updatedOptions: string[]) => void;
+    /**
+     * Array of checkbox options for group.
+     */
+    options: CheckboxOption[];
+    /**
+     * Is the field required?
+     */
+    required?: boolean;
+    /**
+     * Should the label (legend) be visible? If false, it will render for screen readers only.
+     */
+    showLabel?: boolean;
+    /**
+     * Validation message for the input field based on the validation status.
+     */
+    validationMessage?: string;
+    /**
+     * Validation status of the input field.
+     */
+    validationStatus?: ValidationStatus;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * CheckboxGroup UI component
+ */
+export declare const CheckboxGroup: ({ disabled, fieldsetProps, id, inputWidth, label, message, onGroupBlur, onValueChange, options, required, showLabel, validationMessage, validationStatus, className, ...props }: CheckboxGroupProps) => React.JSX.Element;

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

@@ -0,0 +1,134 @@
+import React, { ChangeEvent, ComponentPropsWithoutRef, FocusEvent, ReactNode } from 'react';
+import { ValidationStatus } from '../input-types';
+import './combobox.css';
+type LabelStrings = {
+    clearButton?: string;
+    inputInstructions?: string;
+    searchShortcut?: string;
+    triggerButton?: string;
+};
+export type ComboboxOption = {
+    label: string;
+    optionDisplay?: ReactNode;
+    searchIndex?: string[];
+    value: string;
+    [otherOptions: string]: unknown;
+};
+/**
+ * Prop types for Combobox
+ */
+export interface ComboboxProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Optional default value for the field.
+     */
+    defaultValue?: string;
+    /**
+     * Is the field disabled?
+     */
+    disabled?: boolean;
+    /**
+     * Should the combobox have a clear button?
+     */
+    hasClearButton?: boolean;
+    /**
+     * Should the combobox have a dropdown trigger?
+     */
+    hasDropdownTrigger?: boolean;
+    /**
+     * Should the combobox have a search icon?
+     */
+    hasSearchIcon?: boolean;
+    /**
+     * Should the combobox have a search shortcut?
+     */
+    hasSearchShortcut?: boolean;
+    /**
+     * ID of the combobox
+     */
+    id: string;
+    /**
+     * Width of the input field. Accepts a number in pixels. Leave blank for width: 100%.
+     */
+    inputWidth?: number;
+    /**
+     * Are the options in the process of being loaded?
+     */
+    isLoading?: boolean;
+    /**
+     * Text to display when options are still loading.
+     */
+    loadingText?: string;
+    /**
+     * Field label.
+     */
+    label: string;
+    /**
+     * Translation strings for various labels or other visually-hidden text.
+     */
+    labelStrings?: LabelStrings;
+    /**
+     * Message or description used to help clarify the usage of the input.
+     */
+    message?: string;
+    /**
+     * Text to display when there are no results.
+     */
+    noResultsText?: string;
+    /**
+     * onChange event handler.
+     */
+    onChange?: (e: ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * onBlur event handler.
+     */
+    onBlur?: (e: FocusEvent<HTMLInputElement>) => void;
+    /**
+     * Callback when the input is cleared.
+     */
+    onClear?: () => void;
+    /**
+     * onFocus event handler.
+     */
+    onFocus?: (e: FocusEvent<HTMLInputElement>) => void;
+    /**
+     * Callback when an option is selected. Returns the selected option object.
+     */
+    onOptionSelect?: (option: ComboboxOption) => void;
+    /**
+     * Array of options to display in the dropdown.
+     */
+    options?: ComboboxOption[];
+    /**
+     * Optional placeholder text to display when the input field is empty.
+     */
+    placeholder?: string;
+    /**
+     * Is this field required?
+     */
+    required?: boolean;
+    /**
+     * Should the label be visible? If false, it will render for screen readers only.
+     */
+    showLabel?: boolean;
+    /**
+     * Value attribute of input
+     */
+    value?: string;
+    /**
+     * Validation message for the input field based on the validation status.
+     */
+    validationMessage?: string;
+    /**
+     * Validation status of the input field.
+     */
+    validationStatus?: ValidationStatus;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * Combobox UI component
+ */
+export declare const Combobox: React.ForwardRefExoticComponent<ComboboxProps & React.RefAttributes<HTMLSpanElement>>;
+export {};

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

@@ -0,0 +1,77 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import { ValidationStatus } from '../input-types';
+import './file-upload.css';
+type LabelStrings = {
+    chooseFile: string;
+    clearButton: string;
+};
+/**
+ * Prop types for FileUpload
+ */
+export interface FileUploadProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * File types the input should accept. Leave null for all file types.
+     */
+    accept?: string;
+    /**
+     * Is the field disabled?
+     */
+    disabled?: boolean;
+    /**
+     * Label to be rendered above the input field. Describes the fields purpose. Optional.
+     */
+    fieldLabel?: string;
+    /**
+     * Input ID.
+     */
+    id: string;
+    /**
+     * Width of the input field. Accepts a number in pixels. Leave blank for width: 100%.
+     */
+    inputWidth?: number;
+    /**
+     * Translation strings for various labels or other visually-hidden text.
+     */
+    labelStrings?: LabelStrings;
+    /**
+     * Message or description used to help clarify the usage of the input.
+     */
+    message?: string;
+    /**
+     * Should the input accept multiple files?
+     */
+    multiple?: boolean;
+    /**
+     * Callback function that will run when the clear button is clicked.
+     */
+    onClear?: () => void;
+    /**
+     * Callback function that will run when the file input changes.
+     */
+    onFileChange?: (files: FileList) => void;
+    /**
+     * Is the field required?
+     */
+    required?: boolean;
+    /**
+     * Should the label be visible? If false, it will render for screen readers only.
+     */
+    showLabel?: boolean;
+    /**
+     * Validation message for the input field based on the validation status.
+     */
+    validationMessage?: string;
+    /**
+     * Validation status of the input field.
+     */
+    validationStatus?: ValidationStatus;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * FileUpload UI component
+ */
+export declare const FileUpload: ({ accept, disabled, fieldLabel, id, inputWidth, labelStrings, message, multiple, onClear, onFileChange, required, showLabel, validationMessage, validationStatus, className, ...props }: FileUploadProps) => React.JSX.Element;
+export {};