@pantheon-systems/pds-toolkit-react 1.0.0-dev.18 → 1.0.0-dev.180

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

@@ -0,0 +1,18 @@
+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 from 'react';
+import { ContainerWidth } from '@libs/components/customPropTypes';
+import PropTypes from 'prop-types';

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,125 @@
+import React, { 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;
+};
+/**
+ * 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;
+    /**
+     * 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;
+    /**
+     * 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,37 @@
+export function FileUpload({ accept, chooseFileLabel, clearButtonLabel, disabled, fieldLabel, id, inputWidth, message, multiple, onFileChange, required, showLabel, validationFunction, className, ...props }: {
+    [x: string]: any;
+    accept: any;
+    chooseFileLabel?: string;
+    clearButtonLabel?: string;
+    disabled?: boolean;
+    fieldLabel: any;
+    id: any;
+    inputWidth: any;
+    message: any;
+    multiple?: boolean;
+    onFileChange: any;
+    required?: boolean;
+    showLabel?: boolean;
+    validationFunction: any;
+    className: any;
+}): React.JSX.Element;
+export namespace FileUpload {
+    namespace propTypes {
+        let accept: PropTypes.Requireable<string>;
+        let chooseFileLabel: PropTypes.Requireable<string>;
+        let clearButtonLabel: PropTypes.Requireable<string>;
+        let disabled: PropTypes.Requireable<boolean>;
+        let fieldLabel: PropTypes.Requireable<string>;
+        let id: PropTypes.Validator<string>;
+        let inputWidth: PropTypes.Requireable<number>;
+        let message: PropTypes.Requireable<string>;
+        let multiple: PropTypes.Requireable<boolean>;
+        let onFileChange: PropTypes.Requireable<(...args: any[]) => any>;
+        let required: PropTypes.Requireable<boolean>;
+        let showLabel: PropTypes.Requireable<boolean>;
+        let validationFunction: PropTypes.Requireable<(...args: any[]) => any>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

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

@@ -0,0 +1,35 @@
+export function InputFormatted({ disabled, formatting, hasClearButton, id, initialValue, label, message, onChange, placeholder, required, showLabel, validationFunction, className, ...props }: {
+    [x: string]: any;
+    disabled?: boolean;
+    formatting: any;
+    hasClearButton?: boolean;
+    id: any;
+    initialValue?: string;
+    label: any;
+    message: any;
+    onChange: any;
+    placeholder: any;
+    required?: boolean;
+    showLabel?: boolean;
+    validationFunction: any;
+    className: any;
+}): React.JSX.Element;
+export namespace InputFormatted {
+    namespace propTypes {
+        let disabled: PropTypes.Requireable<boolean>;
+        let formatting: PropTypes.Validator<string>;
+        let id: PropTypes.Validator<string>;
+        let hasClearButton: PropTypes.Requireable<boolean>;
+        let initialValue: PropTypes.Requireable<string>;
+        let label: PropTypes.Validator<string>;
+        let message: PropTypes.Requireable<string>;
+        let onChange: PropTypes.Requireable<(...args: any[]) => any>;
+        let placeholder: PropTypes.Requireable<string>;
+        let required: PropTypes.Requireable<boolean>;
+        let showLabel: PropTypes.Requireable<boolean>;
+        let validationFunction: PropTypes.Requireable<(...args: any[]) => any>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

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

@@ -0,0 +1,19 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './input-group.css';
+/**
+ * Prop types for InputGroup
+ */
+export interface InputGroupProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Input and button elements
+     */
+    children: ReactNode;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * InputGroup UI component
+ */
+export declare const InputGroup: ({ children, className, ...props }: InputGroupProps) => React.JSX.Element;

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

