adminjs
Version:
Admin panel for apps written in node.js
31 lines (29 loc) • 1.24 kB
TypeScript
import React from 'react';
import { AxiosResponse } from 'axios';
import { BulkActionParams, ResourceActionParams, RecordActionParams, ActionParams } from '../../../backend/utils/view-helpers/view-helpers.js';
import { ActionResponse } from '../../../backend/actions/action.interface.js';
export type DifferentActionParams = {
resourceId: ActionParams['resourceId'];
recordId?: RecordActionParams['recordId'];
recordIds?: BulkActionParams['recordIds'];
search?: string;
};
export type MergedActionParams = RecordActionParams & BulkActionParams & ResourceActionParams;
export type ActionCallCallback = (action: ActionResponse) => any;
export type UseActionResultCallApi<K extends ActionResponse> = () => Promise<AxiosResponse<K>>;
/**
* Result of the {@link useAction}.
* @memberof useAction
* @alias UseActionResult
*/
export type UseActionResult<K extends ActionResponse> = {
/**
* Href to an action. When null it means that action doesn't have neither component nor action
* handler
*/
href: string | null;
/** function which will call the API */
callApi: UseActionResultCallApi<K>;
/** ready handleClick handler */
handleClick: (event: React.MouseEvent<HTMLElement>) => void;
};