@ansible/ansible-ui-framework 0.0.614 → 0.0.616

package/framework/BulkActionDialog.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { ITableColumn } from './PageTable/PageTable';
+export interface BulkActionDialogProps<T extends object> {
+    title: string;
+    items: T[];
+    keyFn: (item: T) => string | number;
+    actionColumns: ITableColumn<T>[];
+    actionFn: (item: T, signal: AbortSignal) => Promise<unknown>;
+    onComplete?: (successfulItems: T[]) => void;
+    onClose?: () => void;
+    processingText?: string;
+    isDanger?: boolean;
+}
+export declare function useBulkActionDialog<T extends object>(): import("react").Dispatch<import("react").SetStateAction<BulkActionDialogProps<T> | undefined>>;

package/framework/BulkConfirmationDialog.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { BulkActionDialogProps } from './BulkActionDialog';
+import { ITableColumn } from './PageTable/PageTable';
+export interface BulkConfirmationDialog<T extends object> {
+    title: string;
+    prompt?: string;
+    alertPrompts?: string[];
+    items: T[];
+    isItemNonActionable?: (item: T) => string | undefined;
+    keyFn: (item: T) => string | number;
+    confirmationColumns: ITableColumn<T>[];
+    onConfirm: () => void;
+    onClose?: () => void;
+    confirmText: string;
+    actionButtonText: string;
+    isDanger?: boolean;
+}
+declare function BulkConfirmationDialog<T extends object>(props: BulkConfirmationDialog<T>): JSX.Element;
+export declare function useBulkConfirmation<T extends object>(): (options: Omit<BulkConfirmationDialog<T>, 'onConfirm' | 'onClose'> & Omit<BulkActionDialogProps<T>, 'onClose'>) => void;
+export {};

package/{cjs → framework}/PageActions/PageActions.d.ts

@@ -2,26 +2,13 @@ import { DropdownPosition } from '@patternfly/react-core';
 import { ComponentClass, FunctionComponent } from 'react';
 import { WindowSize } from '../components/useBreakPoint';
 import { IPageAction } from './PageAction';
-/**
- * Page actions represent actions used in table rows, toolbars, and page headers.
- * The PageActions component controls the collapsing of the actions at given breakpoints.
- */
 export declare function PageActions<T extends object>(props: {
-    /** An array of PageActions */
     actions: IPageAction<T>[];
-    /** The currently selected item for single actions */
     selectedItem?: T;
-    /** The currently selected items for bulk actions */
     selectedItems?: T[];
-    /** The wrapper for each item
-     * @example Wrapping each button in a ToolbarItem
-     */
     wrapper?: ComponentClass | FunctionComponent;
-    /** When to collapse the primary and secondary items into the dropdown menu */
     collapse?: WindowSize | 'always' | 'never';
-    /** The position for the dropdown */
     position?: DropdownPosition;
-    /** Indicates if only to show the icon when not collapsed */
     iconOnly?: boolean;
     onOpen?: (open: boolean) => void;
 }): JSX.Element;

package/{cjs → framework}/PageActions/PageButtonAction.d.ts

