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

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 {};

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;

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

@@ -0,0 +1,99 @@
+import React from 'react';
+import { ValidationStatus } from '../input-types';
+import './select.css';
+type LabelStrings = {
+    selectOptionText: string;
+    triggerButton: string;
+};
+export type SelectOptionType = {
+    /**
+     * Option label.
+     */
+    label: string;
+    /**
+     * Option value.
+     */
+    value: string;
+    /**
+     * Option disabled.
+     */
+    disabled?: boolean;
+};
+/**
+ * Prop types for Select
+ */
+export interface SelectProps {
+    /**
+     * Optional default value for the field. Must match the value of one of the options. Cannot be used in conjunction with the `value` prop.
+     */
+    defaultValue?: string;
+    /**
+     * Is the field disabled?
+     */
+    disabled?: boolean;
+    /**
+     * Input ID.
+     */
+    id: string;
+    /**
+     * Width of the input field. Accepts a number in pixels. Leave blank for width: 100%.
+     */
+    inputWidth?: number;
+    /**
+     * 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;
+    /**
+     * onBlur event handler to provide the current value of the input.
+     */
+    onBlur?: (currentValue: string) => void;
+    /**
+     * onFocus event handler to provide the current value of the input.
+     */
+    onFocus?: (currentValue: string) => void;
+    /**
+     * Callback function when an option is selected.
+     */
+    onOptionSelect?: (option: SelectOptionType) => void;
+    /**
+     * Array of options for the select field.
+     */
+    options?: SelectOptionType[];
+    /**
+     * 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;
+    /**
+     * Value of the field. Must match the value of one of the options. Used to set the value of the field when controlled. Cannot be used in conjunction with the `defaultValue` prop.
+     */
+    value?: string;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * Select UI component
+ */
+export declare const Select: ({ defaultValue, disabled, id, inputWidth, label, labelStrings, message, onBlur, onFocus, onOptionSelect, options, required, showLabel, validationMessage, validationStatus, value, className, ...props }: SelectProps) => React.JSX.Element;
+export {};

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

@@ -0,0 +1,74 @@
+import React, { ChangeEvent, ComponentPropsWithoutRef } from 'react';
+import './switch.css';
+type SwitchPlacement = 'right' | 'below';
+/**
+ * Prop types for Switch
+ */
+export interface SwitchProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Is the field checked?
+     */
+    checked?: boolean;
+    /**
+     * Initial value for the input field. Only valid if the input is uncontrolled. Cannot be used in conjunction with the `checked` prop.
+     */
+    defaultChecked?: boolean;
+    /**
+     * Is the field disabled?
+     */
+    disabled?: boolean;
+    /**
+     * Input ID.
+     */
+    id: string;
+    /**
+     * 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;
+    /**
+     * Label of the switch field.
+     */
+    label: string;
+    /**
+     * Message or description used to help clarify the usage of the input.
+     */
+    message?: string;
+    /**
+     * Status text for when switch is off.
+     */
+    offLabel?: string;
+    /**
+     * onChange event handler. Controlled inputs should use this to manage the input value. Uncontrolled inputs will manage their own state, but may still use this to access the event object.
+     */
+    onChange?: (e: ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * Status text for when switch is on.
+     */
+    onLabel?: string;
+    /**
+     * Is this field required?
+     */
+    required?: boolean;
+    /**
+     * Should the label be visible? If false, it will render for screen readers only.
+     */
+    showLabel?: boolean;
+    /**
+     * Show toggle status label next to switch. If false, icons will render and the text will still be available to screen readers.
+     */
+    showStatusLabel?: boolean;
+    /**
+     * Determines switch placement, default set to `right`.
+     */
+    switchPlacement?: SwitchPlacement;
+    /**
+     * Additional class names for input.
+     */
+    className?: string;
+}
+export declare const Switch: React.ForwardRefExoticComponent<SwitchProps & React.RefAttributes<HTMLInputElement>>;
+export {};

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

@@ -0,0 +1,127 @@
+import React, { ComponentPropsWithoutRef, ChangeEvent, FocusEvent } from 'react';
+import { ValidationStatus } from '../input-types';
+import './text-input.css';
+type TranslationStringProps = {
+    clearButton: string;
+    counterOverLimit?: string;
+    searchShortcut: string;
+    visibilityStatus: string;
+    visibilityToggleHide: string;
+    visibilityToggleShow: string;
+};
+type HtmlInputTypes = 'text' | 'number' | 'email' | 'password' | 'tel' | 'url' | 'search';
+/**
+ * Prop types for TextInput
+ */
+export interface TextInputProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Auto complete attribute for the input field. The attribute value is either the keyword `off` or `on`, or an ordered list of space-separated tokens. Password fields are automatically off.
+     */
+    autoComplete?: string;
+    /**
+     * Maximum character count for the character counter. Leave blank for no counter. Not valid for type `password`.
+     */
+    counterMaxLength?: number;
+    /**
+     * Initial value for the input field. Setting this prop automatically makes the input uncontrolled. Cannot be used in conjunction with the `value` prop.
+     */
+    defaultValue?: string;
+    /**
+     * Is the field disabled?
+     */
+    disabled?: boolean;
+    /**
+     * Does the input contain a clear button?
+     */
+    hasClearButton?: boolean;
+    /**
+     * Does the input contain the search shortcut?
+     * Only valid if the input type is `search`.
+     */
+    hasSearchShortcut?: boolean;
+    /**
+     * Input ID.
+     */
+    id: string;
+    /**
+     * 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;
+    /**
+     * onBlur event handler.
+     */
+    onBlur?: (e: FocusEvent<HTMLInputElement>) => void;
+    /**
+     * onChange event handler. Controlled inputs should use this to manage the input value. Uncontrolled inputs will manage their own state, but may still use this to access the event object.
+     */
+    onChange?: (e: ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * Function to clear the input field. Only necessary if the input is controlled. This functionality is built-in for uncontrolled inputs.
+     */
+    onClear?: () => void;
+    /**
+     * onFocus event handler.
+     */
+    onFocus?: (e: FocusEvent<HTMLInputElement>) => void;
+    /**
+     * Optional placeholder text to display when the input field is empty.
+     */
+    placeholder?: string;
+    /**
+     * Is the field read-only?
+     */
+    readonly?: boolean;
+    /**
+     * Is this field required?
+     */
+    required?: boolean;
+    /**
+     * Should the label be visible? If false, it will render for screen readers only.
+     */
+    showLabel?: boolean;
+    /**
+     * Show Toggle visibility control for input. Valid for type `password` only.
+     */
+    showVisibilityToggle?: boolean;
+    /**
+     * Translation strings for various labels or other visually-hidden text.
+     */
+    translationStrings?: TranslationStringProps;
+    /**
+     * Type of input field to use.
+     */
+    type: HtmlInputTypes;
+    /**
+     * Validation message for the input field based on the validation status.
+     */
+    validationMessage?: string;
+    /**
+     * Validation status of the input field.
+     */
+    validationStatus?: ValidationStatus;
+    /**
+     * Value of the input field. Used to set the value of the input field when controlled. Cannot be used in conjunction with the `defaultValue` prop.
+     */
+    value?: string;
+    /**
+     * Additional class names for input.
+     */
+    className?: string;
+}
+/**
+ * TextInput UI component
+ */
+export declare const TextInput: React.ForwardRefExoticComponent<TextInputProps & React.RefAttributes<HTMLInputElement>>;
+export {};