@ansible/ansible-ui-framework 0.0.0

package/framework/PageForm/typesErrorAdapter.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+export interface GenericErrorDetail {
+    message: string | React.ReactNode;
+}
+export interface FieldErrorDetail extends GenericErrorDetail {
+    name: string;
+}
+export interface ErrorOutput {
+    genericErrors: GenericErrorDetail[];
+    fieldErrors: FieldErrorDetail[];
+}
+export type ErrorAdapter = (error: unknown, mappedKeys?: Record<string, string>) => ErrorOutput;

package/framework/PageFramework.d.ts

@@ -0,0 +1,5 @@
+import './PageFramework.css';
+import { ReactNode } from 'react';
+export declare function PageFramework(props: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/framework/PageHeader.d.ts

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

package/framework/PageInputs/PageAsyncMultiSelect.cy.d.ts

@@ -0,0 +1 @@
+export {};

package/framework/PageInputs/PageAsyncMultiSelect.d.ts

@@ -0,0 +1,13 @@
+import { PageMultiSelectProps } from './PageMultiSelect';
+import { PageSelectOption } from './PageSelectOption';
+export interface PageAsyncMultiSelectQueryResult<ValueT> {
+    total: number;
+    options: PageSelectOption<ValueT>[];
+}
+export type PageAsyncMultiSelectOptionsFn<ValueT> = (page: number, signal: AbortSignal) => Promise<PageAsyncMultiSelectQueryResult<ValueT>>;
+export interface PageAsyncMultiSelectProps<ValueT> extends Omit<PageMultiSelectProps<ValueT>, 'options'> {
+    queryOptions: PageAsyncMultiSelectOptionsFn<ValueT>;
+    queryPlaceholder?: string;
+    queryErrorText?: string | ((error: Error) => string);
+}
+export declare function PageAsyncMultiSelect<ValueT>(props: PageAsyncMultiSelectProps<ValueT>): import("react/jsx-runtime").JSX.Element;

package/framework/PageInputs/PageAsyncSingleSelect.cy.d.ts

@@ -0,0 +1 @@
+export {};

package/framework/PageInputs/PageAsyncSingleSelect.d.ts

@@ -0,0 +1,14 @@
+import { PageSelectOption } from './PageSelectOption';
+import { PageSingleSelectProps } from './PageSingleSelect';
+export interface PageAsyncSingleSelectQueryResult<ValueT> {
+    total: number;
+    options: PageSelectOption<ValueT>[];
+}
+export type PageAsyncSingleSelectOptionsFn<ValueT> = (page: number, signal: AbortSignal) => Promise<PageAsyncSingleSelectQueryResult<ValueT>>;
+export type PageAsyncQueryErrorTextType = string | ((error: Error) => string);
+export interface PageAsyncSingleSelectProps<ValueT> extends Omit<PageSingleSelectProps<ValueT>, 'options'> {
+    queryOptions: PageAsyncSingleSelectOptionsFn<ValueT>;
+    queryPlaceholder?: string;
+    queryErrorText?: PageAsyncQueryErrorTextType;
+}
+export declare function PageAsyncSingleSelect<ValueT>(props: PageAsyncSingleSelectProps<ValueT>): import("react/jsx-runtime").JSX.Element;

package/framework/PageInputs/PageMultiSelect.cy.d.ts

@@ -0,0 +1 @@
+export {};

package/framework/PageInputs/PageMultiSelect.d.ts

@@ -0,0 +1,17 @@
+import { ReactNode } from 'react';
+import { PageSelectOption } from './PageSelectOption';
+export interface PageMultiSelectProps<ValueT> {
+    id?: string;
+    icon?: ReactNode;
+    placeholder: ReactNode;
+    isDisabled?: boolean;
+    values: ValueT[] | undefined | null;
+    onSelect: (setter: (currentValues: ValueT[] | undefined) => ValueT[] | undefined) => void;
+    options: PageSelectOption<ValueT>[];
+    variant?: 'chips' | 'count';
+    footer?: ReactNode;
+    disableClearSelection?: boolean;
+    disableClearChips?: boolean;
+    maxChipSize?: string;
+}
+export declare function PageMultiSelect<ValueT>(props: PageMultiSelectProps<ValueT>): import("react/jsx-runtime").JSX.Element;

package/framework/PageInputs/PageSelectOption.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+export interface PageSelectOption<ValueT> {
+    key?: string | number;
+    value: ValueT;
+    icon?: ReactNode;
+    label: string;
+    description?: string | null | undefined;
+    group?: string;
+}

package/framework/PageInputs/PageSingleSelect.cy.d.ts

@@ -0,0 +1 @@
+export {};

package/framework/PageInputs/PageSingleSelect.d.ts

@@ -0,0 +1,29 @@
+import { ReactNode } from 'react';
+import { PageSelectOption } from './PageSelectOption';
+export interface PageSingleSelectProps<ValueT> {
+    id?: string;
+    icon?: ReactNode;
+    placeholder: ReactNode;
+    value: ValueT;
+    onSelect: (value: ValueT) => void;
+    options: PageSelectOption<ValueT>[];
+    footer?: ReactNode;
+    isRequired?: boolean;
+    isDisabled?: boolean;
+}
+export declare function PageSingleSelect<ValueT>(props: PageSingleSelectProps<ValueT>): import("react/jsx-runtime").JSX.Element;
+export declare function PageSingleSelectList(props: {
+    searchRef: React.RefObject<HTMLInputElement>;
+    options: PageSelectOption<unknown>[];
+}): import("react/jsx-runtime").JSX.Element;
+export declare const PageSingleSelectContext: import("react").Context<{
+    open: boolean;
+    setOpen: (open: boolean) => void;
+}>;
+export declare function usePageSingleSelectContext(): {
+    open: boolean;
+    setOpen: (open: boolean) => void;
+};
+export declare function PageSingleSelectProvider(props: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/framework/PageLayout.d.ts

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

package/framework/PageMasonry.d.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from 'react';
+export declare function Masonry(props: {
+    minSize: number;
+    maxColumns?: number;
+    children?: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/framework/PageMasthead/PageMasthead.d.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from 'react';
+export declare function PageMasthead(props: {
+    brand: ReactNode;
+    children?: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function PageMastheadToggle(): import("react/jsx-runtime").JSX.Element;

package/framework/PageMasthead/PageMastheadDropdown.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+export declare function PageMastheadDropdown(props: {
+    id: string;
+    icon: ReactNode;
+    label?: string;
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/framework/PageMasthead/PageNotificationsIcon.d.ts

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

package/framework/PageMasthead/PageSettingsIcon.d.ts

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

package/framework/PageMasthead/PageThemeSwitcher.d.ts

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

package/framework/PageNavigation/PageApp.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+import { PageNavigationItem } from './PageNavigationItem';
+export declare function PageApp(props: {
+    login: ReactNode;
+    root: ReactNode;
+    masthead?: ReactNode;
+    navigation: PageNavigationItem[];
+    basename?: string;
+}): import("react/jsx-runtime").JSX.Element;

package/framework/PageNavigation/PageNavSidebar.d.ts

@@ -0,0 +1,12 @@
+import { ReactNode } from 'react';
+interface PageNavSideBarState {
+    isOpen: boolean;
+    setState: (state: Partial<PageNavSideBarState>) => void;
+}
+export declare const PageNavSideBarContext: import("react").Context<PageNavSideBarState>;
+export declare function usePageNavSideBar(): PageNavSideBarState;
+export declare function PageNavSideBarProvider(props: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function usePageNavBarClick(): (path: string) => void;
+export {};

package/framework/PageNavigation/PageNavigation.d.ts

@@ -0,0 +1,5 @@
+import './PageNavigation.css';
+import { PageNavigationItem } from './PageNavigationItem';
+export declare function PageNavigation(props: {
+    navigation: PageNavigationItem[];
+}): import("react/jsx-runtime").JSX.Element;

package/framework/PageNavigation/PageNavigationItem.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="react" />
+interface PageNavigationGroup {
+    id?: string;
+    label?: string;
+    subtitle?: string;
+    path: string;
+    children: PageNavigationItem[];
+    hidden?: boolean;
+}
+interface PageNavigationComponent {
+    id?: string;
+    label?: string;
+    subtitle?: string;
+    path: string;
+    element: JSX.Element;
+    hidden?: boolean;
+}
+export type PageNavigationItem = PageNavigationGroup | PageNavigationComponent;
+export declare function removeLeadingSlash(path: string): string;
+export declare function findNavigationItemById(navigationItems: PageNavigationItem[], id: string): PageNavigationItem | undefined;
+export declare function removeNavigationItemById(navigationItems: PageNavigationItem[], id: string): PageNavigationItem | undefined;
+export declare function addNavigationItem(navigationItems: PageNavigationItem[], parentId: string, newItem: PageNavigationItem): void;
+export declare function addNavigationItemAfter(navigationItems: PageNavigationItem[], afterId: string, newItem: PageNavigationItem): void;
+export declare function addNavigationItemBefore(navigationItems: PageNavigationItem[], beforeId: string, newItem: PageNavigationItem): void;
+export {};

package/framework/PageNavigation/PageNavigationRoutesProvider.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+import { PageNavigationItem } from './PageNavigationItem';
+export declare function usePageNavigationRoutes(): {
+    [key: string]: string;
+};
+export declare function PageNavigationRoutesProvider(props: {
+    children: ReactNode;
+    navigation: PageNavigationItem[];
+}): import("react/jsx-runtime").JSX.Element;

package/framework/PageNavigation/useGetPageUrl.d.ts

@@ -0,0 +1,4 @@
+export declare function useGetPageUrl(): (id: string, options?: {
+    params?: Record<string, string | number | undefined>;
+    query?: Record<string, string | number | undefined>;
+}) => string;

package/framework/PageNavigation/usePageNavigate.d.ts

@@ -0,0 +1,4 @@
+export declare function usePageNavigate(): (pageId: string, options?: {
+    params?: Record<string, string | number | undefined>;
+    query?: Record<string, string | number | undefined>;
+}) => void;

package/framework/PageNotifications/PageNotificationsProvider.cy.d.ts

@@ -0,0 +1 @@
+export {};

package/framework/PageNotifications/PageNotificationsProvider.d.ts

@@ -0,0 +1,27 @@
+import { Dispatch, ReactNode, SetStateAction } from 'react';
+interface IPageNotifications {
+    notificationsDrawerOpen: boolean;
+    setNotificationsDrawerOpen: Dispatch<SetStateAction<boolean>>;
+    notificationGroups: Record<string, IPageNotificationGroup>;
+    setNotificationGroups: Dispatch<SetStateAction<Record<string, IPageNotificationGroup>>>;
+}
+export interface IPageNotificationGroup {
+    title: string;
+    notifications: IPageNotification[];
+}
+export interface IPageNotification {
+    title: string;
+    description?: string | undefined;
+    timestamp?: string;
+    variant?: 'success' | 'danger' | 'warning' | 'info';
+    to: string;
+}
+export declare const PageNotificationsContext: import("react").Context<IPageNotifications>;
+export declare function usePageNotifications(): IPageNotifications;
+export declare function PageNotificationsProvider(props: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function PageNotificationsDrawer(props: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export {};

package/framework/PageTable/PageLoadingTable.d.ts

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

package/framework/PageTable/PagePagination.d.ts

@@ -0,0 +1,13 @@
+import { PerPageOptions } from '@patternfly/react-core';
+import { CSSProperties } from 'react';
+export type PagePaginationProps = {
+    itemCount?: number;
+    page: number;
+    perPage: number;
+    setPage: (page: number) => void;
+    setPerPage: (perPage: number) => void;
+    style?: CSSProperties;
+    topBorder?: boolean;
+    perPageOptions?: PerPageOptions[];
+};
+export declare function PagePagination(props: PagePaginationProps): import("react/jsx-runtime").JSX.Element;

package/framework/PageTable/PageTable.d.ts

@@ -0,0 +1,65 @@
+import { PerPageOptions } from '@patternfly/react-core';
+import { Dispatch, ReactNode, SetStateAction } from 'react';
+import { IPageAction } from '../PageActions/PageAction';
+import { PageTableViewType } from '../PageToolbar/PageTableViewType';
+import { IFilterState, IToolbarFilter } from '../PageToolbar/PageToolbarFilter';
+import { ITableColumn } from './PageTableColumn';
+export type PageTableProps<T extends object> = {
+    id?: string;
+    keyFn: (item: T) => string | number;
+    itemCount?: number;
+    pageItems: T[] | undefined;
+    toolbarActions?: IPageAction<T>[];
+    tableColumns: ITableColumn<T>[];
+    rowActions?: IPageAction<T>[];
+    toolbarFilters?: IToolbarFilter[];
+    filterState?: IFilterState;
+    setFilterState?: Dispatch<SetStateAction<IFilterState>>;
+    clearAllFilters?: () => void;
+    page: number;
+    perPage: number;
+    setPage: (page: number) => void;
+    setPerPage: (perPage: number) => void;
+    perPageOptions?: PerPageOptions[];
+    sort?: string;
+    setSort?: (sort: string) => void;
+    sortDirection?: 'asc' | 'desc';
+    setSortDirection?: (sortDirection: 'asc' | 'desc') => void;
+    compact?: boolean;
+    autoHidePagination?: boolean;
+    isSelected?: (item: T) => boolean;
+    isSelectMultiple?: boolean;
+    selectedItems?: T[];
+    selectItem?: (item: T) => void;
+    unselectItem?: (item: T) => void;
+    selectItems?: (items: T[]) => void;
+    unselectAll?: () => void;
+    onSelect?: (item: T) => void;
+    errorStateTitle: string;
+    error?: Error;
+    emptyStateTitle: string;
+    emptyStateDescription?: string | null;
+    emptyStateIcon?: React.ComponentType<any>;
+    emptyStateActions?: IPageAction<T>[];
+    emptyStateButtonIcon?: React.ReactNode;
+    emptyStateButtonText?: string | null;
+    emptyStateButtonClick?: () => void;
+    emptyStateVariant?: 'default' | 'light' | 'dark' | 'darker';
+    showSelect?: boolean;
+    disableTableView?: boolean;
+    disableListView?: boolean;
+    disableCardView?: boolean;
+    defaultTableView?: PageTableViewType;
+    hideTable?: boolean;
+    disableBodyPadding?: boolean;
+    disablePagination?: boolean;
+    defaultSubtitle?: ReactNode;
+    expandedRow?: (item: T) => ReactNode;
+    disableLastRowBorder?: boolean;
+    maxSelections?: number;
+    topContent?: React.ReactNode;
+    toolbarContent?: React.ReactNode;
+    scrollTopContent?: boolean;
+    limitFiltersToOneOrOperation?: boolean;
+};
+export declare function PageTable<T extends object>(props: PageTableProps<T>): import("react/jsx-runtime").JSX.Element;

package/framework/PageTable/PageTableCard.d.ts

@@ -0,0 +1,39 @@
+import { ReactNode } from 'react';
+import { IPageAction } from '../PageActions/PageAction';
+import { LabelColor } from '../components/pfcolors';
+import { ITableColumn } from './PageTableColumn';
+export declare const Small: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLElement>, HTMLElement>, never>>;
+export interface IPageTableCard {
+    id: string | number;
+    icon?: ReactNode;
+    title: ReactNode;
+    iconAboveTitle?: boolean;
+    subtitle?: ReactNode;
+    cardBody: ReactNode;
+    labels?: {
+        label: string;
+        color?: LabelColor;
+        icon?: ReactNode;
+        variant?: 'outline' | 'filled' | undefined;
+    }[];
+    badge?: string;
+    badgeColor?: LabelColor;
+    badgeTooltip?: string;
+    badgeTooltipTitle?: string;
+    alertTitle?: string;
+    alertContent?: ReactNode;
+    alertVariant?: 'success' | 'danger' | 'warning' | 'info' | 'custom';
+}
+export declare const PageDetailDiv: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>;
+export declare const ColumnsDiv: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>;
+export declare function PageTableCard<T extends object>(props: {
+    item: T;
+    itemToCardFn: (item: T) => IPageTableCard;
+    isSelected?: (item: T) => boolean;
+    selectItem?: (item: T) => void;
+    unselectItem?: (item: T) => void;
+    itemActions?: IPageAction<T>[];
+    showSelect?: boolean;
+    defaultCardSubtitle?: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useColumnsToTableCardFn<T extends object>(columns: ITableColumn<T>[], keyFn: (item: T) => string | number): (item: T) => IPageTableCard;

package/framework/PageTable/PageTableCards.d.ts

@@ -0,0 +1,3 @@
+import { PageTableProps } from './PageTable';
+export type PageTableCardsProps<T extends object> = PageTableProps<T>;
+export declare function PageTableCards<T extends object>(props: PageTableCardsProps<T>): import("react/jsx-runtime").JSX.Element;