@@ -2,7 +2,6 @@ import { ComponentClass, FunctionComponent } from 'react';
 import { IPageActionButton } from './PageAction';
 export declare function PageButtonAction(props: {
     action: IPageActionButton;
-    /** Turn primary buttons to secondary if there are items selected */
     isSecondary?: boolean;
     wrapper?: ComponentClass | FunctionComponent;
     iconOnly?: boolean;

package/{cjs → framework}/PageActions/PagePinnedActions.d.ts

@@ -5,10 +5,6 @@ export declare function PagePinnedActions<T extends object>(props: {
     selectedItem?: T;
     selectedItems?: T[];
     wrapper?: ComponentClass | FunctionComponent;
-    /**
-     * indicates to only show the icon for the action
-     * Example: Table rows only show the icon but toolbars and details page actions show label
-     */
     iconOnly?: boolean;
 }): JSX.Element;
 export declare function PagePinnedAction<T extends object>(props: {

package/{cjs → framework}/PageForm/Inputs/FormGroupSelect.d.ts

@@ -5,5 +5,4 @@ export type FormGroupSelectProps = Pick<SelectProps, 'footer' | 'isCreatable' |
     isReadOnly?: boolean;
     placeholderText: string | React.ReactNode;
 };
-/** A PatternFly FormGroup with a PatternFly Select */
 export declare function FormGroupSelect(props: FormGroupSelectProps): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/FormGroupSelectOption.d.ts

@@ -12,9 +12,4 @@ export type FormGroupSelectOptionProps<T> = {
     onSelect: (event: React.MouseEvent<Element, MouseEvent> | ChangeEvent<Element>, value: T | undefined) => void;
     value: T | undefined;
 } & Omit<FormGroupSelectProps, 'onSelect' | 'value' | 'children'>;
-/**
- * A PatternFly FormGroup with a PatternFly Select but using IFormGroupSelectOptions for the options.
- *
- * This supports easy grouping and options that have values that are objects and not just strings.
- */
 export declare function FormGroupSelectOption<T>(props: FormGroupSelectOptionProps<T>): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/FormGroupTextArea.d.ts

@@ -2,5 +2,4 @@
 import { TextAreaProps } from '@patternfly/react-core';
 import { PageFormGroupProps } from './PageFormGroup';
 export type FormGroupTextAreaProps = Pick<TextAreaProps, 'placeholder' | 'value' | 'isDisabled' | 'isReadOnly' | 'isRequired' | 'validated' | 'onChange' | 'type' | 'aria-label' | 'minLength' | 'maxLength'> & PageFormGroupProps;
-/** A PatternFly FormGroup with a PatternFly TextArea */
 export declare function FormGroupTextArea(props: FormGroupTextAreaProps): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/FormGroupTextInput.d.ts

@@ -4,5 +4,4 @@ import { PageFormGroupProps } from './PageFormGroup';
 export type FormGroupTextInputProps = Pick<TextInputProps, 'placeholder' | 'value' | 'isDisabled' | 'isReadOnly' | 'isRequired' | 'validated' | 'onChange' | 'type' | 'aria-label' | 'autoComplete' | 'autoFocus' | 'innerRef' | 'minLength' | 'maxLength' | 'onBlur'> & PageFormGroupProps & {
     children?: ReactNode;
 };
-/** A PatternFly FormGroup with a PatternFly TextInput */
 export declare function FormGroupTextInput(props: FormGroupTextInputProps): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/FormGroupTypeAheadMultiSelect.d.ts

@@ -21,5 +21,4 @@ export type FormGroupTypeAheadMultiSelectProps = Pick<FormGroupProps, 'helperTex
     }>[];
     onHandleClear: (chip?: string) => void;
 };
-/** A PatternFly FormGroup with a PatternFly Select */
 export declare function FormGroupTypeAheadMultiSelect(props: FormGroupTypeAheadMultiSelectProps): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/PageFormCheckbox.d.ts

@@ -6,5 +6,4 @@ export type PageFormCheckboxProps<TFieldValues extends FieldValues = FieldValues
     name: TFieldName;
     validate?: Validate<boolean, TFieldValues> | Record<string, Validate<boolean, TFieldValues>>;
 } & Omit<CheckboxProps, 'id' | 'onChange' | 'value'>;
-/** PatternFly Checkbox wrapper for use with react-hook-form */
 export declare function PageFormCheckbox<TFieldValues extends FieldValues = FieldValues, TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: PageFormCheckboxProps<TFieldValues, TFieldName>): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/PageFormCreatableSelect.d.ts

@@ -17,5 +17,4 @@ export type PageFormCreatableSelectProps<TFieldValues extends FieldValues = Fiel
     labelHelpTitle?: string;
     validate?: Validate<FieldPathValue<TFieldValues, TFieldName>, TFieldValues> | Record<string, Validate<FieldPathValue<TFieldValues, TFieldName>, TFieldValues>>;
 };
-/**  Select wrapper for use with react-hook-form */
 export declare function PageFormCreatableSelect<TFieldValues extends FieldValues = FieldValues, TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: PageFormCreatableSelectProps<TFieldValues, TFieldName>): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/PageFormFileUpload.d.ts

