@pega/sdk 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (223) hide show
  1. package/dist/index.js +2 -19
  2. package/package.json +4 -1
  3. package/templates/react-sdk-reference/.claude/instructions/component-map.md +38 -0
  4. package/templates/react-sdk-reference/.claude/instructions/dse-component.md +75 -0
  5. package/templates/react-sdk-reference/.claude/instructions/field-component.md +71 -0
  6. package/templates/react-sdk-reference/.claude/instructions/template-component.md +92 -0
  7. package/templates/react-sdk-reference/.claude/instructions/widget-component.md +87 -0
  8. package/templates/react-sdk-reference/.claude/prompts/add-component.md +144 -0
  9. package/templates/react-sdk-reference/.claude/prompts/component-manifest.json +111 -0
  10. package/templates/react-sdk-reference/.claude/prompts/generate-all-components.md +149 -0
  11. package/templates/react-sdk-reference/.claude/prompts/generate-dse-components.md +126 -0
  12. package/templates/react-sdk-reference/.claude/prompts/generate-field-components.md +139 -0
  13. package/templates/react-sdk-reference/.claude/prompts/generate-template-components.md +151 -0
  14. package/templates/react-sdk-reference/.claude/prompts/generate-widget-components.md +124 -0
  15. package/templates/react-sdk-reference/.claude/prompts/identify-components.md +105 -0
  16. package/templates/react-sdk-reference/.claude/prompts/replace-design-system.md +519 -0
  17. package/templates/react-sdk-reference/.claude/skills/component-contracts.md +140 -0
  18. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/AlertBanner.md +135 -0
  19. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Banner.md +149 -0
  20. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/CaseSummaryFields.md +154 -0
  21. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/DetailsFields.md +144 -0
  22. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroup.md +131 -0
  23. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroupList.md +111 -0
  24. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldValueList.md +115 -0
  25. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Operator.md +149 -0
  26. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Pulse.md +83 -0
  27. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/RichTextEditor.md +206 -0
  28. package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/WssQuickCreate.md +135 -0
  29. package/templates/react-sdk-reference/.claude/skills/design-system-extension.md +289 -0
  30. package/templates/react-sdk-reference/.claude/skills/field-components.md +294 -0
  31. package/templates/react-sdk-reference/.claude/skills/field-skills/AutoComplete.md +112 -0
  32. package/templates/react-sdk-reference/.claude/skills/field-skills/CancelAlert.md +203 -0
  33. package/templates/react-sdk-reference/.claude/skills/field-skills/Checkbox.md +158 -0
  34. package/templates/react-sdk-reference/.claude/skills/field-skills/Currency.md +106 -0
  35. package/templates/react-sdk-reference/.claude/skills/field-skills/Date.md +99 -0
  36. package/templates/react-sdk-reference/.claude/skills/field-skills/DateTime.md +103 -0
  37. package/templates/react-sdk-reference/.claude/skills/field-skills/Decimal.md +98 -0
  38. package/templates/react-sdk-reference/.claude/skills/field-skills/Dropdown.md +114 -0
  39. package/templates/react-sdk-reference/.claude/skills/field-skills/Email.md +107 -0
  40. package/templates/react-sdk-reference/.claude/skills/field-skills/Group.md +90 -0
  41. package/templates/react-sdk-reference/.claude/skills/field-skills/Integer.md +87 -0
  42. package/templates/react-sdk-reference/.claude/skills/field-skills/Location.md +136 -0
  43. package/templates/react-sdk-reference/.claude/skills/field-skills/Multiselect.md +164 -0
  44. package/templates/react-sdk-reference/.claude/skills/field-skills/ObjectReference.md +164 -0
  45. package/templates/react-sdk-reference/.claude/skills/field-skills/Percentage.md +92 -0
  46. package/templates/react-sdk-reference/.claude/skills/field-skills/Phone.md +110 -0
  47. package/templates/react-sdk-reference/.claude/skills/field-skills/RadioButtons.md +146 -0
  48. package/templates/react-sdk-reference/.claude/skills/field-skills/RichText.md +138 -0
  49. package/templates/react-sdk-reference/.claude/skills/field-skills/ScalarList.md +124 -0
  50. package/templates/react-sdk-reference/.claude/skills/field-skills/SelectableCard.md +216 -0
  51. package/templates/react-sdk-reference/.claude/skills/field-skills/SemanticLink.md +148 -0
  52. package/templates/react-sdk-reference/.claude/skills/field-skills/TextArea.md +96 -0
  53. package/templates/react-sdk-reference/.claude/skills/field-skills/TextContent.md +101 -0
  54. package/templates/react-sdk-reference/.claude/skills/field-skills/TextInput.md +104 -0
  55. package/templates/react-sdk-reference/.claude/skills/field-skills/Time.md +88 -0
  56. package/templates/react-sdk-reference/.claude/skills/field-skills/URL.md +85 -0
  57. package/templates/react-sdk-reference/.claude/skills/field-skills/UserReference.md +180 -0
  58. package/templates/react-sdk-reference/.claude/skills/run-and-verify.md +68 -0
  59. package/templates/react-sdk-reference/.claude/skills/template-components.md +322 -0
  60. package/templates/react-sdk-reference/.claude/skills/template-skills/AdvancedSearch.md +144 -0
  61. package/templates/react-sdk-reference/.claude/skills/template-skills/AppShell.md +122 -0
  62. package/templates/react-sdk-reference/.claude/skills/template-skills/BannerPage.md +83 -0
  63. package/templates/react-sdk-reference/.claude/skills/template-skills/CaseSummary.md +100 -0
  64. package/templates/react-sdk-reference/.claude/skills/template-skills/CaseView.md +131 -0
  65. package/templates/react-sdk-reference/.claude/skills/template-skills/CaseViewActionsMenu.md +126 -0
  66. package/templates/react-sdk-reference/.claude/skills/template-skills/Confirmation.md +107 -0
  67. package/templates/react-sdk-reference/.claude/skills/template-skills/DataReference.md +120 -0
  68. package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultForm.md +102 -0
  69. package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultPage.md +110 -0
  70. package/templates/react-sdk-reference/.claude/skills/template-skills/Details.md +88 -0
  71. package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsSubTabs.md +95 -0
  72. package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsThreeColumn.md +78 -0
  73. package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsTwoColumn.md +78 -0
  74. package/templates/react-sdk-reference/.claude/skills/template-skills/DynamicTabs.md +101 -0
  75. package/templates/react-sdk-reference/.claude/skills/template-skills/FieldGroupTemplate.md +109 -0
  76. package/templates/react-sdk-reference/.claude/skills/template-skills/HierarchicalForm.md +113 -0
  77. package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboard.md +104 -0
  78. package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboardPage.md +85 -0
  79. package/templates/react-sdk-reference/.claude/skills/template-skills/ListPage.md +68 -0
  80. package/templates/react-sdk-reference/.claude/skills/template-skills/ListView.md +139 -0
  81. package/templates/react-sdk-reference/.claude/skills/template-skills/MultiReferenceReadOnly.md +80 -0
  82. package/templates/react-sdk-reference/.claude/skills/template-skills/NarrowWide.md +141 -0
  83. package/templates/react-sdk-reference/.claude/skills/template-skills/OneColumn.md +109 -0
  84. package/templates/react-sdk-reference/.claude/skills/template-skills/PromotedFilters.md +124 -0
  85. package/templates/react-sdk-reference/.claude/skills/template-skills/SelfServiceCaseView.md +135 -0
  86. package/templates/react-sdk-reference/.claude/skills/template-skills/SimpleTable.md +127 -0
  87. package/templates/react-sdk-reference/.claude/skills/template-skills/SingleReferenceReadOnly.md +103 -0
  88. package/templates/react-sdk-reference/.claude/skills/template-skills/SubTabs.md +79 -0
  89. package/templates/react-sdk-reference/.claude/skills/template-skills/TwoColumn.md +131 -0
  90. package/templates/react-sdk-reference/.claude/skills/template-skills/WideNarrow.md +150 -0
  91. package/templates/react-sdk-reference/.claude/skills/template-skills/WssNavBar.md +135 -0
  92. package/templates/react-sdk-reference/.claude/skills/widget-components.md +271 -0
  93. package/templates/react-sdk-reference/.claude/skills/widget-skills/AppAnnouncement.md +82 -0
  94. package/templates/react-sdk-reference/.claude/skills/widget-skills/Attachment.md +146 -0
  95. package/templates/react-sdk-reference/.claude/skills/widget-skills/CaseHistory.md +107 -0
  96. package/templates/react-sdk-reference/.claude/skills/widget-skills/FileUtility.md +200 -0
  97. package/templates/react-sdk-reference/.claude/skills/widget-skills/Followers.md +99 -0
  98. package/templates/react-sdk-reference/.claude/skills/widget-skills/QuickCreate.md +114 -0
  99. package/templates/react-sdk-reference/.claude/skills/widget-skills/SummaryItem.md +167 -0
  100. package/templates/react-sdk-reference/.claude/skills/widget-skills/ToDo.md +190 -0
  101. package/templates/react-sdk-reference/.cursor/rules/component-map.mdrules +41 -0
  102. package/templates/react-sdk-reference/.cursor/rules/dse-component.mdrules +78 -0
  103. package/templates/react-sdk-reference/.cursor/rules/field-component.mdrules +74 -0
  104. package/templates/react-sdk-reference/.cursor/rules/pega-sdk.mdrules +247 -0
  105. package/templates/react-sdk-reference/.cursor/rules/prompts/add-component.mdrules +149 -0
  106. package/templates/react-sdk-reference/.cursor/rules/prompts/component-manifest.json +111 -0
  107. package/templates/react-sdk-reference/.cursor/rules/prompts/generate-all-components.mdrules +154 -0
  108. package/templates/react-sdk-reference/.cursor/rules/prompts/generate-dse-components.mdrules +131 -0
  109. package/templates/react-sdk-reference/.cursor/rules/prompts/generate-field-components.mdrules +144 -0
  110. package/templates/react-sdk-reference/.cursor/rules/prompts/generate-template-components.mdrules +156 -0
  111. package/templates/react-sdk-reference/.cursor/rules/prompts/generate-widget-components.mdrules +129 -0
  112. package/templates/react-sdk-reference/.cursor/rules/prompts/identify-components.mdrules +110 -0
  113. package/templates/react-sdk-reference/.cursor/rules/prompts/replace-design-system.mdrules +524 -0
  114. package/templates/react-sdk-reference/.cursor/rules/skills/component-contracts.mdrules +145 -0
  115. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/AlertBanner.mdrules +140 -0
  116. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Banner.mdrules +154 -0
  117. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/CaseSummaryFields.mdrules +159 -0
  118. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/DetailsFields.mdrules +149 -0
  119. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroup.mdrules +136 -0
  120. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroupList.mdrules +116 -0
  121. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldValueList.mdrules +120 -0
  122. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Operator.mdrules +154 -0
  123. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Pulse.mdrules +88 -0
  124. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/RichTextEditor.mdrules +211 -0
  125. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/WssQuickCreate.mdrules +140 -0
  126. package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension.mdrules +294 -0
  127. package/templates/react-sdk-reference/.cursor/rules/skills/field-components.mdrules +299 -0
  128. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/AutoComplete.mdrules +117 -0
  129. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/CancelAlert.mdrules +208 -0
  130. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Checkbox.mdrules +163 -0
  131. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Currency.mdrules +111 -0
  132. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Date.mdrules +104 -0
  133. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/DateTime.mdrules +108 -0
  134. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Decimal.mdrules +103 -0
  135. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Dropdown.mdrules +119 -0
  136. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Email.mdrules +112 -0
  137. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Group.mdrules +95 -0
  138. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Integer.mdrules +92 -0
  139. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Location.mdrules +141 -0
  140. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Multiselect.mdrules +169 -0
  141. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ObjectReference.mdrules +169 -0
  142. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Percentage.mdrules +97 -0
  143. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Phone.mdrules +115 -0
  144. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RadioButtons.mdrules +151 -0
  145. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RichText.mdrules +143 -0
  146. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ScalarList.mdrules +129 -0
  147. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SelectableCard.mdrules +221 -0
  148. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SemanticLink.mdrules +153 -0
  149. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextArea.mdrules +101 -0
  150. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextContent.mdrules +106 -0
  151. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextInput.mdrules +109 -0
  152. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Time.mdrules +93 -0
  153. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/URL.mdrules +90 -0
  154. package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/UserReference.mdrules +185 -0
  155. package/templates/react-sdk-reference/.cursor/rules/skills/run-and-verify.mdrules +73 -0
  156. package/templates/react-sdk-reference/.cursor/rules/skills/template-components.mdrules +327 -0
  157. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AdvancedSearch.mdrules +149 -0
  158. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AppShell.mdrules +127 -0
  159. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/BannerPage.mdrules +88 -0
  160. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseSummary.mdrules +105 -0
  161. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseView.mdrules +136 -0
  162. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseViewActionsMenu.mdrules +131 -0
  163. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Confirmation.mdrules +112 -0
  164. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DataReference.mdrules +125 -0
  165. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultForm.mdrules +107 -0
  166. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultPage.mdrules +115 -0
  167. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Details.mdrules +93 -0
  168. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsSubTabs.mdrules +100 -0
  169. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsThreeColumn.mdrules +83 -0
  170. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsTwoColumn.mdrules +83 -0
  171. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DynamicTabs.mdrules +106 -0
  172. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/FieldGroupTemplate.mdrules +114 -0
  173. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/HierarchicalForm.mdrules +118 -0
  174. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboard.mdrules +109 -0
  175. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboardPage.mdrules +90 -0
  176. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListPage.mdrules +73 -0
  177. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListView.mdrules +144 -0
  178. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/MultiReferenceReadOnly.mdrules +85 -0
  179. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/NarrowWide.mdrules +146 -0
  180. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/OneColumn.mdrules +114 -0
  181. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/PromotedFilters.mdrules +129 -0
  182. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SelfServiceCaseView.mdrules +140 -0
  183. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SimpleTable.mdrules +132 -0
  184. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SingleReferenceReadOnly.mdrules +108 -0
  185. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SubTabs.mdrules +84 -0
  186. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/TwoColumn.mdrules +136 -0
  187. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WideNarrow.mdrules +155 -0
  188. package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WssNavBar.mdrules +140 -0
  189. package/templates/react-sdk-reference/.cursor/rules/skills/widget-components.mdrules +276 -0
  190. package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/AppAnnouncement.mdrules +87 -0
  191. package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Attachment.mdrules +151 -0
  192. package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/CaseHistory.mdrules +112 -0
  193. package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/FileUtility.mdrules +205 -0
  194. package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Followers.mdrules +104 -0
  195. package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/QuickCreate.mdrules +119 -0
  196. package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/SummaryItem.mdrules +172 -0
  197. package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/ToDo.mdrules +195 -0
  198. package/templates/react-sdk-reference/.cursor/rules/template-component.mdrules +95 -0
  199. package/templates/react-sdk-reference/.cursor/rules/widget-component.mdrules +90 -0
  200. package/templates/react-sdk-reference/.github/copilot-instructions.md +58 -0
  201. package/templates/react-sdk-reference/.github/prompts/add-component.prompt.md +144 -16
  202. package/templates/react-sdk-reference/.github/prompts/generate-all-components.prompt.md +154 -0
  203. package/templates/react-sdk-reference/.github/prompts/generate-dse-components.prompt.md +131 -0
  204. package/templates/react-sdk-reference/.github/prompts/generate-field-components.prompt.md +144 -0
  205. package/templates/react-sdk-reference/.github/prompts/generate-template-components.prompt.md +156 -0
  206. package/templates/react-sdk-reference/.github/prompts/generate-widget-components.prompt.md +129 -0
  207. package/templates/react-sdk-reference/.github/skills/design-system-extension.md +58 -18
  208. package/templates/react-sdk-reference/.github/skills/field-components.md +55 -23
  209. package/templates/react-sdk-reference/.github/skills/template-components.md +48 -11
  210. package/templates/react-sdk-reference/.github/skills/widget-components.md +49 -12
  211. package/templates/react-sdk-reference/AGENTS.md +217 -29
  212. package/templates/react-sdk-reference/package.json +3 -2
  213. package/templates/react-sdk-reference/pega-auth-0.2.42.tgz +0 -0
  214. package/templates/react-sdk-reference/pega-constellationjs-0.26.3-local.tgz +0 -0
  215. package/templates/react-sdk-reference/pega-sdk-react-0.1.0.tgz +0 -0
  216. package/templates/react-sdk-reference/pega-sdk-types-0.1.0.tgz +0 -0
  217. package/templates/react-sdk-reference/sdk-config.json +1 -1
  218. package/templates/react-sdk-reference/vite.config.ts +1 -1
  219. package/templates/react-sdk-reference/.github/prompts/replace-all-fields.prompt.md +0 -48
  220. package/templates/react-sdk-reference/.github/prompts/replace-component.prompt.md +0 -81
  221. package/templates/react-sdk-reference/.github/prompts/replace-field.prompt.md +0 -41
  222. package/templates/react-sdk-reference/.github/prompts/swap-design-system.prompt.md +0 -49
  223. package/templates/react-sdk-reference/.github/skills/swap-design-system.md +0 -105
