# 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>
84 lines
2.5 KiB
TypeScript
84 lines
2.5 KiB
TypeScript
import * as React from 'react';
|
|
import { Box, Typography, Paper, CircularProgress, Alert } from '@mui/material';
|
|
import { useResource } from '../hooks/useResource';
|
|
import GenericForm from './GenericForm';
|
|
import { ConfigContext } from '../providers/ConfigContext';
|
|
import { defaultFieldComponents } from './fields/DefaultFieldComponents';
|
|
|
|
export default function ProfileView() {
|
|
const appConfig = React.useContext(ConfigContext);
|
|
const profileConfig = appConfig?.profile;
|
|
const resourceConfig = appConfig?.resources.find(r => r.name === profileConfig?.resource);
|
|
|
|
if (!profileConfig || !resourceConfig) {
|
|
return <Alert severity="error">Profile configuration not found.</Alert>;
|
|
}
|
|
|
|
const editableConfig = React.useMemo(() => {
|
|
const newFields = { ...resourceConfig.fields };
|
|
const extraFields = profileConfig.extraFields || [];
|
|
|
|
Object.keys(newFields).forEach(key => {
|
|
newFields[key] = {
|
|
...newFields[key],
|
|
readOnly: !extraFields.includes(key),
|
|
};
|
|
});
|
|
|
|
return {
|
|
...resourceConfig,
|
|
fields: newFields,
|
|
};
|
|
}, [resourceConfig, profileConfig.extraFields]);
|
|
|
|
const { useMe, useUpdateMe } = useResource(resourceConfig, { fieldComponents: defaultFieldComponents });
|
|
const { data: profile, isLoading, error } = useMe();
|
|
const updateMutation = useUpdateMe();
|
|
|
|
const handleSave = async (formData: any) => {
|
|
try {
|
|
const extraFields = profileConfig.extraFields || [];
|
|
const dataToSave = Object.keys(formData)
|
|
.filter(key => extraFields.includes(key))
|
|
.reduce((obj: any, key) => {
|
|
obj[key] = formData[key];
|
|
return obj;
|
|
}, {});
|
|
|
|
await updateMutation.mutateAsync(dataToSave);
|
|
} catch (err) {
|
|
console.error('Profile update failed:', err);
|
|
}
|
|
};
|
|
|
|
if (isLoading) {
|
|
return (
|
|
<Box sx={{ display: 'flex', justifyContent: 'center', p: 4 }}>
|
|
<CircularProgress />
|
|
</Box>
|
|
);
|
|
}
|
|
|
|
if (error) {
|
|
return <Alert severity="error">Failed to load profile data.</Alert>;
|
|
}
|
|
|
|
return (
|
|
<Box sx={{ maxWidth: 800, mx: 'auto', mt: 4 }}>
|
|
<Typography variant="h4" gutterBottom>
|
|
My Profile
|
|
</Typography>
|
|
<Paper sx={{ p: 4, mt: 2 }}>
|
|
<GenericForm
|
|
config={editableConfig}
|
|
initialData={profile}
|
|
onSave={handleSave}
|
|
onCancel={() => window.history.back()}
|
|
loading={updateMutation.isPending}
|
|
fieldComponents={defaultFieldComponents}
|
|
/>
|
|
</Paper>
|
|
</Box>
|
|
);
|
|
}
|