feat: add customizable admin field descriptions

src/fields/config/schema.ts

@@ -6,6 +6,10 @@ const component = joi.alternatives().try(
 );
 
 export const baseAdminFields = joi.object().keys({
+  description: joi.alternatives().try(
+    joi.string(),
+    joi.func(),
+  ),
   position: joi.string().valid('sidebar'),
   width: joi.string(),
   style: joi.object().unknown(),
@@ -17,6 +21,7 @@ export const baseAdminFields = joi.object().keys({
     Cell: component,
     Field: component,
     Filter: component,
+    Description: component,
   }).default({}),
 });
 

src/fields/config/types.ts

@@ -22,7 +22,7 @@ export type FieldAccess = (args: {
   siblingData: Record<string, unknown>
 }) => Promise<boolean> | boolean;
 
-export type Condition = (data: Record<string, unknown>, siblingData: Record<string, unknown>) => boolean
+export type Condition = (data: Record<string, unknown>, siblingData: Record<string, unknown>) => boolean;
 
 type Admin = {
   position?: string;
@@ -31,7 +31,13 @@ type Admin = {
   readOnly?: boolean;
   disabled?: boolean;
   condition?: Condition;
-  components?: { [key: string]: React.ComponentType };
+  description?: string | ((data: Record<string, unknown>) => string);
+  components?: {
+    Filter?: React.ComponentType;
+    Cell?: React.ComponentType;
+    Field?: React.ComponentType;
+    Description?: React.ComponentType<{value: unknown}>
+  }
   hidden?: boolean
 }
 
@@ -214,11 +220,11 @@ export type RadioField = FieldBase & {
 }
 
 export type Block = {
-  slug: string,
-  labels?: Labels
-  fields: Field[],
-  imageURL?: string
-  imageAltText?: string
+  slug: string;
+  labels?: Labels;
+  fields: Field[];
+  imageURL?: string;
+  imageAltText?: string;
 }
 
 export type BlockField = FieldBase & {