# Summary Refactor the React OpenAPI admin framework to support fully customizable field rendering and UI composition. ## Changes ### Admin UI Customization * Added support for custom: * Dashboard component * Layout component * Login page component * Introduced `AdminAppProps` and extended `Admin` configuration API. * Renamed internal dashboard implementation to `DefaultDashboard`. ### Field Component Architecture * Extracted field rendering into dedicated field components: * TextField * NumberField * BooleanField * DateField * EnumField * RelationField * ObjectField * FallbackField * DateRangeField * NumberRangeField * Added `defaultFieldComponents` registry. * Refactored `FormField` to resolve components dynamically from a component map instead of hardcoded field type handling. ### Resource Customization * Added `FieldComponents` support across: * Admin * ResourceView * GenericForm * useResource * Introduced wrapped `FormField` and `GenericForm` components generated from configured field overrides. ### Table Customization * Added `EnhancedTableComponents`. * Added support for custom cell renderers per field type. * Enabled custom rendering for both desktop and mobile table layouts. ### Filter Improvements * Exported `FilterAutocomplete`. * Added support for custom date-range and number-range filter components. * Added filter component extension points. * Updated filter option label resolution to support `displayFormat`. ### Display Formatting * Replaced `displayField` usage with `displayFormat`. * Added template-based display rendering support through `resolveTemplate`. * Improved relation display configuration handling. ### TypeScript Improvements * Added TypeScript as a project dependency. * Removed multiple `@ts-ignore` usages. * Added strongly typed Axios wrapper methods with generic response support. * Improved typing across hooks and component interfaces. ### OpenAPI Configuration Validation * Added validation for enum fields without enum values. * Added validation for relation resources missing `referenceOptions.enumOption`. * Improved relation metadata propagation during schema parsing. ### Library Exports * Exported: * Field component types * Override types * EnhancedTable * GenericForm * ResourceView * Field components and defaults * Expanded public API surface for consumers extending the framework. ## Benefits * Enables complete UI customization without modifying framework internals. * Simplifies creation of custom field types and renderers. * Improves type safety and developer experience. * Provides consistent extension points for forms, tables, filters, and admin layouts. * Makes the framework more suitable for reusable library distribution. Reviewed-on: #11 Co-authored-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com> Co-committed-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
86 lines
2.1 KiB
TypeScript
86 lines
2.1 KiB
TypeScript
import * as React from 'react';
|
|
import { ResourceField } from '../../types/config';
|
|
import { FieldComponentProps, FieldComponents } from '../../types/overrides';
|
|
import ObjectField from './ObjectField';
|
|
|
|
export interface FormFieldProps {
|
|
name: string;
|
|
field: ResourceField;
|
|
value: any;
|
|
onChange: (val: any) => void;
|
|
disabled?: boolean;
|
|
uploadFile?: (file: File) => Promise<string | null>;
|
|
uploading?: boolean;
|
|
baseUrl?: string;
|
|
relationDataMap?: Record<string, any[]>;
|
|
components: FieldComponents;
|
|
}
|
|
|
|
export default function FormField({
|
|
name,
|
|
field,
|
|
value,
|
|
onChange,
|
|
disabled,
|
|
uploadFile,
|
|
uploading,
|
|
baseUrl,
|
|
relationDataMap = {},
|
|
components,
|
|
}: FormFieldProps) {
|
|
const fieldProps: FieldComponentProps = {
|
|
name,
|
|
field,
|
|
value,
|
|
onChange,
|
|
disabled,
|
|
baseUrl,
|
|
relationDataMap,
|
|
uploadFile,
|
|
uploading,
|
|
};
|
|
|
|
const childComponents = components;
|
|
|
|
// 1. Object (recursive) - requires parent FormField for recursion
|
|
if (field.type === 'object' && field.schema && !field.relation) {
|
|
const renderChild = (childProps: FieldComponentProps) => (
|
|
<FormField
|
|
name={childProps.name}
|
|
field={childProps.field}
|
|
value={childProps.value}
|
|
onChange={childProps.onChange}
|
|
disabled={childProps.disabled}
|
|
uploadFile={childProps.uploadFile}
|
|
uploading={childProps.uploading}
|
|
baseUrl={childProps.baseUrl}
|
|
relationDataMap={childProps.relationDataMap}
|
|
components={components}
|
|
/>
|
|
);
|
|
return <ObjectField {...fieldProps} renderField={renderChild} />;
|
|
}
|
|
|
|
// 2. Image
|
|
if (field.type === 'image') {
|
|
const ImageField = components.image;
|
|
if (!ImageField) return null;
|
|
return <ImageField {...fieldProps} />;
|
|
}
|
|
|
|
// 3. Relation
|
|
if (field.relation && relationDataMap[field.relation]) {
|
|
const RelationFieldComp = components.relation;
|
|
if (!RelationFieldComp) return null;
|
|
return <RelationFieldComp {...fieldProps} />;
|
|
}
|
|
|
|
// 4. Lookup by field type
|
|
const Component = components[field.type] || components.default;
|
|
if (Component) {
|
|
return <Component {...fieldProps} />;
|
|
}
|
|
|
|
return null;
|
|
}
|