Repository URL to install this package:
Version:
0.2.0-dev.38 ▾
|
/// <reference types="react" />
import type { DescriptionPanelItemProps } from '../../components2/DescriptionPanel/DescriptionPanel.types';
import type { Falsy } from '../../utils/typing';
import type { ModelApiOptions, ModelFieldDefinition, ModelOptions, ModelTypeOptions, RoutingOptions } from '../useModel/useModel.types';
export declare type NamedModelTypeOptions = ModelTypeOptions & {
nameField?: ModelFieldDefinition;
};
export declare type NamedModelOptions = NamedModelTypeOptions & ModelOptions;
export declare function useNamedModelType(routingOptions?: RoutingOptions, apiOptions?: ModelApiOptions, typeOptions?: NamedModelTypeOptions): {
fields: {
[x: string]: ModelFieldDefinition;
};
metaFields: {
name: ModelFieldDefinition;
id: ModelFieldDefinition;
};
renderLink: (obj: Record<string, any>) => JSX.Element | undefined;
router: (import("../..").RoutingLeafNode & {
[key: string]: string | import("../..").RoutingNodeFunction;
}) | undefined;
backendRouter: {
adminListHref: string | undefined;
adminCreateHref: string | undefined;
} | undefined;
api: import("..").ModelTypeApi;
};
declare function useNamedModel(obj: Record<string, any>, routingOptions?: RoutingOptions, apiOptions?: ModelApiOptions, modelOptions?: NamedModelOptions): {
api: import("..").ModelApi;
router: (import("../..").RoutingLeafNode & {
[key: string]: string | import("../..").RoutingNodeFunction;
}) | undefined;
backendRouter: {
adminChangeHref: string | undefined;
adminListHref?: string | undefined;
adminCreateHref?: string | undefined;
} | undefined;
adminModuleItems: (Falsy | DescriptionPanelItemProps)[];
renderLink: () => JSX.Element | undefined;
fields: {
[x: string]: ModelFieldDefinition;
};
metaFields: {
name: ModelFieldDefinition;
id: ModelFieldDefinition;
};
};
export default useNamedModel;