@@ -5,5 +5,4 @@ export type PageFormFileUploadProps = {
     isReadOnly?: boolean;
     placeholder?: string;
 } & PageFormGroupProps;
-/** PatternFly Select wrapper for use with react-hook-form */
 export declare function PageFormFileUpload(props: PageFormFileUploadProps): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/PageFormGroup.d.ts

@@ -6,5 +6,4 @@ export type PageFormGroupProps = Pick<FormGroupProps, 'children' | 'helperText'
     labelHelp?: string;
     additionalControls?: ReactNode;
 };
-/** Wrapper over the PatternFly FormGroup making it optional based on if label is given. */
 export declare function PageFormGroup(props: PageFormGroupProps): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/PageFormSelect.d.ts

@@ -3,5 +3,4 @@ import { FormGroupSelectProps } from './FormGroupSelect';
 export type PageFormSelectProps = {
     name: string;
 } & Omit<FormGroupSelectProps, 'onSelect' | 'value'>;
-/** PatternFly Select wrapper for use with react-hook-form */
 export declare function PageFormSelect(props: PageFormSelectProps): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/PageFormSelectOption.d.ts

@@ -5,5 +5,4 @@ export type PageFormSelectOptionProps<TFieldValues extends FieldValues = FieldVa
     name: TFieldName;
     validate?: Validate<FieldPathValue<TFieldValues, TFieldName>, TFieldValues> | Record<string, Validate<FieldPathValue<TFieldValues, TFieldName>, TFieldValues>>;
 } & Omit<FormGroupSelectOptionProps<TSelection>, 'onSelect' | 'value'>;
-/**  Select wrapper for use with react-hook-form */
 export declare function PageFormSelectOption<TFieldValues extends FieldValues = FieldValues, TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>, TSelection = unknown>(props: PageFormSelectOptionProps<TFieldValues, TFieldName, TSelection>): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/PageFormTextArea.d.ts

@@ -8,5 +8,4 @@ export type PageFormTextAreaProps<TFieldValues extends FieldValues = FieldValues
     pattern?: ValidationRule<RegExp>;
     validate?: Validate<string, TFieldValues> | Record<string, Validate<string, TFieldValues>>;
 } & Omit<FormGroupTextAreaProps, 'onChange' | 'value'>;
-/** PatternFly TextArea wrapper for use with react-hook-form */
 export declare function PageFormTextArea<TFieldValues extends FieldValues = FieldValues, TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: PageFormTextAreaProps<TFieldValues, TFieldName>): JSX.Element;

package/{cjs → framework}/PageForm/Inputs/PageFormTextInput.d.ts

@@ -12,5 +12,4 @@ export type PageFormTextInputProps<TFieldValues extends FieldValues = FieldValue
     selectOpen?: (callback: (selection: TSelection) => void, title: string) => void;
     button?: ReactElement;
 } & Omit<FormGroupTextInputProps, 'onChange' | 'value'>;
-/** PatternFly TextInput wrapper for use with react-hook-form */
 export declare function PageFormTextInput<TFieldValues extends FieldValues = FieldValues, TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>, TSelection extends FieldValues = FieldValues>(props: PageFormTextInputProps<TFieldValues, TFieldName, TSelection>): JSX.Element;

package/{cjs → framework}/PageForm/PageFormSchema.d.ts

@@ -8,13 +8,11 @@ export declare function PageFormSchema(props: {
 }): JSX.Element;
 export type TypeTextInputOptions = StringOptions<string> & {
     placeholder?: string;
-    /** https://www.chromium.org/developers/design-documents/create-amazing-password-forms/ */
     autoComplete?: string;
 };
 export declare function TypeTextInput(options: TypeTextInputOptions): import("@sinclair/typebox").TString<string>;
 export type TypeSecretInputOptions = StringOptions<string> & {
     placeholder?: string;
-    /** https://www.chromium.org/developers/design-documents/create-amazing-password-forms/ */
     autoComplete: string;
 };
 export declare function TypeSecretInput(options: TypeSecretInputOptions): import("@sinclair/typebox").TString<string>;

package/framework/PageFramework.d.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from 'react';
+import './PageFramework.css';
+export declare function PageFramework(props: {
+    children: ReactNode;
+    navigate?: (to: string) => void;
+}): JSX.Element;