@@ -0,0 +1,105 @@
1
+ ---
2
+ description: Template component skill: CaseSummary
3
+ alwaysApply: false
4
+ ---
5
+
6
+ # Skill: CaseSummary
7
+
8
+ Case summary template. Renders a summary panel with primary and secondary case fields, derived from either props or child region extraction.
9
+
10
+ > **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
11
+
12
+ ---
13
+
14
+ ## Component Purpose
15
+
16
+ Displays a case's key summary data in a structured summary panel. Primary fields are shown prominently; secondary fields are shown with labels. Data is sourced either directly from props or by extracting child regions. All field values are localized before display.
17
+
18
+ ## Pega Metadata
19
+
20
+ - **Registration key:** `CaseSummary` (in `component-map.ts`)
21
+ - **Category:** Page template — summary
22
+ - **Extends:** `PConnProps`
23
+
24
+ ## Props
25
+
26
+ | Prop | Type | Required | Description |
27
+ |------|------|----------|-------------|
28
+ | `children` | `ReactNode[]` | No | Region children when fields come from PConnect metadata |
29
+ | `arPrimaryFields` | `array` | No | Array of primary field objects (direct prop) |
30
+ | `arSecondaryFields` | `array` | No | Array of secondary field objects (direct prop) |
31
+ | `getPConnect` | `function` | Yes | PConnect getter |
32
+
33
+ ## Behavioral Contract
34
+
35
+ ### Field Sourcing
36
+
37
+ Two modes — prefer direct props if provided:
38
+
39
+ **Mode A — Direct props:**
40
+ - `arPrimaryFields` and `arSecondaryFields` are passed directly.
41
+ - Call `prepareCaseSummaryData(primaryFields, secondaryFields, getPConnect)` to localize values.
42
+
43
+ **Mode B — Child extraction:**
44
+ - Extract primary and secondary regions from `children` by type/name matching.
45
+ - Primary region: first region child (or `type === 'Region' && name === 'Primary'`).
46
+ - Secondary region: second region child (or `type === 'Region' && name === 'Secondary'`).
47
+ - Build field arrays from the extracted region children metadata.
48
+ - Then call `prepareCaseSummaryData(...)` as in Mode A.
49
+
50
+ ### `prepareCaseSummaryData(primaryFields, secondaryFields, getPConnect)`
51
+
52
+ Helper that:
53
+ 1. Iterates each field in both arrays.
54
+ 2. Localizes the field value via `PCore.getLocaleUtils().getLocaleValue(value, classID, value)`.
55
+ 3. Returns `{ arPrimaryFields: localizedPrimary, arSecondaryFields: localizedSecondary }`.
56
+
57
+ ### Render
58
+
59
+ Delegates entirely to `<CaseSummaryFields>` DSE component, passing:
60
+ - `arPrimaryFields` — array of `{ name, value }` objects for primary display
61
+ - `arSecondaryFields` — array of `{ name, value, displayLabel }` objects for secondary display
62
+
63
+ ## Visual Specifications
64
+
65
+ - `<CaseSummaryFields>` handles all rendering — see the DSE component skill for details.
66
+ - Primary fields: large text, no label.
67
+ - Secondary fields: label + value pairs.
68
+
69
+ **CSS-only implementation notes (for `CaseSummaryFields` wrapper):**
70
+ - Container: `display: flex; flex-direction: column; gap: 8px`.
71
+ - Primary field value: `font-size: 1rem; font-weight: 600`.
72
+ - Secondary field row: `display: flex; gap: 4px; font-size: 0.875rem`.
73
+ - Secondary label: `color: var(--secondary-text-color)`.
74
+
75
+ ## Edge Cases & Special Logic
76
+
77
+ - If both `arPrimaryFields` prop and children are present, the direct prop takes priority.
78
+ - `prepareCaseSummaryData` — guard against undefined/null field values before passing to `getLocaleValue`.
79
+ - `displayLabel` on secondary fields controls whether the field label is shown alongside the value.
80
+ - If `arSecondaryFields` is empty, the secondary section is not rendered.
81
+
82
+ ## Dependencies
83
+
84
+ - `prepareCaseSummaryData` from `./utils` (local helper)
85
+ - `CaseSummaryFields` — DSE component registered in the component registry
86
+ - `PCore.getLocaleUtils().getLocaleValue()` — value localization
87
+
88
+ ## Design System Mapping
89
+
90
+ **UI control type:** Read-only case summary panel with primary and secondary field groups.
91
+
92
+ Listed design systems are examples only.
93
+
94
+ | Design System | Recommended Approach |
95
+ |---|---|
96
+ | Default (CSS only) | Flexbox column with CSS-styled field rows |
97
+ | MUI | `<Typography>` variants for primary/secondary text |
98
+ | Ant Design | `<Descriptions>` with `bordered={false}` |
99
+ | Chakra UI | `<VStack>` with `<Text>` variants |
100
+ | Shadcn/ui | Custom `<dl>/<dt>/<dd>` or card |
101
+
102
+ When implementing in a specific design system:
103
+ - Always localize field values before display — use `PCore.getLocaleUtils().getLocaleValue()`
104
+ - `CaseSummaryFields` is a DSE component — implement it separately and call it from here
105
+ - Primary fields have no labels; secondary fields have labels
@@ -0,0 +1,136 @@
1
+ ---
2
+ description: Template component skill: CaseView
3
+ alwaysApply: false
4
+ ---
5
+
6
+ # Skill: CaseView
7
+
8
+ Case view template. Renders the full case workspace: summary sidebar, stages, to-do region, main content tabs, and utilities column. Also covers `ObjectPage` (which is a re-export of `CaseView`).
9
+
10
+ > **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
11
+
12
+ ---
13
+
14
+ ## Component Purpose
15
+
16
+ The primary case workspace template. Extracts named regions from PConnect children by metadata type and name, arranges them in a 3-column responsive grid (3/6/3), handles deferred tab loading, and supports a `displayOnlyFA` mode that shows only the to-do region. Edit actions are triggered via the utilities column.
17
+
18
+ > **Note:** `ObjectPage` is a direct re-export of `CaseView` — `export { default } from '../CaseView'`. Do not create a separate `ObjectPage` component; register both keys pointing to the same implementation.
19
+
20
+ ## Pega Metadata
21
+
22
+ - **Registration key:** `CaseView` and `ObjectPage` (both point to the same component)
23
+ - **Category:** Page template — case workspace
24
+ - **Extends:** `PConnProps`
25
+
26
+ ## Props
27
+
28
+ | Prop | Type | Required | Description |
29
+ |------|------|----------|-------------|
30
+ | `children` | `ReactNode[]` | Yes | Named region children (summary, stages, todo, utilities, tabs) |
31
+ | `displayOnlyFA` | `boolean` | No | If true, renders only the to-do region (focused action mode) |
32
+ | `getPConnect` | `function` | Yes | PConnect getter |
33
+
34
+ ## Behavioral Contract
35
+
36
+ ### Region Extraction
37
+
38
+ Use `getRawMetadata()` to access `children` with `type` and `name` metadata. Extract by:
39
+ - **Summary region:** `type === 'Region' && name === 'Summary'`
40
+ - **Stages region:** `type === 'Region' && name === 'Stages'`
41
+ - **ToDo region:** `type === 'Region' && name === 'ToDo'`
42
+ - **Utilities region:** `type === 'Region' && name === 'Utilities'`
43
+ - **Tabs region:** `type === 'Region' && name === 'Tabs'`
44
+
45
+ Render each region as a React child element using `createElement(PConnectComponent, { ...regionConfig })`.
46
+
47
+ ### Tabs Region — Deferred Load
48
+
49
+ - From the Tabs region children, build `vertTabInfo` (vertical tab definitions) and `deferLoadInfo` (deferred loading metadata).
50
+ - Pass both to `<DeferLoad>` component which handles lazy rendering of tab content.
51
+ - The tabs list comes from `theTabsRegionChildren` (the children of the Tabs region).
52
+
53
+ ### displayOnlyFA Mode
54
+
55
+ If `displayOnlyFA === true`:
56
+ - Render only the ToDo region, centered.
57
+ - Skip summary, stages, tabs, utilities rendering.
58
+
59
+ ### Attachments Subscription
60
+
61
+ - Subscribe to `PCore.getPubSubUtils().subscribe(CASE_ATTACHMENTS_UPDATED, handleAttachmentUpdate, 'CaseView')`.
62
+ - Track `hasNewAttachments` boolean state — passed to utilities region.
63
+ - Unsubscribe on unmount.
64
+
65
+ ### Edit Action
66
+
67
+ - The utilities region may include an edit action button.
68
+ - On click: call `getPConnect().getActionsApi().openLocalAction(editActionId, { ... })`.
69
+
70
+ ## Visual Specifications
71
+
72
+ ### 3-Column Grid Layout
73
+
74
+ ```
75
+ [Col xs:3] [Col xs:6] [Col xs:3]
76
+ Summary Main tabs Utilities
77
+ Stages (Deferred)
78
+ ToDo
79
+ ```
80
+
81
+ | Column | xs | Contents |
82
+ |--------|----|----------|
83
+ | Left | 3 | Summary, Stages, ToDo regions |
84
+ | Center | 6 | Tabs region (deferred content) |
85
+ | Right | 3 | Utilities region |
86
+
87
+ **CSS-only implementation notes:**
88
+ - Outer grid: `display: grid; grid-template-columns: 25% 50% 25%; gap: 1rem`.
89
+ - Left column: `display: flex; flex-direction: column; gap: 0.5rem`.
90
+ - Center column: `overflow: hidden`.
91
+ - Responsive: on mobile, stack to single column.
92
+
93
+ ## Edge Cases & Special Logic
94
+
95
+ - `displayOnlyFA === true` — completely different render tree (only ToDo), no grid layout.
96
+ - Missing regions — guard each region before rendering; a region may not exist for all case types.
97
+ - `DeferLoad` handles progressive loading — do not eagerly render all tab content.
98
+ - `hasNewAttachments` is passed down to the utilities region — it affects attachment icon badge display.
99
+
100
+ ## Dependencies
101
+
102
+ - `DeferLoad` component from `@pega/sdk-react` — deferred tab content loading
103
+ - `PCore.getPubSubUtils()` — pub/sub for attachment updates
104
+ - `PConnectComponent` from `@pega/sdk-react`
105
+ - `CASE_ATTACHMENTS_UPDATED` constant from `@pega/sdk-core` (or local constants)
106
+
107
+ ## Sub-Variants
108
+
109
+ ### ObjectPage
110
+
111
+ `ObjectPage` is registered as:
112
+ ```tsx
113
+ // packages/sdk-react/src/components/template/ObjectPage/index.tsx
114
+ export { default } from '../CaseView';
115
+ ```
116
+ - No separate implementation needed.
117
+ - In `component-map.ts`, register `ObjectPage` key pointing to the same component as `CaseView`.
118
+
119
+ ## Design System Mapping
120
+
121
+ **UI control type:** Full case workspace layout — 3-column grid with sidebar, main content, and utilities.
122
+
123
+ Listed design systems are examples only.
124
+
125
+ | Design System | Grid | Sidebar | Deferred Tabs |
126
+ |---|---|---|---|
127
+ | Default (CSS only) | CSS Grid 25/50/25 | `<aside>` | Intersection Observer lazy load |
128
+ | MUI | `<Grid container>` with `<Grid size={{ xs: 3/6/3 }}>` | `<Box>` | MUI `<Tabs>` + DeferLoad |
129
+ | Ant Design | `<Row><Col span={6/12/6}>` | `<Sider>` | `<Tabs>` lazy |
130
+ | Chakra UI | `<Grid templateColumns='1fr 2fr 1fr'>` | `<Box>` | Custom lazy tabs |
131
+ | Shadcn/ui | Tailwind `grid grid-cols-[1fr_2fr_1fr]` | `<aside>` | Custom |
132
+
133
+ When implementing in a specific design system:
134
+ - `displayOnlyFA` must completely bypass the grid — render only ToDo region
135
+ - Region extraction by metadata name is required — do not assume positional ordering
136
+ - Deferred loading is mandatory for performance — tab content must not all load at once
@@ -0,0 +1,131 @@
1
+ ---
2
+ description: Template component skill: CaseViewActionsMenu
3
+ alwaysApply: false
4
+ ---
5
+
6
+ # Skill: CaseViewActionsMenu
7
+
8
+ Case actions dropdown menu. Renders an "Actions" button that opens a menu of local actions and process actions for the current case.
9
+
10
+ > **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
11
+
12
+ ---
13
+
14
+ ## Component Purpose
15
+
16
+ Renders a button that opens a dropdown menu containing all available case actions. Distinguishes between local actions (UI flow) and process actions (server-side), invoking the appropriate API for each. Shows a Snackbar toast on process action error.
17
+
18
+ ## Pega Metadata
19
+
20
+ - **Registration key:** `CaseViewActionsMenu` (in `component-map.ts`)
21
+ - **Category:** Page template — action menu
22
+ - **Extends:** `PConnProps`
23
+
24
+ ## Props
25
+
26
+ | Prop | Type | Required | Description |
27
+ |------|------|----------|-------------|
28
+ | `localActions` | `array` | No | Array of `{ ID, name }` local action objects |
29
+ | `processActions` | `array` | No | Array of `{ ID, name }` process action objects |
30
+ | `caseTypeID` | `string` | Yes | Case type identifier for label localization |
31
+ | `caseTypeName` | `string` | Yes | Case type display name for label localization |
32
+ | `getPConnect` | `function` | Yes | PConnect getter |
33
+
34
+ ## Behavioral Contract
35
+
36
+ ### Button Label
37
+
38
+ - Localized via `PCore.getLocaleUtils().getLocaleValue('Actions', 'CaseView', 'Actions')`.
39
+ - Rendered as an outlined/secondary button with a dropdown indicator icon.
40
+
41
+ ### Menu Items
42
+
43
+ The menu combines:
44
+ 1. **Local actions** — each item triggers `getPConnect().getActionsApi().openLocalAction(action.ID, { caseID: getPConnect().getCaseInfo().getID() })`.
45
+ 2. **Process actions** — each item triggers `getPConnect().getActionsApi().openProcessAction(action.ID, { ... })`.
46
+
47
+ If both groups exist, render a divider between them.
48
+
49
+ ### Localized Action Labels
50
+
51
+ For localized case type context:
52
+ ```
53
+ localeKey = `${caseTypeID}!CASE!${caseTypeName.toUpperCase()}`
54
+ ```
55
+ Action name localization: `PCore.getLocaleUtils().getLocaleValue(action.name, localeKey, action.name)`.
56
+
57
+ ### Process Action Error Handling
58
+
59
+ 1. On process action click, wrap in `try/catch`.
60
+ 2. On error: show Snackbar toast with the error message.
61
+ 3. Snackbar auto-hides after 3000ms.
62
+
63
+ ### Menu State
64
+
65
+ - `anchorEl` state controls menu open/close.
66
+ - Open: `setAnchorEl(event.currentTarget)`.
67
+ - Close: `setAnchorEl(null)`.
68
+
69
+ ## Visual Specifications
70
+
71
+ ### Button
72
+
73
+ | Property | Value |
74
+ |----------|-------|
75
+ | Label | Localized `"Actions"` |
76
+ | Variant | Outlined or secondary |
77
+ | Icon | Dropdown chevron or expand_more |
78
+
79
+ ### Menu
80
+
81
+ | Property | Value |
82
+ |----------|-------|
83
+ | Position | Anchored below the button |
84
+ | Divider | Between local and process action groups |
85
+ | Item height | Standard menu item height |
86
+
87
+ **CSS-only implementation notes:**
88
+ - Button: `padding: 6px 12px; border: 1px solid var(--app-primary-color); border-radius: 4px; cursor: pointer`.
89
+ - Dropdown menu: `position: absolute; background: white; box-shadow: 0 2px 8px rgba(0,0,0,0.2); border-radius: 4px; min-width: 160px; z-index: 1000`.
90
+ - Menu item: `padding: 8px 16px; cursor: pointer`. Hover: `background: var(--hover-bg)`.
91
+ - Divider: `border-top: 1px solid var(--divider-color); margin: 4px 0`.
92
+
93
+ ### Snackbar Toast
94
+
95
+ | Property | Value |
96
+ |----------|-------|
97
+ | Position | Bottom-center or bottom-right |
98
+ | Auto-hide | 3000ms |
99
+ | Severity | Error (red) |
100
+
101
+ ## Edge Cases & Special Logic
102
+
103
+ - If both `localActions` and `processActions` are empty, the "Actions" button may be hidden or disabled.
104
+ - `caseTypeName.toUpperCase()` — guard against `undefined`/`null` values.
105
+ - Process action errors may include HTML — sanitize before displaying in the Snackbar message.
106
+ - Menu should close on any item click (both local and process).
107
+
108
+ ## Dependencies
109
+
110
+ - `PCore.getLocaleUtils().getLocaleValue()` — label localization
111
+ - `PConnectComponent` from `@pega/sdk-react`
112
+ - MUI: `<Button>`, `<Menu>`, `<MenuItem>`, `<Divider>`, `<Snackbar>`
113
+
114
+ ## Design System Mapping
115
+
116
+ **UI control type:** Dropdown action menu with button trigger and toast error notification.
117
+
118
+ Listed design systems are examples only.
119
+
120
+ | Design System | Button | Menu | Toast |
121
+ |---|---|---|---|
122
+ | Default (CSS only) | `<button>` + custom dropdown | `<ul>/<li>` with CSS | Custom toast overlay |
123
+ | MUI | `<Button>` + `<Menu>/<MenuItem>` | MUI Menu | `<Snackbar>/<Alert>` |
124
+ | Ant Design | `<Dropdown menu={{ items }}>` | Ant Dropdown | `message.error()` |
125
+ | Chakra UI | `<Menu>/<MenuButton>/<MenuList>` | Chakra Menu | `useToast()` |
126
+ | Shadcn/ui | `<DropdownMenu>/<DropdownMenuTrigger>` | Shadcn DropdownMenu | `<Toaster>` + `toast.error()` |
127
+
128
+ When implementing in a specific design system:
129
+ - Local vs process action distinction must be preserved — they call different APIs
130
+ - Localized labels via `localeKey = ${caseTypeID}!CASE!${caseTypeName.toUpperCase()}`
131
+ - Process action errors must be surfaced via a dismissible toast
@@ -0,0 +1,112 @@
1
+ ---
2
+ description: Template component skill: Confirmation
3
+ alwaysApply: false
4
+ ---
5
+
6
+ # Skill: Confirmation
7
+
8
+ Case confirmation template. Renders the post-submission confirmation view with a Done button, optionally showing ToDo assignments that remain after the case is submitted.
9
+
10
+ > **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
11
+
12
+ ---
13
+
14
+ ## Component Purpose
15
+
16
+ Displayed after a case or assignment is submitted. Shows the confirmation view (with `Details` region) and a Done button. If outstanding ToDo assignments remain after the user clicks Done, they are displayed. When the user truly finishes, publishes `CLOSE_CONFIRM_VIEW` to close the container.
17
+
18
+ ## Pega Metadata
19
+
20
+ - **Registration key:** `Confirmation` (in `component-map.ts`)
21
+ - **Category:** Page template — confirmation
22
+ - **Extends:** `PConnProps`
23
+
24
+ ## Props
25
+
26
+ | Prop | Type | Required | Description |
27
+ |------|------|----------|-------------|
28
+ | `children` | `ReactNode[]` | Yes | Region children: `[0]` = ToDo region, `[1]` = Details region (when available) |
29
+ | `getPConnect` | `function` | Yes | PConnect getter |
30
+
31
+ ## Behavioral Contract
32
+
33
+ ### State
34
+
35
+ - `showConfirmView`: boolean, initially `true`.
36
+ - `toDoAssignments`: array from `getToDoAssignments(getPConnect())` — pending assignments.
37
+
38
+ ### Done Button Click
39
+
40
+ 1. Call `getPConnect().getContainerManager().closeContainerItem(getPConnect().getContainerName())`.
41
+ 2. OR call `PCore.getContainerUtils().getActiveContainerItemName(getPConnect().getContainerName())`.
42
+ 3. Check remaining `toDoAssignments`.
43
+ 4. If assignments remain: `setShowConfirmView(false)` — show ToDo view instead.
44
+ 5. If no assignments remain: publish `PCore.getPubSubUtils().publish(CLOSE_CONFIRM_VIEW, {})`.
45
+
46
+ ### Show Details
47
+
48
+ - `showDetails`: `children.length > 1` — true when a Details region is present.
49
+
50
+ ### Render: Confirm View (`showConfirmView === true`)
51
+
52
+ 1. Confirmation message header (localized `"Your submission is confirmed"` or equivalent).
53
+ 2. If `showDetails`: render `children[1]` (Details region) using `createElement(PConnectComponent, ...)`.
54
+ 3. Done button (`localized "Done"`) — triggers done click handler above.
55
+
56
+ ### Render: ToDo View (`showConfirmView === false`)
57
+
58
+ - Render `children[0]` (ToDo region) using `createElement(PConnectComponent, ...)`.
59
+
60
+ ## Visual Specifications
61
+
62
+ ### Confirm View
63
+
64
+ | Element | Description |
65
+ |---------|-------------|
66
+ | Confirmation header | Success icon + heading text |
67
+ | Details section | Optional — rendered below confirmation header |
68
+ | Done button | Primary button, bottom of the form |
69
+
70
+ **CSS-only implementation notes:**
71
+ - Confirm view: `display: flex; flex-direction: column; align-items: center; gap: 1.5rem; padding: 2rem`.
72
+ - Success icon: large checkmark or success indicator, centered.
73
+ - Confirmation heading: `font-size: 1.5rem; font-weight: 600; text-align: center`.
74
+ - Done button: `align-self: flex-end` or centered.
75
+
76
+ ### ToDo View
77
+
78
+ - Full-width ToDo region rendered in place of confirmation.
79
+ - No additional wrapping — render the region directly.
80
+
81
+ ## Edge Cases & Special Logic
82
+
83
+ - `getToDoAssignments(getPConnect())` — returns empty array if no assignments remain; triggers close publish immediately.
84
+ - `children[1]` may not exist — always check `showDetails` before rendering.
85
+ - `CLOSE_CONFIRM_VIEW` is a PubSub constant — ensure it matches the consuming container's subscription key.
86
+ - The confirmation view should not be navigable backward — Done is the only exit.
87
+
88
+ ## Dependencies
89
+
90
+ - `getToDoAssignments` from `../../helpers/case-utils` (or equivalent)
91
+ - `PCore.getPubSubUtils().publish()` — for CLOSE_CONFIRM_VIEW event
92
+ - `PCore.getContainerUtils()` — for container item management
93
+ - `PConnectComponent` from `@pega/sdk-react`
94
+
95
+ ## Design System Mapping
96
+
97
+ **UI control type:** Post-submission confirmation page with done action and optional todo view.
98
+
99
+ Listed design systems are examples only.
100
+
101
+ | Design System | Success Indicator | Done Button | Layout |
102
+ |---|---|---|---|
103
+ | Default (CSS only) | CSS checkmark SVG | `<button class='primary'>` | Centered flexbox column |
104
+ | MUI | `<CheckCircleIcon>` | `<Button variant='contained'>` | `<Box display='flex' flexDirection='column'>` |
105
+ | Ant Design | `<Result status='success'>` | `<Button type='primary'>` | Ant Result component |
106
+ | Chakra UI | `<CheckCircleIcon>` + `<Text>` | `<Button colorScheme='blue'>` | `<VStack>` |
107
+ | Shadcn/ui | Custom icon + `<h2>` | `<Button>` | Tailwind centered div |
108
+
109
+ When implementing in a specific design system:
110
+ - Done button must check remaining `toDoAssignments` before deciding whether to show ToDo view or close
111
+ - `CLOSE_CONFIRM_VIEW` publish must happen only after confirming no assignments remain
112
+ - `showDetails` check must guard `children[1]` access
@@ -0,0 +1,125 @@
1
+ ---
2
+ description: Template component skill: DataReference
3
+ alwaysApply: false
4
+ ---
5
+
6
+ # Skill: DataReference
7
+
8
+ Data reference template. Routes to field, table, or search renderers based on `selectionMode` and `displayAs` props. Handles deferred data source loading, dropdown options, and multi-select variants.
9
+
10
+ > **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
11
+
12
+ ---
13
+
14
+ ## Component Purpose
15
+
16
+ Renders a data reference field that can be displayed as a dropdown, autocomplete, checkbox group, radiobutton group, or a card-selection layout. In read-only mode, delegates to `SingleReferenceReadOnly` (single selection) or `MultiReferenceReadOnly` (multi-selection). Supports deferred/parameterized data sources.
17
+
18
+ ## Pega Metadata
19
+
20
+ - **Registration key:** `DataReference` (in `component-map.ts`)
21
+ - **Category:** Form template — data selection
22
+ - **Extends:** `PConnProps`
23
+
24
+ ## Props
25
+
26
+ | Prop | Type | Required | Description |
27
+ |------|------|----------|-------------|
28
+ | `label` | `string` | Yes | Field label |
29
+ | `displayAs` | `string` | Yes | UI variant: `'dropdown'`, `'autocomplete'`, `'checkbox'`, `'radiobutton'`, `'listview'`, `'searchbox'` |
30
+ | `selectionMode` | `string` | Yes | `'single'` or `'multi'` |
31
+ | `displayMode` | `string` | No | `'DISPLAY_ONLY'` for read-only rendering |
32
+ | `readOnly` | `boolean` | No | Alternative read-only flag |
33
+ | `ruleClass` | `string` | Yes | Data page class reference |
34
+ | `dataRelationship` | `string` | No | Relationship type |
35
+ | `isDDSourceDeferred` | `boolean` | No | Whether data source is loaded asynchronously |
36
+ | `parameters` | `object` | No | Parameters passed to the data page for deferred sources |
37
+ | `allowSearch` | `boolean` | No | Show search input inside dropdown/autocomplete |
38
+ | `searchIcon` | `boolean` | No | Show search icon in the field |
39
+ | `numCols` | `string` | No | Column count for checkbox/radiobutton layouts: `'1'`, `'2'`, `'3'` |
40
+ | `listType` | `string` | No | `'associated'` or `'datapage'` |
41
+ | `fieldMetadata` | `object` | No | Extra field-level metadata |
42
+ | `getPConnect` | `function` | Yes | PConnect getter |
43
+
44
+ ## Behavioral Contract
45
+
46
+ ### Read-Only Routing
47
+
48
+ If `displayMode === 'DISPLAY_ONLY'` or `readOnly === true`:
49
+ - `selectionMode === 'single'` → render `<SingleReferenceReadOnly />`.
50
+ - `selectionMode === 'multi'` → render `<MultiReferenceReadOnly />`.
51
+ - Both receive all relevant props plus `getPConnect`.
52
+
53
+ ### Edit Routing (by `displayAs`)
54
+
55
+ | `displayAs` | Rendered component |
56
+ |-------------|--------------------|
57
+ | `'dropdown'` | Registered `Dropdown` field component |
58
+ | `'autocomplete'` | Registered `AutoComplete` field component |
59
+ | `'checkbox'` | Registered `CheckboxGroup` with `numCols` |
60
+ | `'radiobutton'` | Registered `RadioButtons` with `numCols` |
61
+ | `'listview'` | Inline `ListView` sub-component |
62
+ | `'searchbox'` | Inline `SearchForm` sub-component |
63
+ | Default | `Dropdown` |
64
+
65
+ ### Deferred Data Source (`isDDSourceDeferred === true`)
66
+
67
+ 1. On mount, call `PCore.getDataApiUtils().getData(dataSourceName, parameters)`.
68
+ 2. Store result in `dropDownDataSource` state.
69
+ 3. Pass `dropDownDataSource` to the rendered field component as `datasource`.
70
+
71
+ ### Localized Placeholder
72
+
73
+ - Generate a localized "Please select..." option via `localizedPlaceholderOption` using `PCore.getLocaleUtils().getLocaleValue(...)`.
74
+ - Prepend this option to `dropDownDataSource` for dropdown/autocomplete variants.
75
+
76
+ ### SearchForm Sub-Component
77
+
78
+ When `displayAs === 'searchbox'`, renders an inline `<SearchForm>` sub-component that:
79
+ 1. Shows a text input with search icon.
80
+ 2. On submit: calls `getPConnect().getListActions().search(searchText)`.
81
+ 3. Renders the search results list below the input using `buildView`.
82
+
83
+ ## Visual Specifications
84
+
85
+ **CSS-only implementation notes:**
86
+ - Wrapper: `display: flex; flex-direction: column; gap: 4px`.
87
+ - Label: `font-size: 0.875rem; font-weight: 500; margin-bottom: 4px`.
88
+ - Dropdown/Autocomplete: standard select input, full-width.
89
+ - Checkbox/Radio group: grid layout matching `numCols`.
90
+ - SearchForm: `display: flex; gap: 8px` (input + search button).
91
+
92
+ ## Edge Cases & Special Logic
93
+
94
+ - `isDDSourceDeferred` — data is not available synchronously; show a loading indicator until `dropDownDataSource` resolves.
95
+ - `parameters` may contain property references — resolve them via `pConn.getValue(paramRef)` before passing to `getData`.
96
+ - `listType === 'associated'` — use `pConn.getFieldMetadata().options` directly instead of fetching from data page.
97
+ - Card variant (`displayAs === 'listview'`) — may include image props (`image`, `imagePlaceholder`) from `getComponentConfig()`.
98
+ - Multi-select with `displayAs === 'checkbox'` — values stored as comma-separated string in the property.
99
+
100
+ ## Dependencies
101
+
102
+ - `SingleReferenceReadOnly` (registered DSE or template component)
103
+ - `MultiReferenceReadOnly` (registered template component)
104
+ - Field components from registry: `Dropdown`, `AutoComplete`, `CheckboxGroup`, `RadioButtons`
105
+ - `PCore.getDataApiUtils().getData()` — for deferred data source fetch
106
+ - `PCore.getLocaleUtils().getLocaleValue()` — for localized placeholder
107
+
108
+ ## Design System Mapping
109
+
110
+ **UI control type:** Polymorphic data selection field — dropdown, autocomplete, checkbox, radiobutton, or search variants.
111
+
112
+ Listed design systems are examples only.
113
+
114
+ | Design System | Dropdown | Autocomplete | Checkbox Group | Radio Group |
115
+ |---|---|---|---|---|
116
+ | Default (CSS only) | `<select>` | Custom combobox | `<input type='checkbox'>` list | `<input type='radio'>` list |
117
+ | MUI | `<Select>/<MenuItem>` | `<Autocomplete>` | `<FormGroup><Checkbox>` | `<RadioGroup><Radio>` |
118
+ | Ant Design | `<Select>` | `<AutoComplete>` | `<Checkbox.Group>` | `<Radio.Group>` |
119
+ | Chakra UI | `<Select>` | Custom | `<CheckboxGroup>` | `<RadioGroup>` |
120
+ | Shadcn/ui | `<Select>` + combobox | `<Combobox>` | custom | `<RadioGroup>` |
121
+
122
+ When implementing in a specific design system:
123
+ - Always check `displayMode`/`readOnly` first and route to read-only components before rendering editable variants
124
+ - Deferred loading must be handled — show skeleton/spinner until data is ready
125
+ - `numCols` applies to checkbox and radiobutton layouts only