@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.
- package/dist/index.js +2 -19
- package/package.json +4 -1
- package/templates/react-sdk-reference/.claude/instructions/component-map.md +38 -0
- package/templates/react-sdk-reference/.claude/instructions/dse-component.md +75 -0
- package/templates/react-sdk-reference/.claude/instructions/field-component.md +71 -0
- package/templates/react-sdk-reference/.claude/instructions/template-component.md +92 -0
- package/templates/react-sdk-reference/.claude/instructions/widget-component.md +87 -0
- package/templates/react-sdk-reference/.claude/prompts/add-component.md +144 -0
- package/templates/react-sdk-reference/.claude/prompts/component-manifest.json +111 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-all-components.md +149 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-dse-components.md +126 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-field-components.md +139 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-template-components.md +151 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-widget-components.md +124 -0
- package/templates/react-sdk-reference/.claude/prompts/identify-components.md +105 -0
- package/templates/react-sdk-reference/.claude/prompts/replace-design-system.md +519 -0
- package/templates/react-sdk-reference/.claude/skills/component-contracts.md +140 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/AlertBanner.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Banner.md +149 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/CaseSummaryFields.md +154 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/DetailsFields.md +144 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroup.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroupList.md +111 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldValueList.md +115 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Operator.md +149 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Pulse.md +83 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/RichTextEditor.md +206 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/WssQuickCreate.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension.md +289 -0
- package/templates/react-sdk-reference/.claude/skills/field-components.md +294 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/AutoComplete.md +112 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/CancelAlert.md +203 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Checkbox.md +158 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Currency.md +106 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Date.md +99 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/DateTime.md +103 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Decimal.md +98 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Dropdown.md +114 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Email.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Group.md +90 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Integer.md +87 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Location.md +136 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Multiselect.md +164 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/ObjectReference.md +164 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Percentage.md +92 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Phone.md +110 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/RadioButtons.md +146 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/RichText.md +138 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/ScalarList.md +124 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/SelectableCard.md +216 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/SemanticLink.md +148 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextArea.md +96 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextContent.md +101 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextInput.md +104 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Time.md +88 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/URL.md +85 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/UserReference.md +180 -0
- package/templates/react-sdk-reference/.claude/skills/run-and-verify.md +68 -0
- package/templates/react-sdk-reference/.claude/skills/template-components.md +322 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/AdvancedSearch.md +144 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/AppShell.md +122 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/BannerPage.md +83 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseSummary.md +100 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseView.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseViewActionsMenu.md +126 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/Confirmation.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DataReference.md +120 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultForm.md +102 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultPage.md +110 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/Details.md +88 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsSubTabs.md +95 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsThreeColumn.md +78 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsTwoColumn.md +78 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DynamicTabs.md +101 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/FieldGroupTemplate.md +109 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/HierarchicalForm.md +113 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboard.md +104 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboardPage.md +85 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/ListPage.md +68 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/ListView.md +139 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/MultiReferenceReadOnly.md +80 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/NarrowWide.md +141 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/OneColumn.md +109 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/PromotedFilters.md +124 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SelfServiceCaseView.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SimpleTable.md +127 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SingleReferenceReadOnly.md +103 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SubTabs.md +79 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/TwoColumn.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/WideNarrow.md +150 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/WssNavBar.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/widget-components.md +271 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/AppAnnouncement.md +82 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/Attachment.md +146 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/CaseHistory.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/FileUtility.md +200 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/Followers.md +99 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/QuickCreate.md +114 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/SummaryItem.md +167 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/ToDo.md +190 -0
- package/templates/react-sdk-reference/.cursor/rules/component-map.mdrules +41 -0
- package/templates/react-sdk-reference/.cursor/rules/dse-component.mdrules +78 -0
- package/templates/react-sdk-reference/.cursor/rules/field-component.mdrules +74 -0
- package/templates/react-sdk-reference/.cursor/rules/pega-sdk.mdrules +247 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/add-component.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/component-manifest.json +111 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-all-components.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-dse-components.mdrules +131 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-field-components.mdrules +144 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-template-components.mdrules +156 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-widget-components.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/identify-components.mdrules +110 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/replace-design-system.mdrules +524 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/component-contracts.mdrules +145 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/AlertBanner.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Banner.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/CaseSummaryFields.mdrules +159 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/DetailsFields.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroup.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroupList.mdrules +116 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldValueList.mdrules +120 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Operator.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Pulse.mdrules +88 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/RichTextEditor.mdrules +211 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/WssQuickCreate.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension.mdrules +294 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-components.mdrules +299 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/AutoComplete.mdrules +117 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/CancelAlert.mdrules +208 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Checkbox.mdrules +163 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Currency.mdrules +111 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Date.mdrules +104 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/DateTime.mdrules +108 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Decimal.mdrules +103 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Dropdown.mdrules +119 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Email.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Group.mdrules +95 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Integer.mdrules +92 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Location.mdrules +141 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Multiselect.mdrules +169 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ObjectReference.mdrules +169 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Percentage.mdrules +97 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Phone.mdrules +115 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RadioButtons.mdrules +151 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RichText.mdrules +143 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ScalarList.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SelectableCard.mdrules +221 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SemanticLink.mdrules +153 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextArea.mdrules +101 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextContent.mdrules +106 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextInput.mdrules +109 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Time.mdrules +93 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/URL.mdrules +90 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/UserReference.mdrules +185 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/run-and-verify.mdrules +73 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-components.mdrules +327 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AdvancedSearch.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AppShell.mdrules +127 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/BannerPage.mdrules +88 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseSummary.mdrules +105 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseView.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseViewActionsMenu.mdrules +131 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Confirmation.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DataReference.mdrules +125 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultForm.mdrules +107 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultPage.mdrules +115 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Details.mdrules +93 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsSubTabs.mdrules +100 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsThreeColumn.mdrules +83 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsTwoColumn.mdrules +83 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DynamicTabs.mdrules +106 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/FieldGroupTemplate.mdrules +114 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/HierarchicalForm.mdrules +118 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboard.mdrules +109 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboardPage.mdrules +90 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListPage.mdrules +73 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListView.mdrules +144 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/MultiReferenceReadOnly.mdrules +85 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/NarrowWide.mdrules +146 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/OneColumn.mdrules +114 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/PromotedFilters.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SelfServiceCaseView.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SimpleTable.mdrules +132 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SingleReferenceReadOnly.mdrules +108 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SubTabs.mdrules +84 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/TwoColumn.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WideNarrow.mdrules +155 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WssNavBar.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-components.mdrules +276 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/AppAnnouncement.mdrules +87 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Attachment.mdrules +151 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/CaseHistory.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/FileUtility.mdrules +205 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Followers.mdrules +104 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/QuickCreate.mdrules +119 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/SummaryItem.mdrules +172 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/ToDo.mdrules +195 -0
- package/templates/react-sdk-reference/.cursor/rules/template-component.mdrules +95 -0
- package/templates/react-sdk-reference/.cursor/rules/widget-component.mdrules +90 -0
- package/templates/react-sdk-reference/.github/copilot-instructions.md +58 -0
- package/templates/react-sdk-reference/.github/prompts/add-component.prompt.md +144 -16
- package/templates/react-sdk-reference/.github/prompts/generate-all-components.prompt.md +154 -0
- package/templates/react-sdk-reference/.github/prompts/generate-dse-components.prompt.md +131 -0
- package/templates/react-sdk-reference/.github/prompts/generate-field-components.prompt.md +144 -0
- package/templates/react-sdk-reference/.github/prompts/generate-template-components.prompt.md +156 -0
- package/templates/react-sdk-reference/.github/prompts/generate-widget-components.prompt.md +129 -0
- package/templates/react-sdk-reference/.github/skills/design-system-extension.md +58 -18
- package/templates/react-sdk-reference/.github/skills/field-components.md +55 -23
- package/templates/react-sdk-reference/.github/skills/template-components.md +48 -11
- package/templates/react-sdk-reference/.github/skills/widget-components.md +49 -12
- package/templates/react-sdk-reference/AGENTS.md +217 -29
- package/templates/react-sdk-reference/package.json +3 -2
- package/templates/react-sdk-reference/pega-auth-0.2.42.tgz +0 -0
- package/templates/react-sdk-reference/pega-constellationjs-0.26.3-local.tgz +0 -0
- package/templates/react-sdk-reference/pega-sdk-react-0.1.0.tgz +0 -0
- package/templates/react-sdk-reference/pega-sdk-types-0.1.0.tgz +0 -0
- package/templates/react-sdk-reference/sdk-config.json +1 -1
- package/templates/react-sdk-reference/vite.config.ts +1 -1
- package/templates/react-sdk-reference/.github/prompts/replace-all-fields.prompt.md +0 -48
- package/templates/react-sdk-reference/.github/prompts/replace-component.prompt.md +0 -81
- package/templates/react-sdk-reference/.github/prompts/replace-field.prompt.md +0 -41
- package/templates/react-sdk-reference/.github/prompts/swap-design-system.prompt.md +0 -49
- package/templates/react-sdk-reference/.github/skills/swap-design-system.md +0 -105
package/templates/react-sdk-reference/.claude/skills/template-skills/MultiReferenceReadOnly.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Skill: MultiReferenceReadOnly
|
|
2
|
+
|
|
3
|
+
Multi-reference read-only template. Routes to `SimpleTableSelectReadonly` or `SimpleTable` based on `displayAs` for read-only rendering of multi-value reference fields.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a multi-value reference field in read-only mode. Routing is based on the `displayAs` prop: certain display variants use `SimpleTableSelectReadonly` (link + modal), while others use `SimpleTable` directly.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Registration key:** `MultiReferenceReadOnly` (in `component-map.ts`)
|
|
16
|
+
- **Category:** Display template — read-only multi-reference
|
|
17
|
+
- **Extends:** `PConnProps`
|
|
18
|
+
|
|
19
|
+
## Props
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Required | Description |
|
|
22
|
+
|------|------|----------|-------------|
|
|
23
|
+
| `displayAs` | `string` | Yes | UI variant that was used in edit mode |
|
|
24
|
+
| `referenceList` | `string` | No | Property path to the reference list |
|
|
25
|
+
| `readonlyContextList` | `array` | No | Fallback data array when `referenceList` is not resolved |
|
|
26
|
+
| `fieldMetadata` | `object` | No | Field-level metadata |
|
|
27
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
28
|
+
|
|
29
|
+
## Behavioral Contract
|
|
30
|
+
|
|
31
|
+
### Routing by `displayAs`
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
if displayAs in ['readonlyMulti', 'combobox', 'checkboxgroup']:
|
|
35
|
+
→ render SimpleTableSelectReadonly
|
|
36
|
+
else:
|
|
37
|
+
→ render SimpleTable (with readOnly=true / displayMode='DISPLAY_ONLY')
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Reference List Fallback
|
|
41
|
+
|
|
42
|
+
- Primary: `pConn.getValue(referenceList + '.pxResults')`.
|
|
43
|
+
- Fallback: use `readonlyContextList` directly if the above is undefined/empty.
|
|
44
|
+
|
|
45
|
+
## Visual Specifications
|
|
46
|
+
|
|
47
|
+
- `SimpleTableSelectReadonly` variant: link/chip showing selection count + modal dialog.
|
|
48
|
+
- `SimpleTable` variant: flat read-only table of values.
|
|
49
|
+
|
|
50
|
+
See `SimpleTable.md` and `ListView.md` for detailed visual specs.
|
|
51
|
+
|
|
52
|
+
**CSS-only notes:**
|
|
53
|
+
- Fallback to `readonlyContextList` renders identically to the resolved reference list.
|
|
54
|
+
- No edit controls in either variant.
|
|
55
|
+
|
|
56
|
+
## Edge Cases & Special Logic
|
|
57
|
+
|
|
58
|
+
- `readonlyContextList` is the fallback — always use it when `pConn.getValue(referenceList)` returns nothing.
|
|
59
|
+
- `displayAs` check uses an inclusion array: `['readonlyMulti', 'combobox', 'checkboxgroup']` — extend this list if new multi-select display variants are added.
|
|
60
|
+
- The component is only reached in `DISPLAY_ONLY`/`readOnly` mode — never needs to handle edit states.
|
|
61
|
+
|
|
62
|
+
## Dependencies
|
|
63
|
+
|
|
64
|
+
- `SimpleTableSelectReadonly` (see `SimpleTable.md`)
|
|
65
|
+
- `SimpleTable` (see `SimpleTable.md`)
|
|
66
|
+
|
|
67
|
+
## Design System Mapping
|
|
68
|
+
|
|
69
|
+
**UI control type:** Read-only multi-value reference display — routes to modal table or flat table.
|
|
70
|
+
|
|
71
|
+
Listed design systems are examples only.
|
|
72
|
+
|
|
73
|
+
| `displayAs` | Routing | DS Implementation |
|
|
74
|
+
|---|---|---|
|
|
75
|
+
| `readonlyMulti`, `combobox`, `checkboxgroup` | `SimpleTableSelectReadonly` | Link/chip + modal |
|
|
76
|
+
| All others | `SimpleTable` | Flat read-only table |
|
|
77
|
+
|
|
78
|
+
When implementing in a specific design system:
|
|
79
|
+
- The `displayAs` routing list must match the edit-mode variants defined in `DataReference.md`
|
|
80
|
+
- `readonlyContextList` fallback is critical — reference list data may not be available on initial render
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# Skill: NarrowWide
|
|
2
|
+
|
|
3
|
+
Asymmetric two-column layout with a narrow left column (~33%) and a wide right column (~67%). Includes four sub-variants for different contexts.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders two children side by side with the left column narrower than the right. Used for case layouts where a sidebar panel sits beside a main content area. Four sub-variants:
|
|
12
|
+
|
|
13
|
+
- **`NarrowWide`** — core CSS-based layout, accepts either `a`/`b` slot props or React `children[0]`/`children[1]`
|
|
14
|
+
- **`NarrowWidePage`** — wrapper that passes React children as `a` and `b` slot props to `NarrowWide`
|
|
15
|
+
- **`NarrowWideForm`** — simplified wrapper using only `children` (no `a`/`b` slots, no title/icon)
|
|
16
|
+
- **`NarrowWideDetails`** — details read-only variant; sets children to DISPLAY_ONLY mode and supports highlighted data
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
| Variant | Registration Key |
|
|
21
|
+
|---------|-----------------|
|
|
22
|
+
| NarrowWide | `NarrowWide` |
|
|
23
|
+
| NarrowWidePage | `NarrowWidePage` |
|
|
24
|
+
| NarrowWideForm | `NarrowWideForm` |
|
|
25
|
+
| NarrowWideDetails | `NarrowWideDetails` |
|
|
26
|
+
|
|
27
|
+
All extend `PConnProps`.
|
|
28
|
+
|
|
29
|
+
## Props
|
|
30
|
+
|
|
31
|
+
### NarrowWide
|
|
32
|
+
|
|
33
|
+
| Prop | Type | Required | Description |
|
|
34
|
+
|------|------|----------|-------------|
|
|
35
|
+
| `children` | `ReactNode[]` | No | Two children rendered in narrow/wide slots |
|
|
36
|
+
| `a` | `any` | No | Narrow (left) column content |
|
|
37
|
+
| `b` | `any` | No | Wide (right) column content |
|
|
38
|
+
| `title` | `string` | No | Optional title (not rendered in reference implementation) |
|
|
39
|
+
| `cols` | `string` | No | Column template (not rendered in reference implementation) |
|
|
40
|
+
| `icon` | `string` | No | Optional icon (not rendered in reference implementation) |
|
|
41
|
+
|
|
42
|
+
### NarrowWidePage
|
|
43
|
+
|
|
44
|
+
| Prop | Type | Required | Description |
|
|
45
|
+
|------|------|----------|-------------|
|
|
46
|
+
| `children` | `ReactNode[]` | Yes | Two children — `[0]` → narrow slot, `[1]` → wide slot |
|
|
47
|
+
| `title` | `string` | Yes | Page title (passed to NarrowWide) |
|
|
48
|
+
| `templateCol` | `string` | No | Column ratio (default `'1fr 1fr'`) |
|
|
49
|
+
| `icon` | `string` | No | Icon name (strips `'pi pi-'` prefix) |
|
|
50
|
+
|
|
51
|
+
### NarrowWideForm
|
|
52
|
+
|
|
53
|
+
| Prop | Type | Required | Description |
|
|
54
|
+
|------|------|----------|-------------|
|
|
55
|
+
| `children` | `ReactNode[]` | Yes | Two children — `[0]` → narrow slot, `[1]` → wide slot |
|
|
56
|
+
|
|
57
|
+
### NarrowWideDetails
|
|
58
|
+
|
|
59
|
+
| Prop | Type | Required | Description |
|
|
60
|
+
|------|------|----------|-------------|
|
|
61
|
+
| `label` | `string` | Yes | Section label for FieldGroup |
|
|
62
|
+
| `showLabel` | `boolean` | No | Whether to show the label. Default `true` |
|
|
63
|
+
| `showHighlightedData` | `boolean` | No | Whether to render highlighted data fields above children. Default `false` |
|
|
64
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
65
|
+
|
|
66
|
+
## Behavioral Contract
|
|
67
|
+
|
|
68
|
+
### NarrowWide
|
|
69
|
+
|
|
70
|
+
1. If `children` is provided and has exactly 2 items, render `children[0]` in `.psdk-narrow-column-column` and `children[1]` in `.psdk-wide-column-column` (both wrapped in `.psdk-narrow-wide-column`).
|
|
71
|
+
2. If `a` and `b` are provided (and children is empty/not 2 items), render `a` in the narrow slot and `b` in the wide slot.
|
|
72
|
+
3. The two render paths are independent — priority is `children` if length === 2, otherwise `a`/`b`.
|
|
73
|
+
|
|
74
|
+
### NarrowWidePage
|
|
75
|
+
|
|
76
|
+
1. Extract `childrenToRender = children as ReactElement[]`.
|
|
77
|
+
2. Retrieve `NarrowWide` from the component registry.
|
|
78
|
+
3. Render `<NarrowWide a={childrenToRender[0]} b={childrenToRender[1]} title={title} cols={templateCol} icon={icon?.replace('pi pi-', '')} />`.
|
|
79
|
+
|
|
80
|
+
### NarrowWideForm
|
|
81
|
+
|
|
82
|
+
1. Render exactly as `NarrowWide` with `children` path — checks `children.length === 2`, renders narrow/wide slots.
|
|
83
|
+
2. Does not support `a`/`b` props.
|
|
84
|
+
|
|
85
|
+
### NarrowWideDetails
|
|
86
|
+
|
|
87
|
+
1. Call `getPConnect().getInheritedProps()` and merge with `{ label, showLabel }` for `propsToUse`.
|
|
88
|
+
2. Set `getPConnect().setInheritedProp('displayMode', 'DISPLAY_ONLY')` and `setInheritedProp('readOnly', true)`.
|
|
89
|
+
3. Map `getPConnect().getChildren()` → `createElement(PConnectComponent, { ...configObject, key: index })`.
|
|
90
|
+
4. If `showHighlightedData` is true, read `getRawMetadata().config.highlightedData`, set each field's `displayMode = 'STACKED_LARGE_VAL'`, mark `pyStatusWork` fields as `type='TextInput', displayAsStatus=true`, and create components via `getPConnect().createComponent(field, '', 0, {})`.
|
|
91
|
+
5. Wrap everything in `<FieldGroup name={theName}>` where `theName = propsToUse.showLabel && propsToUse.label ? propsToUse.label : ''`.
|
|
92
|
+
6. Layout: highlighted data in `Grid size={{ xs: COLUMN_WIDTHS[i] }}` where `COLUMN_WIDTHS = [4, 8]`, then children in `Grid size={{ xs: 12 }}` rows.
|
|
93
|
+
|
|
94
|
+
## Visual Specifications
|
|
95
|
+
|
|
96
|
+
Derived from `NarrowWide.css`:
|
|
97
|
+
|
|
98
|
+
### Container
|
|
99
|
+
|
|
100
|
+
| CSS Class | Property | Value |
|
|
101
|
+
|-----------|----------|-------|
|
|
102
|
+
| `.psdk-narrow-wide-column` | Display | flex or grid (two-column row) |
|
|
103
|
+
| `.psdk-narrow-column-column` | Width | ~33% (1 of 3 parts) |
|
|
104
|
+
| `.psdk-wide-column-column` | Width | ~67% (2 of 3 parts) |
|
|
105
|
+
|
|
106
|
+
**CSS-only implementation notes:**
|
|
107
|
+
- `.psdk-narrow-wide-column`: `display: grid; grid-template-columns: 1fr 2fr; gap: 1rem`.
|
|
108
|
+
- `.psdk-narrow-column-column`: takes the first (narrower) grid column.
|
|
109
|
+
- `.psdk-wide-column-column`: takes the second (wider) grid column.
|
|
110
|
+
- On mobile: `grid-template-columns: 1fr` (stacks vertically).
|
|
111
|
+
|
|
112
|
+
## Edge Cases & Special Logic
|
|
113
|
+
|
|
114
|
+
- `NarrowWide` supports both `children` and `a`/`b` slot patterns — check `children` length first.
|
|
115
|
+
- `NarrowWideDetails` highlighted data grid uses `[4, 8]` column widths (narrow left, wide right for STACKED_LARGE_VAL fields).
|
|
116
|
+
- `NarrowWideDetails` reads `theName` from `propsToUse` (which merges inherited props) — the `label` prop alone may be overridden by inherited props.
|
|
117
|
+
- Icon cleanup in `NarrowWidePage`: strip `'pi pi-'` prefix from the icon string before passing to `NarrowWide`.
|
|
118
|
+
|
|
119
|
+
## Dependencies
|
|
120
|
+
|
|
121
|
+
- `NarrowWidePage`: `getComponentFromRegistry` from `@pega/sdk-react`
|
|
122
|
+
- `NarrowWideDetails`: `getComponentFromRegistry('FieldGroup')`, `PConnectComponent` from `@pega/sdk-react`
|
|
123
|
+
|
|
124
|
+
## Design System Mapping
|
|
125
|
+
|
|
126
|
+
**UI control type:** Asymmetric two-column layout (sidebar + main content).
|
|
127
|
+
|
|
128
|
+
Listed design systems are examples only.
|
|
129
|
+
|
|
130
|
+
| Design System | Recommended Component |
|
|
131
|
+
|---|---|
|
|
132
|
+
| Default (CSS only) | CSS Grid `grid-template-columns: 1fr 2fr; gap: 1rem` |
|
|
133
|
+
| MUI | `<Grid container><Grid size={{ xs: 12, md: 4 }}><Grid size={{ xs: 12, md: 8 }}>` |
|
|
134
|
+
| Ant Design | `<Row gutter={16}><Col xs={24} md={8}><Col xs={24} md={16}>` |
|
|
135
|
+
| Chakra UI | `<Grid templateColumns={{ base: '1fr', md: '1fr 2fr' }} gap={4}>` |
|
|
136
|
+
| Shadcn/ui | Tailwind `grid grid-cols-1 md:grid-cols-[1fr_2fr] gap-4` |
|
|
137
|
+
|
|
138
|
+
When implementing in a specific design system:
|
|
139
|
+
- Narrow column ≈ 33% width (1fr of 3fr total)
|
|
140
|
+
- Wide column ≈ 67% width (2fr of 3fr total)
|
|
141
|
+
- `NarrowWideDetails` always forces DISPLAY_ONLY + readOnly on children
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Skill: OneColumn
|
|
2
|
+
|
|
3
|
+
Single-column layout template that stacks all children in a full-width column.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders all children stacked vertically in a single full-width column. Three closely related sub-variants:
|
|
12
|
+
|
|
13
|
+
- **`OneColumn`** — core layout with internal grid and column style
|
|
14
|
+
- **`OneColumnPage`** — thin wrapper that delegates to `OneColumn` via the component registry
|
|
15
|
+
- **`OneColumnTab`** — minimal pass-through wrapper for tab context (`<div id='OneColumnTab'>`)
|
|
16
|
+
|
|
17
|
+
## Pega Metadata
|
|
18
|
+
|
|
19
|
+
| Variant | Registration Key |
|
|
20
|
+
|---------|-----------------|
|
|
21
|
+
| OneColumn | `OneColumn` |
|
|
22
|
+
| OneColumnPage | `OneColumnPage` |
|
|
23
|
+
| OneColumnTab | `OneColumnTab` |
|
|
24
|
+
|
|
25
|
+
All extend `PConnProps`. Children are received as React `children`.
|
|
26
|
+
|
|
27
|
+
## Props
|
|
28
|
+
|
|
29
|
+
| Prop | Type | Required | Description |
|
|
30
|
+
|------|------|----------|-------------|
|
|
31
|
+
| `children` | `ReactNode[]` | Yes | One or more children to render in the single column |
|
|
32
|
+
|
|
33
|
+
## Sub-Variants
|
|
34
|
+
|
|
35
|
+
### OneColumnPage
|
|
36
|
+
|
|
37
|
+
Thin pass-through wrapper. Retrieves `OneColumn` from the component registry and renders with all props forwarded:
|
|
38
|
+
```typescript
|
|
39
|
+
const OneColumn = getComponentFromRegistry('OneColumn');
|
|
40
|
+
return <OneColumn {...props} />;
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### OneColumnTab
|
|
44
|
+
|
|
45
|
+
Minimal wrapper — renders children in a plain `<div>` with `id='OneColumnTab'`:
|
|
46
|
+
```typescript
|
|
47
|
+
return <div id='OneColumnTab'>{children}</div>;
|
|
48
|
+
```
|
|
49
|
+
No grid or column styles applied. Used purely as a slot container inside tab panels.
|
|
50
|
+
|
|
51
|
+
## Behavioral Contract
|
|
52
|
+
|
|
53
|
+
1. Render a Grid container with `spacing={2}`.
|
|
54
|
+
2. Render a single inner Grid at `size={{ xs: 12 }}` with `colStyles` applied.
|
|
55
|
+
3. Map over all `children` and render each child.
|
|
56
|
+
4. `OneColumnPage` delegates all rendering to `OneColumn` from the registry.
|
|
57
|
+
5. `OneColumnTab` renders children in a plain `<div>` — no Grid, no styles.
|
|
58
|
+
|
|
59
|
+
## Visual Specifications
|
|
60
|
+
|
|
61
|
+
Derived from `OneColumn.tsx` makeStyles:
|
|
62
|
+
|
|
63
|
+
### Column Style
|
|
64
|
+
|
|
65
|
+
| Property | Value |
|
|
66
|
+
|----------|-------|
|
|
67
|
+
| Display | grid |
|
|
68
|
+
| Gap | 1rem |
|
|
69
|
+
| Align content | baseline (children stack top-aligned) |
|
|
70
|
+
|
|
71
|
+
### Grid Spacing
|
|
72
|
+
|
|
73
|
+
| Property | Value |
|
|
74
|
+
|----------|-------|
|
|
75
|
+
| Container spacing | 2 (≈ 16px) |
|
|
76
|
+
|
|
77
|
+
**CSS-only implementation notes:**
|
|
78
|
+
- Column: `display: grid; gap: 1rem; align-content: baseline; width: 100%`.
|
|
79
|
+
- Outer container: `display: grid; grid-template-columns: 1fr; gap: 16px`.
|
|
80
|
+
- `OneColumnTab`: just `<div>` with no special styling.
|
|
81
|
+
|
|
82
|
+
## Edge Cases & Special Logic
|
|
83
|
+
|
|
84
|
+
- `OneColumn` maps over all children (not just first/second) — supports any number of children.
|
|
85
|
+
- `OneColumnPage` uses the registry — if an override exists for `OneColumn`, it will be used.
|
|
86
|
+
- `OneColumnTab` does NOT apply the `colStyles` grid — it is intentionally simpler.
|
|
87
|
+
|
|
88
|
+
## Dependencies
|
|
89
|
+
|
|
90
|
+
- `OneColumnPage`: `getComponentFromRegistry` from `@pega/sdk-react`
|
|
91
|
+
- `OneColumn` / `OneColumnTab`: no special dependencies
|
|
92
|
+
|
|
93
|
+
## Design System Mapping
|
|
94
|
+
|
|
95
|
+
**UI control type:** Single full-width column layout.
|
|
96
|
+
|
|
97
|
+
Listed design systems are examples only.
|
|
98
|
+
|
|
99
|
+
| Design System | Recommended Component |
|
|
100
|
+
|---|---|
|
|
101
|
+
| Default (CSS only) | `<div style="display:grid;gap:1rem;">` wrapping children |
|
|
102
|
+
| MUI | `<Grid container spacing={2}><Grid size={{ xs: 12 }}>` |
|
|
103
|
+
| Ant Design | `<Row><Col span={24}>` |
|
|
104
|
+
| Chakra UI | `<Stack spacing={4}>` or `<Grid templateColumns='1fr'>` |
|
|
105
|
+
| Shadcn/ui | Tailwind `flex flex-col gap-4` |
|
|
106
|
+
|
|
107
|
+
When implementing in a specific design system:
|
|
108
|
+
- All children render in a single column, top-aligned
|
|
109
|
+
- `OneColumnTab` variant is a minimal `<div>` container with no layout styling
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# Skill: PromotedFilters
|
|
2
|
+
|
|
3
|
+
Promoted filters template. Renders a set of promoted filter fields above a `ListView`, allowing users to filter list data through a Clear/Search workflow using transient data.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders promoted filter controls above a list view. Filter fields are created dynamically via `PCore.createPConnect` and managed as transient data. On search, filter values are formatted and passed to the `ListView` as a query payload. The component also handles the `ListView` rendering below the filters.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Registration key:** `PromotedFilters` (in `component-map.ts`)
|
|
16
|
+
- **Category:** Search / Filter template
|
|
17
|
+
- **Extends:** `PConnProps`
|
|
18
|
+
|
|
19
|
+
## Props
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Required | Description |
|
|
22
|
+
|------|------|----------|-------------|
|
|
23
|
+
| `viewName` | `string` | Yes | Name of the promoted filters view — used as transient item ID |
|
|
24
|
+
| `dataPageName` | `string` | Yes | Data page name passed to `ListView` |
|
|
25
|
+
| `promotedFilters` | `array` | Yes | Array of filter field definitions `{ name, classID, ... }` |
|
|
26
|
+
| `payload` | `object` | No | Base query payload for the data page |
|
|
27
|
+
| `isSearchable` | `boolean` | No | Whether the ListView below shows a global search input |
|
|
28
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
29
|
+
|
|
30
|
+
## Behavioral Contract
|
|
31
|
+
|
|
32
|
+
### Transient Data Setup
|
|
33
|
+
|
|
34
|
+
On mount:
|
|
35
|
+
1. Build `filtersWithClassID`: add `classID` to each filter from `getPConnect().getContextName()` or metadata.
|
|
36
|
+
2. Call `PCore.getDataPageUtils().addTransientItem({ id: viewName, data: filtersWithClassID })`.
|
|
37
|
+
3. This creates a transient data context for the filter fields.
|
|
38
|
+
|
|
39
|
+
### Filters Sub-Component
|
|
40
|
+
|
|
41
|
+
The `<Filters>` inline sub-component:
|
|
42
|
+
1. Creates each filter field via `PCore.createPConnect({ ... filterFieldConfig, contextName: viewName + '.' + filter.name })`.
|
|
43
|
+
2. Renders each created pConnect as a field component via `createElement(PConnectComponent, { ...fieldConfig })`.
|
|
44
|
+
|
|
45
|
+
### Search
|
|
46
|
+
|
|
47
|
+
On Search button click:
|
|
48
|
+
1. Call `getFilterData(viewName, promotedFilters)`:
|
|
49
|
+
- For each filter, read current value from transient store.
|
|
50
|
+
- Build filter objects: `{ lhs: { field: filter.name }, comparator: 'EQ', rhs: { value: currentValue } }`.
|
|
51
|
+
- Skip filters with empty/null values.
|
|
52
|
+
2. Pass the resulting filter array to `ListView` as `payload.filters`.
|
|
53
|
+
3. `ListView` re-fetches with the filter payload.
|
|
54
|
+
|
|
55
|
+
### Clear
|
|
56
|
+
|
|
57
|
+
On Clear button click:
|
|
58
|
+
1. Call `clearFilterData(viewName, promotedFilters)`:
|
|
59
|
+
- For each filter, reset the transient value to `''` or `null`.
|
|
60
|
+
2. Reset `payload.filters` to `[]`.
|
|
61
|
+
3. `ListView` re-fetches without filters.
|
|
62
|
+
|
|
63
|
+
### Render Structure
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
<div className="psdk-promoted-filters">
|
|
67
|
+
<div className="psdk-promoted-filters-fields">
|
|
68
|
+
<Filters /> {/* filter fields */}
|
|
69
|
+
</div>
|
|
70
|
+
<div className="psdk-promoted-filters-actions">
|
|
71
|
+
<Button onClick={handleClear}>Clear</Button>
|
|
72
|
+
<Button onClick={handleSearch}>Search</Button>
|
|
73
|
+
</div>
|
|
74
|
+
<ListView bInForm={true} isSearchable={isSearchable} dataPageName={dataPageName} payload={activePayload} />
|
|
75
|
+
</div>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Visual Specifications
|
|
79
|
+
|
|
80
|
+
| Element | Description |
|
|
81
|
+
|---------|-------------|
|
|
82
|
+
| Filter fields row | Horizontal flex row of filter field inputs |
|
|
83
|
+
| Action buttons | Clear + Search buttons, right-aligned |
|
|
84
|
+
| ListView | Below the filter row, full width |
|
|
85
|
+
|
|
86
|
+
**CSS-only implementation notes:**
|
|
87
|
+
- Outer container: `display: flex; flex-direction: column; gap: 1rem`.
|
|
88
|
+
- Filter fields row: `display: flex; flex-wrap: wrap; gap: 0.5rem; align-items: flex-end`.
|
|
89
|
+
- Action buttons row: `display: flex; gap: 0.5rem; justify-content: flex-end`.
|
|
90
|
+
|
|
91
|
+
## Edge Cases & Special Logic
|
|
92
|
+
|
|
93
|
+
- Transient item must be cleaned up on unmount: call `PCore.getDataPageUtils().removeTransientItem(viewName)`.
|
|
94
|
+
- `getFilterData` skips empty values — a filter with no input is not sent to the query.
|
|
95
|
+
- If all filters are empty, the Search returns unfiltered results.
|
|
96
|
+
- `PCore.createPConnect` creates new pConnect instances for each filter — these must be properly keyed and managed.
|
|
97
|
+
|
|
98
|
+
## Dependencies
|
|
99
|
+
|
|
100
|
+
- `getFilterData`, `clearFilterData` from `./utils`
|
|
101
|
+
- `PCore.getDataPageUtils().addTransientItem()` — transient context setup
|
|
102
|
+
- `PCore.createPConnect()` — creates pConnect instances for filter fields
|
|
103
|
+
- `ListView` — the list below the filters
|
|
104
|
+
- `PConnectComponent` from `@pega/sdk-react`
|
|
105
|
+
- MUI: `<Button>`
|
|
106
|
+
|
|
107
|
+
## Design System Mapping
|
|
108
|
+
|
|
109
|
+
**UI control type:** Filter bar above a list view — transient field inputs + Clear/Search actions.
|
|
110
|
+
|
|
111
|
+
Listed design systems are examples only.
|
|
112
|
+
|
|
113
|
+
| Design System | Filter Row | Action Buttons |
|
|
114
|
+
|---|---|---|
|
|
115
|
+
| Default (CSS only) | `display: flex; flex-wrap: wrap` inputs | `<button>` for Clear/Search |
|
|
116
|
+
| MUI | `<Box display='flex' flexWrap='wrap' gap={1}>` | `<Button>` variants |
|
|
117
|
+
| Ant Design | `<Space wrap>` | `<Button type='primary'>` for Search |
|
|
118
|
+
| Chakra UI | `<HStack wrap='wrap'>` | `<Button colorScheme='blue'>` |
|
|
119
|
+
| Shadcn/ui | Tailwind `flex flex-wrap gap-2` | `<Button>` variants |
|
|
120
|
+
|
|
121
|
+
When implementing in a specific design system:
|
|
122
|
+
- Transient data pattern is critical — each filter field must read/write to `PCore`'s transient store
|
|
123
|
+
- `getFilterData` builds the query filter payload — use it unchanged
|
|
124
|
+
- Transient item cleanup on unmount is required to avoid stale data
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# Skill: SelfServiceCaseView
|
|
2
|
+
|
|
3
|
+
Self-service portal case view template. Renders a case workspace optimized for self-service channels, with a compact summary sidebar, main content area, and optional utilities panel.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
A case view variant designed for self-service portal channels. Uses a horizontal flex layout (25% summary / flex:1 main / 25% utilities) instead of the 3-column grid of `CaseView`. Filters case summary data to only include fields available in the self-service channel, and filters utilities to self-service-appropriate actions.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Registration key:** `SelfServiceCaseView` (in `component-map.ts`)
|
|
16
|
+
- **Category:** Page template — self-service case workspace
|
|
17
|
+
- **Extends:** `PConnProps`
|
|
18
|
+
|
|
19
|
+
## Props
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Required | Description |
|
|
22
|
+
|------|------|----------|-------------|
|
|
23
|
+
| `children` | `ReactNode[]` | Yes | Region children (variable count based on `isObjectType`) |
|
|
24
|
+
| `isObjectType` | `boolean` | No | Whether the case is an object-type (affects child region count) |
|
|
25
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
26
|
+
|
|
27
|
+
## Behavioral Contract
|
|
28
|
+
|
|
29
|
+
### Region Assignment by Child Index
|
|
30
|
+
|
|
31
|
+
Child indexing depends on `isObjectType`:
|
|
32
|
+
|
|
33
|
+
**`isObjectType === false` (5 children):**
|
|
34
|
+
| Index | Region |
|
|
35
|
+
|-------|--------|
|
|
36
|
+
| 0 | Summary |
|
|
37
|
+
| 1 | (Header/Stages) |
|
|
38
|
+
| 2 | Main content |
|
|
39
|
+
| 3 | Utilities |
|
|
40
|
+
| 4 | (Additional) |
|
|
41
|
+
|
|
42
|
+
**`isObjectType === true` (3 children):**
|
|
43
|
+
| Index | Region |
|
|
44
|
+
|-------|--------|
|
|
45
|
+
| 0 | Summary |
|
|
46
|
+
| 1 | Main content |
|
|
47
|
+
| 2 | Utilities |
|
|
48
|
+
|
|
49
|
+
Show/hide individual regions based on:
|
|
50
|
+
- `showSummary`: always show summary region.
|
|
51
|
+
- `showMain`: always show main content region.
|
|
52
|
+
- `showUtilities`: show utilities only if the region has content.
|
|
53
|
+
|
|
54
|
+
### `selfServiceCaseViewHeader`
|
|
55
|
+
|
|
56
|
+
Renders a slim header bar above the main flex layout showing:
|
|
57
|
+
- Case ID / case type name
|
|
58
|
+
- Case status badge
|
|
59
|
+
|
|
60
|
+
### Case Summary Data
|
|
61
|
+
|
|
62
|
+
Call `prepareCaseSummaryData(primaryFields, secondaryFields, getPConnect)` with a filter:
|
|
63
|
+
- Only include fields where `availableInChannel.selfService === true`.
|
|
64
|
+
|
|
65
|
+
### Utilities Filter
|
|
66
|
+
|
|
67
|
+
Call `filterUtilities(utilitiesChildren, getPConnect)` to remove utilities not appropriate for self-service channels.
|
|
68
|
+
|
|
69
|
+
### Render Structure
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
<div className="psdk-ss-case-view">
|
|
73
|
+
<selfServiceCaseViewHeader />
|
|
74
|
+
<div className="psdk-ss-case-view-body" style="display:flex; flex-direction:row">
|
|
75
|
+
<div style="flex: 0 0 25%"> {/* Summary */}
|
|
76
|
+
{showSummary && summaryRegion}
|
|
77
|
+
</div>
|
|
78
|
+
<div style="flex: 1"> {/* Main content */}
|
|
79
|
+
{showMain && mainRegion}
|
|
80
|
+
</div>
|
|
81
|
+
<div style="flex: 0 0 25%"> {/* Utilities */}
|
|
82
|
+
{showUtilities && utilitiesRegion}
|
|
83
|
+
</div>
|
|
84
|
+
</div>
|
|
85
|
+
</div>
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Visual Specifications
|
|
89
|
+
|
|
90
|
+
| Column | Width | Contents |
|
|
91
|
+
|--------|-------|----------|
|
|
92
|
+
| Summary | 25% (fixed) | Case summary fields (self-service filtered) |
|
|
93
|
+
| Main | flex: 1 | Main case content / assignment form |
|
|
94
|
+
| Utilities | 25% (fixed) | Filtered utilities |
|
|
95
|
+
|
|
96
|
+
**CSS-only implementation notes:**
|
|
97
|
+
- Body layout: `display: flex; flex-direction: row; gap: 1rem`.
|
|
98
|
+
- Summary column: `flex: 0 0 25%; min-width: 0`.
|
|
99
|
+
- Main column: `flex: 1 1 auto; min-width: 0`.
|
|
100
|
+
- Utilities column: `flex: 0 0 25%; min-width: 0`.
|
|
101
|
+
- Header bar: `display: flex; align-items: center; gap: 1rem; padding: 0.5rem 0; margin-bottom: 1rem`.
|
|
102
|
+
- Responsive: collapse to single column on mobile.
|
|
103
|
+
|
|
104
|
+
## Edge Cases & Special Logic
|
|
105
|
+
|
|
106
|
+
- `isObjectType` changes the number of `children` — always derive regions by index based on this flag.
|
|
107
|
+
- `filterUtilities` may return empty array — `showUtilities` should be `false` in that case (hide the column entirely).
|
|
108
|
+
- Summary fields filtered by `availableInChannel.selfService` — if all fields are filtered out, the summary column may be empty.
|
|
109
|
+
- The self-service header differs from the standard case header — it is a separate sub-component, not the full `CaseView` header.
|
|
110
|
+
|
|
111
|
+
## Dependencies
|
|
112
|
+
|
|
113
|
+
- `prepareCaseSummaryData` from `./utils` — with self-service channel filter applied
|
|
114
|
+
- `filterUtilities` from `./utils` — removes non-self-service utilities
|
|
115
|
+
- `selfServiceCaseViewHeader` — inline sub-component or imported header
|
|
116
|
+
- `PConnectComponent` from `@pega/sdk-react`
|
|
117
|
+
|
|
118
|
+
## Design System Mapping
|
|
119
|
+
|
|
120
|
+
**UI control type:** Self-service portal case workspace — horizontal 3-panel flex layout.
|
|
121
|
+
|
|
122
|
+
Listed design systems are examples only.
|
|
123
|
+
|
|
124
|
+
| Design System | Layout | Header Bar |
|
|
125
|
+
|---|---|---|
|
|
126
|
+
| Default (CSS only) | CSS `display:flex` with percentage widths | Custom `<header>` |
|
|
127
|
+
| MUI | `<Box display='flex' flexDirection='row'>` with `<Box flex='0 0 25%'>` | `<Box>` with `<Typography>` |
|
|
128
|
+
| Ant Design | `<Layout>` with `<Sider>` + `<Content>` | `<PageHeader>` |
|
|
129
|
+
| Chakra UI | `<HStack align='stretch'>` with width constraints | `<Flex>` |
|
|
130
|
+
| Shadcn/ui | Tailwind `flex flex-row` | Custom header |
|
|
131
|
+
|
|
132
|
+
When implementing in a specific design system:
|
|
133
|
+
- `isObjectType` determines child count — do not assume fixed child order without checking this flag
|
|
134
|
+
- Self-service channel filter on summary data is mandatory — `availableInChannel.selfService === true`
|
|
135
|
+
- `filterUtilities` result controls utilities column visibility
|