package/framework/PageHeader.d.ts

@@ -0,0 +1,22 @@
+import { ReactNode } from 'react';
+import './PageFramework.css';
+export interface ICatalogBreadcrumb {
+    id?: string;
+    label?: string;
+    to?: string;
+    target?: string;
+    component?: React.ElementType;
+}
+export interface PageHeaderProps {
+    navigation?: ReactNode;
+    breadcrumbs?: ICatalogBreadcrumb[];
+    title?: string;
+    titleHelpTitle?: string;
+    titleHelp?: string | string[];
+    titleDocLink?: string;
+    description?: null | string | string[];
+    controls?: ReactNode;
+    headerActions?: ReactNode;
+    footer?: ReactNode;
+}
+export declare function PageHeader(props: PageHeaderProps): JSX.Element;

package/framework/PageLayout.d.ts

@@ -0,0 +1,4 @@
+import { ReactNode } from 'react';
+export declare function PageLayout(props: {
+    children?: ReactNode;
+}): JSX.Element;

package/{cjs → framework}/PageTable/PageTable.d.ts

@@ -35,10 +35,10 @@ export type PageTableProps<T extends object> = {
     errorStateTitle: string;
     error?: Error;
     emptyStateTitle: string;
-    emptyStateDescription?: string;
+    emptyStateDescription?: string | null;
     emptyStateIcon?: React.ComponentType<any>;
     emptyStateButtonIcon?: React.ReactNode;
-    emptyStateButtonText?: string;
+    emptyStateButtonText?: string | null;
     emptyStateButtonClick?: () => void;
     showSelect?: boolean;
     disableTableView?: boolean;
@@ -50,21 +50,6 @@ export type PageTableProps<T extends object> = {
     defaultSubtitle?: ReactNode;
     expandedRow?: (item: T) => ReactNode;
 };
-/**
- * The PageTable component is used for adding a table to a page.
- *
- * See the [Table Guide](docs/guides/PageTableGuide.md).
- *
- * @example
- * ```tsx
- * <Page>
- *   <PageLayout>
- *     <PageHeader ... />
- *     <PageTable ... />
- *   </PageLayout>
- * </Page>
- * ```
- */
 export declare function PageTable<T extends object>(props: PageTableProps<T>): JSX.Element;
 type CellFn<T extends object, R> = (item: T) => R;
 export interface ITableColumnCommon<T extends object> {

package/{cjs → framework}/components/useBreakPoint.d.ts

@@ -1,5 +1,4 @@
 export type WindowSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
 export declare function useWindowSize(): WindowSize;
-/** Returns true if the window size is equal to or larger than the indicated size. */
 export declare function useBreakpoint(size: WindowSize): boolean;
 export declare function useOrientation(): 'landscape' | 'portrait';

package/{cjs → framework}/index.d.ts

@@ -28,6 +28,7 @@ export * from './PageForm/Inputs/FormGroupSelectOption';
 export * from './PageForm/Inputs/FormGroupTextArea';
 export * from './PageForm/Inputs/FormGroupTextInput';
 export * from './PageForm/Inputs/PageFormCheckbox';
+export * from './PageForm/Inputs/PageFormCodeEditor';
 export * from './PageForm/Inputs/PageFormSelect';
 export * from './PageForm/Inputs/PageFormSelectOption';
 export * from './PageForm/Inputs/PageFormSwitch';

package/{cjs → framework}/utils/compare.d.ts

@@ -1,3 +1,3 @@
-export declare function compareUnknowns(a: unknown | undefined | null, b: unknown | undefined | null): 0 | 1 | -1;
-export declare function compareStrings(a: string | undefined | null, b: string | undefined | null): 0 | 1 | -1;
-export declare function compareNumbers(a: number | undefined | null, b: number | undefined | null): 0 | 1 | -1;
+export declare function compareUnknowns(a: unknown | undefined | null, b: unknown | undefined | null): 1 | -1 | 0;
+export declare function compareStrings(a: string | undefined | null, b: string | undefined | null): 1 | -1 | 0;
+export declare function compareNumbers(a: number | undefined | null, b: number | undefined | null): 1 | -1 | 0;