@@ -0,0 +1,33 @@
+export function InputObscured({ counterFunction, disabled, hasClearButton, id, initialValue, label, message, onChange, required, showLabel, validationFunction, className, ...props }: {
+    [x: string]: any;
+    counterFunction?: () => void;
+    disabled?: boolean;
+    hasClearButton?: boolean;
+    id: any;
+    initialValue?: string;
+    label: any;
+    message: any;
+    onChange: any;
+    required?: boolean;
+    showLabel?: boolean;
+    validationFunction: any;
+    className: any;
+}): React.JSX.Element;
+export namespace InputObscured {
+    namespace propTypes {
+        let counterFunction: PropTypes.Requireable<(...args: any[]) => any>;
+        let disabled: PropTypes.Requireable<boolean>;
+        let hasClearButton: PropTypes.Requireable<boolean>;
+        let id: PropTypes.Validator<string>;
+        let initialValue: PropTypes.Requireable<string>;
+        let label: PropTypes.Validator<string>;
+        let message: PropTypes.Requireable<string>;
+        let onChange: PropTypes.Requireable<(...args: any[]) => any>;
+        let required: PropTypes.Requireable<boolean>;
+        let showLabel: PropTypes.Requireable<boolean>;
+        let validationFunction: PropTypes.Requireable<(...args: any[]) => any>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

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

@@ -0,0 +1,75 @@
+export function InputText({ autoComplete, counterFunction, disabled, hasClearButton, hasSearchShortcut, id, initialValue, inputWidth, label, labelStrings, message, onChange, onFocus, placeholder, readonly, required, showLabel, specialFormatting, specialFormattingValidation, toggleVisibility, type, validationFunction, validationMessages, className, ...props }: {
+    [x: string]: any;
+    autoComplete?: string;
+    counterFunction?: () => void;
+    disabled?: boolean;
+    hasClearButton?: boolean;
+    hasSearchShortcut?: boolean;
+    id: any;
+    initialValue?: string;
+    inputWidth: any;
+    label: any;
+    labelStrings?: {
+        clearButton: string;
+        searchShortcut: string;
+        visibilityStatus: string;
+        visibilityToggleHide: string;
+        visibilityToggleShow: string;
+    };
+    message: any;
+    onChange: any;
+    onFocus: any;
+    placeholder: any;
+    readonly?: boolean;
+    required?: boolean;
+    showLabel?: boolean;
+    specialFormatting: any;
+    specialFormattingValidation?: boolean;
+    toggleVisibility?: boolean;
+    type?: string;
+    validationFunction: any;
+    validationMessages?: {
+        creditCardError: string;
+        phoneError: string;
+    };
+    className: any;
+}): React.JSX.Element;
+export namespace InputText {
+    namespace propTypes {
+        let autoComplete: PropTypes.Requireable<string>;
+        let counterFunction: PropTypes.Requireable<(...args: any[]) => any>;
+        let disabled: PropTypes.Requireable<boolean>;
+        let hasClearButton: PropTypes.Requireable<boolean>;
+        let hasSearchShortcut: PropTypes.Requireable<boolean>;
+        let id: PropTypes.Validator<string>;
+        let initialValue: PropTypes.Requireable<string>;
+        let inputWidth: PropTypes.Requireable<number>;
+        let label: PropTypes.Validator<string>;
+        let labelStrings: PropTypes.Requireable<PropTypes.InferProps<{
+            clearButton: PropTypes.Requireable<string>;
+            searchShortcut: PropTypes.Requireable<string>;
+            visibilityStatus: PropTypes.Requireable<string>;
+            visibilityToggleHide: PropTypes.Requireable<string>;
+            visibilityToggleShow: PropTypes.Requireable<string>;
+        }>>;
+        let message: PropTypes.Requireable<string>;
+        let onChange: PropTypes.Requireable<(...args: any[]) => any>;
+        let onFocus: PropTypes.Requireable<(...args: any[]) => any>;
+        let placeholder: PropTypes.Requireable<string>;
+        let readonly: PropTypes.Requireable<boolean>;
+        let required: PropTypes.Requireable<boolean>;
+        let showLabel: PropTypes.Requireable<boolean>;
+        let specialFormatting: PropTypes.Requireable<string>;
+        let specialFormattingValidation: PropTypes.Requireable<boolean>;
+        let toggleVisibility: PropTypes.Requireable<boolean>;
+        let type: PropTypes.Requireable<string>;
+        let validationFunction: PropTypes.Requireable<(...args: any[]) => any>;
+        let validationMessages: PropTypes.Requireable<PropTypes.InferProps<{
+            creditCardError: PropTypes.Requireable<string>;
+            phoneError: PropTypes.Requireable<string>;
+        }>>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

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

@@ -0,0 +1,5 @@
+/**
+ * InputWrapper UI component
+ */
+export const InputWrapper: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

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

@@ -0,0 +1,92 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import { ValidationStatus } from '../input-types';
+import './radio-group.css';
+export interface RadioOption {
+    /**
+     * Option is disabled
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * Unique ID for the option
+     * @default ''
+     */
+    id?: string;
+    /**
+     * Option label
+     */
+    label: string | ReactNode;
+    /**
+     * Option value
+     */
+    value: string;
+}
+export interface RadioGroupProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Optional default value
+     */
+    defaultValue?: string;
+    /**
+     * Additional props for the `<fieldset>` element.
+     */
+    fieldsetProps?: ComponentPropsWithoutRef<'fieldset'>;
+    /**
+     * is the radio group disabled
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * Unique ID for the radio group
+     */
+    id: string;
+    /**
+     * Input width in rem
+     */
+    inputWidth?: number;
+    /**
+     * Label for the radio group
+     */
+    label: string;
+    /**
+     * Input message
+     */
+    message?: string;
+    /**
+     * Callback function that will return the updated value from the instance when it changes.
+     */
+    onBlur?: (event: React.FocusEvent<HTMLDivElement>) => void;
+    /**
+     * Callback function that will return the updated value from the instance when it changes.
+     */
+    onValueChange?: (value: string) => void;
+    /**
+     * Array of radio options
+     */
+    options: RadioOption[];
+    /**
+     * Is the radio group required
+     * @default false
+     */
+    required?: boolean;
+    /**
+     * Show the label
+     * @default true
+     */
+    showLabel?: boolean;
+    /**
+     * Validation message
+     */
+    validationMessage?: string;
+    /**
+     * Validation status of the input field.
+     */
+    validationStatus?: ValidationStatus;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * RadioGroup UI component
+ */
+export declare const RadioGroup: ({ defaultValue, disabled, fieldsetProps, id, inputWidth, label, message, onBlur, onValueChange, options, required, showLabel, validationMessage, validationStatus, className, ...props }: RadioGroupProps) => React.JSX.Element;