feat: allow to set titleProperty in resource options

Author: dziraf

src/backend/decorators/property/property-options.interface.ts

@@ -31,9 +31,12 @@ export default interface PropertyOptions {
    * Indicates if property should be treated as an ID
    */
   isId?: boolean;
+
   /**
    * One of given property should be treated as an "title property". Title property is "clickable"
    * when user sees the record in a list or show views.
+   *
+   * @deprecated Use ResourceOptions#titleProperty
    */
   isTitle?: boolean;
 

src/backend/decorators/resource/resource-decorator.ts

@@ -246,8 +246,15 @@ class ResourceDecorator {
    * @return  {PropertyDecorator} PropertyDecorator of title property
    */
   titleProperty(): PropertyDecorator {
+    let titleProperty
+
     const properties = Object.values(this.properties)
-    const titleProperty = properties.find((p) => p.isTitle())
+    if (this.options.titleProperty) {
+      titleProperty = properties.find((p) => p.propertyPath === this.options.titleProperty)
+    } else {
+      titleProperty = properties.find((p) => p.isTitle())
+    }
+
     return titleProperty || properties[0]
   }
 

src/backend/decorators/resource/resource-options.interface.ts

@@ -69,6 +69,10 @@ export interface ResourceOptions {
    * List of properties which should be visible on the filter
    */
   filterProperties?: Array<string>;
+  /**
+   * Name of title property
+   */
+  titleProperty?: string;
   /**
    * Where resource link in sidebar should redirect. Default to the list action.
    */

src/backend/utils/build-feature/build-feature.ts

@@ -30,7 +30,7 @@ function mergeActionHooks<T>(
   return hooks.length ? { [key]: hooks } : {}
 }
 
-const basicOptions = ['id', 'href', 'parent', 'sort', 'navigation'] as const
+const basicOptions = ['id', 'href', 'parent', 'sort', 'navigation', 'titleProperty'] as const
 const listOptions = [
   'listProperties', 'showProperties', 'editProperties', 'filterProperties',
 ] as const