@ansible/ansible-ui-framework 2.4.396 → 2.4.397

package/framework/PageToolbar/PageToolbarFilters/ToolbarAsyncSelectFilterBuilder.d.ts

@@ -0,0 +1,21 @@
+import { ITableColumn, IToolbarFilter, ISelected } from '../../../framework';
+import { IView, ViewExtendedOptions } from '../../useView';
+type BaseView<T extends object> = IView & ISelected<T> & {
+    itemCount: number | undefined;
+    pageItems: T[] | undefined;
+    refresh: () => Promise<void>;
+};
+export type AsyncSelectFilterBuilderProps<T extends object> = {
+    title: string;
+    tableColumns: ITableColumn<T>[];
+    toolbarFilters?: IToolbarFilter[];
+    viewParams: ViewExtendedOptions<T>;
+    useView: (viewParams: ViewExtendedOptions<T>) => BaseView<T>;
+};
+export declare function useAsyncSingleSelectFilterBuilder<T extends object>(props: AsyncSelectFilterBuilderProps<T>): {
+    onBrowse: (onSelect: (value: T) => void, defaultSelection?: T) => void;
+};
+export declare function useAsyncMultiSelectFilterBuilder<T extends object>(props: AsyncSelectFilterBuilderProps<T>): {
+    onBrowse: (onSelect: (value: T[]) => void, defaultSelection?: T[]) => void;
+};
+export {};

package/framework/useView.d.ts

@@ -1,5 +1,6 @@
 import { Dispatch, SetStateAction } from 'react';
 import { IFilterState } from './PageToolbar/PageToolbarFilter';
+import { ITableColumn, IToolbarFilter } from '../framework';
 export interface IView {
     page: number;
     setPage: (page: number) => void;
@@ -13,9 +14,23 @@ export interface IView {
     setFilterState: Dispatch<SetStateAction<IFilterState>>;
     clearAllFilters: () => void;
 }
-export declare function useView(options: {
+export interface ViewOptions {
     defaultValues?: Partial<Pick<IView, 'filterState' | 'sort' | 'sortDirection'>> | undefined;
     disableQueryString?: boolean;
     ignoreQueryStringKeys?: string[];
     filterQueryStringKeys?: string[];
-}): IView;
+}
+export type QueryParams = {
+    [key: string]: string;
+};
+export interface ViewExtendedOptions<T extends object> extends ViewOptions {
+    url: string;
+    keyFn: (item: T) => string | number;
+    toolbarFilters?: IToolbarFilter[];
+    tableColumns?: ITableColumn<T>[];
+    disableQueryString?: boolean;
+    queryParams?: QueryParams;
+    sortKey?: string;
+    defaultFilters?: Record<string, string[]>;
+}
+export declare function useView(options: ViewOptions): IView;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ansible/ansible-ui-framework",
   "description": "A framework for building applications using PatternFly.",
-  "version": "2.4.396",
+  "version": "2.4.397",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",