feat(dev): add slugField to TemplateConfig (#460)

Adds a `slugField` field to TemplateConfig and TemplateConfigInternal. --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
yext · Jan 10, 2024 · 302ec3a · 302ec3a
1 parent d193b9a
commit 302ec3a
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 1 deletion.
diff --git a/packages/pages/docs/api/pages.templateconfig.md b/packages/pages/docs/api/pages.templateconfig.md
@@ -21,5 +21,6 @@ export interface TemplateConfig
 | [name?](./pages.templateconfig.name.md)                                       |           | string                      | _(Optional)_ The name of the template feature. If not defined uses the template filename (without extension) |
 | [onUrlChange?](./pages.templateconfig.onurlchange.md)                         |           | string                      | _(Optional)_ The name of the onUrlChange function to use.                                                    |
 | [pageUrlField?](./pages.templateconfig.pageurlfield.md)                       |           | string                      | _(Optional)_ The field to be used as the custom writeback URL for the template                               |
+| [slugField?](./pages.templateconfig.slugfield.md)                             |           | string                      | _(Optional)_ The field to use as the slug for dynamic dev mode                                               |
 | [stream?](./pages.templateconfig.stream.md)                                   |           | [Stream](./pages.stream.md) | _(Optional)_ The stream configuration used by the template                                                   |
 | [streamId?](./pages.templateconfig.streamid.md)                               |           | string                      | _(Optional)_ The stream that this template uses. If a stream is defined the streamId is not required.        |
diff --git a/packages/pages/docs/api/pages.templateconfig.slugfield.md b/packages/pages/docs/api/pages.templateconfig.slugfield.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/pages](./pages.md) &gt; [TemplateConfig](./pages.templateconfig.md) &gt; [slugField](./pages.templateconfig.slugfield.md)
+
+## TemplateConfig.slugField property
+
+The field to use as the slug for dynamic dev mode
+
+**Signature:**
+
+```typescript
+slugField?: string;
+```
diff --git a/packages/pages/etc/pages.api.md b/packages/pages/etc/pages.api.md
@@ -240,6 +240,7 @@ export interface TemplateConfig {
   name?: string;
   onUrlChange?: string;
   pageUrlField?: string;
+  slugField?: string;
   stream?: Stream;
   streamId?: string;
 }
@@ -309,7 +310,7 @@ export interface WidgetRenderProps<T = any> extends WidgetProps<T> {
 
 // Warnings were encountered during analysis:
 //
-// dist/types/src/common/src/template/types.d.ts:163:5 - (ae-forgotten-export) The symbol "ProjectStructureConfig" needs to be exported by the entry point index.d.ts
+// dist/types/src/common/src/template/types.d.ts:165:5 - (ae-forgotten-export) The symbol "ProjectStructureConfig" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 ```
diff --git a/packages/pages/src/common/src/template/internal/types.ts b/packages/pages/src/common/src/template/internal/types.ts
@@ -67,6 +67,8 @@ export interface TemplateConfigInternal {
   locales?: string[];
   /** The field to be used as the custom writeback URL for the template */
   pageUrlField?: string;
+  /** The field to use as the slug for dynamic dev mode */
+  slugField?: string;
 }
 
 /**

diff --git a/packages/pages/src/common/src/template/types.ts b/packages/pages/src/common/src/template/types.ts
@@ -103,6 +103,8 @@ export interface TemplateConfig {
   onUrlChange?: string;
   /** The field to be used as the custom writeback URL for the template */
   pageUrlField?: string;
+  /** The field to use as the slug for dynamic dev mode */
+  slugField?: string;
 }
 
 /**