Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
40 lines
1.8 KiB
Plaintext
40 lines
1.8 KiB
Plaintext
import type { CollectionSlug, Data, ListQuery } from 'payload';
|
|
import type { useSelection } from '../../providers/Selection/index.js';
|
|
import type { UseDocumentDrawer } from '../DocumentDrawer/types.js';
|
|
import type { Option } from '../ReactSelect/index.js';
|
|
export type ListDrawerContextProps = {
|
|
readonly allowCreate?: boolean;
|
|
readonly createNewDrawerSlug?: string;
|
|
readonly DocumentDrawerToggler?: ReturnType<UseDocumentDrawer>[1];
|
|
readonly drawerSlug?: string;
|
|
readonly enabledCollections?: CollectionSlug[];
|
|
readonly onBulkSelect?: (selected: ReturnType<typeof useSelection>['selected']) => void;
|
|
readonly onQueryChange?: (query: ListQuery) => void;
|
|
readonly onSelect?: (args: {
|
|
collectionSlug: CollectionSlug;
|
|
doc: Data;
|
|
/**
|
|
* @deprecated
|
|
* The `docID` property is deprecated and will be removed in the next major version of Payload.
|
|
* Use `doc.id` instead.
|
|
*/
|
|
docID: string;
|
|
}) => void;
|
|
readonly selectedOption?: Option<CollectionSlug>;
|
|
readonly setSelectedOption?: (option: Option<CollectionSlug>) => void;
|
|
};
|
|
export type ListDrawerContextType = {
|
|
readonly isInDrawer: boolean;
|
|
/**
|
|
* When called, will either refresh the list view with its currently selected collection.
|
|
* If an collection slug is provided, will use that instead of the currently selected one.
|
|
*/
|
|
readonly refresh: (collectionSlug?: CollectionSlug) => Promise<void>;
|
|
} & ListDrawerContextProps;
|
|
export declare const ListDrawerContext: import("react").Context<ListDrawerContextType>;
|
|
export declare const ListDrawerContextProvider: React.FC<{
|
|
children: React.ReactNode;
|
|
refresh: ListDrawerContextType['refresh'];
|
|
} & ListDrawerContextProps>;
|
|
export declare const useListDrawerContext: () => ListDrawerContextType;
|
|
//# sourceMappingURL=Provider.d.ts.map |