@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
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: SelfServiceCaseView
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: SelfServiceCaseView
|
|
7
|
+
|
|
8
|
+
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.
|
|
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
|
+
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.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `SelfServiceCaseView` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Page template — self-service case workspace
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `children` | `ReactNode[]` | Yes | Region children (variable count based on `isObjectType`) |
|
|
29
|
+
| `isObjectType` | `boolean` | No | Whether the case is an object-type (affects child region count) |
|
|
30
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
31
|
+
|
|
32
|
+
## Behavioral Contract
|
|
33
|
+
|
|
34
|
+
### Region Assignment by Child Index
|
|
35
|
+
|
|
36
|
+
Child indexing depends on `isObjectType`:
|
|
37
|
+
|
|
38
|
+
**`isObjectType === false` (5 children):**
|
|
39
|
+
| Index | Region |
|
|
40
|
+
|-------|--------|
|
|
41
|
+
| 0 | Summary |
|
|
42
|
+
| 1 | (Header/Stages) |
|
|
43
|
+
| 2 | Main content |
|
|
44
|
+
| 3 | Utilities |
|
|
45
|
+
| 4 | (Additional) |
|
|
46
|
+
|
|
47
|
+
**`isObjectType === true` (3 children):**
|
|
48
|
+
| Index | Region |
|
|
49
|
+
|-------|--------|
|
|
50
|
+
| 0 | Summary |
|
|
51
|
+
| 1 | Main content |
|
|
52
|
+
| 2 | Utilities |
|
|
53
|
+
|
|
54
|
+
Show/hide individual regions based on:
|
|
55
|
+
- `showSummary`: always show summary region.
|
|
56
|
+
- `showMain`: always show main content region.
|
|
57
|
+
- `showUtilities`: show utilities only if the region has content.
|
|
58
|
+
|
|
59
|
+
### `selfServiceCaseViewHeader`
|
|
60
|
+
|
|
61
|
+
Renders a slim header bar above the main flex layout showing:
|
|
62
|
+
- Case ID / case type name
|
|
63
|
+
- Case status badge
|
|
64
|
+
|
|
65
|
+
### Case Summary Data
|
|
66
|
+
|
|
67
|
+
Call `prepareCaseSummaryData(primaryFields, secondaryFields, getPConnect)` with a filter:
|
|
68
|
+
- Only include fields where `availableInChannel.selfService === true`.
|
|
69
|
+
|
|
70
|
+
### Utilities Filter
|
|
71
|
+
|
|
72
|
+
Call `filterUtilities(utilitiesChildren, getPConnect)` to remove utilities not appropriate for self-service channels.
|
|
73
|
+
|
|
74
|
+
### Render Structure
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
<div className="psdk-ss-case-view">
|
|
78
|
+
<selfServiceCaseViewHeader />
|
|
79
|
+
<div className="psdk-ss-case-view-body" style="display:flex; flex-direction:row">
|
|
80
|
+
<div style="flex: 0 0 25%"> {/* Summary */}
|
|
81
|
+
{showSummary && summaryRegion}
|
|
82
|
+
</div>
|
|
83
|
+
<div style="flex: 1"> {/* Main content */}
|
|
84
|
+
{showMain && mainRegion}
|
|
85
|
+
</div>
|
|
86
|
+
<div style="flex: 0 0 25%"> {/* Utilities */}
|
|
87
|
+
{showUtilities && utilitiesRegion}
|
|
88
|
+
</div>
|
|
89
|
+
</div>
|
|
90
|
+
</div>
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Visual Specifications
|
|
94
|
+
|
|
95
|
+
| Column | Width | Contents |
|
|
96
|
+
|--------|-------|----------|
|
|
97
|
+
| Summary | 25% (fixed) | Case summary fields (self-service filtered) |
|
|
98
|
+
| Main | flex: 1 | Main case content / assignment form |
|
|
99
|
+
| Utilities | 25% (fixed) | Filtered utilities |
|
|
100
|
+
|
|
101
|
+
**CSS-only implementation notes:**
|
|
102
|
+
- Body layout: `display: flex; flex-direction: row; gap: 1rem`.
|
|
103
|
+
- Summary column: `flex: 0 0 25%; min-width: 0`.
|
|
104
|
+
- Main column: `flex: 1 1 auto; min-width: 0`.
|
|
105
|
+
- Utilities column: `flex: 0 0 25%; min-width: 0`.
|
|
106
|
+
- Header bar: `display: flex; align-items: center; gap: 1rem; padding: 0.5rem 0; margin-bottom: 1rem`.
|
|
107
|
+
- Responsive: collapse to single column on mobile.
|
|
108
|
+
|
|
109
|
+
## Edge Cases & Special Logic
|
|
110
|
+
|
|
111
|
+
- `isObjectType` changes the number of `children` — always derive regions by index based on this flag.
|
|
112
|
+
- `filterUtilities` may return empty array — `showUtilities` should be `false` in that case (hide the column entirely).
|
|
113
|
+
- Summary fields filtered by `availableInChannel.selfService` — if all fields are filtered out, the summary column may be empty.
|
|
114
|
+
- The self-service header differs from the standard case header — it is a separate sub-component, not the full `CaseView` header.
|
|
115
|
+
|
|
116
|
+
## Dependencies
|
|
117
|
+
|
|
118
|
+
- `prepareCaseSummaryData` from `./utils` — with self-service channel filter applied
|
|
119
|
+
- `filterUtilities` from `./utils` — removes non-self-service utilities
|
|
120
|
+
- `selfServiceCaseViewHeader` — inline sub-component or imported header
|
|
121
|
+
- `PConnectComponent` from `@pega/sdk-react`
|
|
122
|
+
|
|
123
|
+
## Design System Mapping
|
|
124
|
+
|
|
125
|
+
**UI control type:** Self-service portal case workspace — horizontal 3-panel flex layout.
|
|
126
|
+
|
|
127
|
+
Listed design systems are examples only.
|
|
128
|
+
|
|
129
|
+
| Design System | Layout | Header Bar |
|
|
130
|
+
|---|---|---|
|
|
131
|
+
| Default (CSS only) | CSS `display:flex` with percentage widths | Custom `<header>` |
|
|
132
|
+
| MUI | `<Box display='flex' flexDirection='row'>` with `<Box flex='0 0 25%'>` | `<Box>` with `<Typography>` |
|
|
133
|
+
| Ant Design | `<Layout>` with `<Sider>` + `<Content>` | `<PageHeader>` |
|
|
134
|
+
| Chakra UI | `<HStack align='stretch'>` with width constraints | `<Flex>` |
|
|
135
|
+
| Shadcn/ui | Tailwind `flex flex-row` | Custom header |
|
|
136
|
+
|
|
137
|
+
When implementing in a specific design system:
|
|
138
|
+
- `isObjectType` determines child count — do not assume fixed child order without checking this flag
|
|
139
|
+
- Self-service channel filter on summary data is mandatory — `availableInChannel.selfService === true`
|
|
140
|
+
- `filterUtilities` result controls utilities column visibility
|
package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SimpleTable.mdrules
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: SimpleTable
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: SimpleTable
|
|
7
|
+
|
|
8
|
+
Simple table template. Routes to FieldGroupTemplate, ListView (read-only), or the manual editable table based on configuration. Also covers `SimpleTableManual`, `SimpleTableSelect`, and `SimpleTableSelectReadonly` sub-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
|
+
Entry-point template for embedded table data in a form or detail view. Routes to the appropriate sub-component based on `multiRecordDisplayAs`, `fieldMetadata.dataRetrievalType`, and `readOnly`/`displayMode` flags. Sub-variants handle selection, read-only display, and full manual editing.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration keys:** `SimpleTable`, `SimpleTableManual`, `SimpleTableSelect`, `SimpleTableSelectReadonly` (all in `component-map.ts`)
|
|
21
|
+
- **Category:** Data display / Form template — embedded table
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `multiRecordDisplayAs` | `string` | No | `'fieldGroup'` delegates to FieldGroupTemplate; else table |
|
|
29
|
+
| `fieldMetadata` | `object` | No | Field-level metadata including `dataRetrievalType` |
|
|
30
|
+
| `referenceList` | `string` | No | Property path to the reference list |
|
|
31
|
+
| `displayAs` | `string` | No | For SimpleTableSelectReadonly: `'readonlyMulti'`, `'combobox'`, `'checkboxgroup'` routing |
|
|
32
|
+
| `selectionMode` | `string` | No | `'single'` or `'multi'` (for SimpleTableSelect) |
|
|
33
|
+
| `displayMode` | `string` | No | `'DISPLAY_ONLY'` triggers read-only sub-variant |
|
|
34
|
+
| `readOnly` | `boolean` | No | Alternative read-only flag |
|
|
35
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
36
|
+
|
|
37
|
+
## Behavioral Contract
|
|
38
|
+
|
|
39
|
+
### SimpleTable — Routing Logic
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
if multiRecordDisplayAs === 'fieldGroup':
|
|
43
|
+
→ render FieldGroupTemplate
|
|
44
|
+
else if fieldMetadata.dataRetrievalType === 'refer':
|
|
45
|
+
→ render ListView (read-only, bInForm: true)
|
|
46
|
+
else:
|
|
47
|
+
→ render SimpleTableManual (editable table)
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### SimpleTableManual — Full Editable Table
|
|
51
|
+
|
|
52
|
+
Full MUI table with add/delete rows, inline editing, sort, filter, and column customization (~600+ lines).
|
|
53
|
+
|
|
54
|
+
Key behaviors:
|
|
55
|
+
1. **Row data source:** `referenceList` property path via `pConn.getValue(referenceList + '.pxResults')`.
|
|
56
|
+
2. **Add row:** `pConn.getListActions().insert({})`.
|
|
57
|
+
3. **Delete row:** `pConn.getListActions().deleteEntry(index)`.
|
|
58
|
+
4. **Inline field editing:** Each cell renders the field's registered edit component via `buildView(pConn, rowIndex, colFieldName)`.
|
|
59
|
+
5. **Sort:** Client-side sort on loaded data.
|
|
60
|
+
6. **Column customization:** Visibility toggles per column via a settings popover.
|
|
61
|
+
7. **Filter dialog:** Same filter pattern as ListView.
|
|
62
|
+
|
|
63
|
+
### SimpleTableSelect — Selection Mode
|
|
64
|
+
|
|
65
|
+
Wraps `ListView` with additional selection configuration:
|
|
66
|
+
- Passes `additionalTableConfig` with `selectionMode: 'single'` or `'multi'`.
|
|
67
|
+
- On selection: calls `pConn.getListActions().setSelectedRow(selectedData)`.
|
|
68
|
+
- Used when `DataReference` routes to table-based selection.
|
|
69
|
+
|
|
70
|
+
### SimpleTableSelectReadonly — Read-Only with Modal
|
|
71
|
+
|
|
72
|
+
1. Renders a link/chip showing the current selection count.
|
|
73
|
+
2. On click: opens a `<Dialog>` containing a `<SimpleTableManual>` in read-only mode.
|
|
74
|
+
3. Props: same as `SimpleTableManual` but all fields locked (no add/delete/edit).
|
|
75
|
+
|
|
76
|
+
## Visual Specifications
|
|
77
|
+
|
|
78
|
+
### SimpleTableManual
|
|
79
|
+
|
|
80
|
+
| Element | Description |
|
|
81
|
+
|---------|-------------|
|
|
82
|
+
| Toolbar | Column settings button, filter button, optional search |
|
|
83
|
+
| Table | Full-width, alternating row colors |
|
|
84
|
+
| Add row | `"+ Add row"` button below the table |
|
|
85
|
+
| Delete row | Trash icon per row (rightmost column) |
|
|
86
|
+
| Column settings | Popover with checkboxes for visibility toggles |
|
|
87
|
+
|
|
88
|
+
**CSS-only implementation notes:**
|
|
89
|
+
- Table: `width: 100%; border-collapse: collapse`.
|
|
90
|
+
- Add row button: `margin-top: 0.5rem; text-align: left`.
|
|
91
|
+
- Delete cell: `width: 40px; text-align: center`.
|
|
92
|
+
- Read-only mode: hide add/delete controls; cells show plain text.
|
|
93
|
+
|
|
94
|
+
### SimpleTableSelectReadonly
|
|
95
|
+
|
|
96
|
+
| Element | Description |
|
|
97
|
+
|---------|-------------|
|
|
98
|
+
| Trigger | Link or chip showing selection count |
|
|
99
|
+
| Modal | Full-screen or large dialog with SimpleTableManual |
|
|
100
|
+
| Modal close | `X` button in modal header |
|
|
101
|
+
|
|
102
|
+
## Edge Cases & Special Logic
|
|
103
|
+
|
|
104
|
+
- `multiRecordDisplayAs === 'fieldGroup'` — completely bypasses table; delegates to `FieldGroupTemplate`.
|
|
105
|
+
- `dataRetrievalType === 'refer'` — data comes from a reference list, not a full data page; use `ListView` in read-only mode.
|
|
106
|
+
- `SimpleTableManual` with 600+ lines — break into sub-hooks if re-implementing.
|
|
107
|
+
- Row keys must be unique — use composite keys from `compositeKeys` config if available.
|
|
108
|
+
- Column customization state is local — not persisted across navigation.
|
|
109
|
+
|
|
110
|
+
## Dependencies
|
|
111
|
+
|
|
112
|
+
- `FieldGroupTemplate` (for `multiRecordDisplayAs === 'fieldGroup'` routing)
|
|
113
|
+
- `ListView` (for `dataRetrievalType === 'refer'` routing)
|
|
114
|
+
- `buildView` from `../../helpers/field-group-utils` (for inline cell rendering in SimpleTableManual)
|
|
115
|
+
- MUI: `<Table>`, `<Dialog>`, `<Popover>`, `<IconButton>`, `<Button>`, `<Checkbox>`
|
|
116
|
+
|
|
117
|
+
## Design System Mapping
|
|
118
|
+
|
|
119
|
+
**UI control type:** Embedded data table with routing to field group, read-only list, or fully editable table.
|
|
120
|
+
|
|
121
|
+
Listed design systems are examples only.
|
|
122
|
+
|
|
123
|
+
| Sub-variant | Default (CSS only) | MUI |
|
|
124
|
+
|---|---|---|
|
|
125
|
+
| SimpleTableManual | `<table>` + custom controls | MUI `<Table>` |
|
|
126
|
+
| SimpleTableSelect | Custom table + radio/checkbox | `<ListView>` wrapper |
|
|
127
|
+
| SimpleTableSelectReadonly | Link + `<dialog>` | Chip + `<Dialog>` |
|
|
128
|
+
|
|
129
|
+
When implementing in a specific design system:
|
|
130
|
+
- Always check `multiRecordDisplayAs === 'fieldGroup'` first — this bypasses the table entirely
|
|
131
|
+
- `SimpleTableManual` add/delete row controls must be hidden when `readOnly === true` or `displayMode === 'DISPLAY_ONLY'`
|
|
132
|
+
- `SimpleTableSelect` uses the same `ListView` but adds selection callbacks
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: SingleReferenceReadOnly
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: SingleReferenceReadOnly
|
|
7
|
+
|
|
8
|
+
Single reference read-only template. Renders a read-only reference field as a semantic link for editable field types, or as a plain label otherwise.
|
|
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 single data reference field in read-only mode. For fields that were displayed as editable selection controls (autocomplete, table select, dropdown), renders a `SemanticLink` component so the reference value is clickable/navigable. For other display types, renders a plain read-only label.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `SingleReferenceReadOnly` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Display template — read-only reference
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `label` | `string` | Yes | Field label |
|
|
29
|
+
| `displayAs` | `string` | Yes | The edit-mode display type this field was configured with |
|
|
30
|
+
| `value` | `string` | No | Current field value (display text) |
|
|
31
|
+
| `caseClass` | `string` | No | Class identifier for the referenced case |
|
|
32
|
+
| `text` | `string` | No | Display text for the semantic link |
|
|
33
|
+
| `caseID` | `string` | No | Case ID for the semantic link |
|
|
34
|
+
| `contextPage` | `string` | No | Context page identifier |
|
|
35
|
+
| `resourceParams` | `object` | No | Parameters for the referenced resource |
|
|
36
|
+
| `resourcePayload` | `object` | No | Payload for resource navigation |
|
|
37
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
38
|
+
|
|
39
|
+
## Behavioral Contract
|
|
40
|
+
|
|
41
|
+
### Editable Component Check
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
editableComponents = ['AutoComplete', 'SimpleTableSelect', 'Dropdown']
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
If `displayAs` is in `editableComponents`:
|
|
48
|
+
1. Build config with: `caseClass`, `text`, `caseID`, `contextPage`, `resourceParams`, `resourcePayload`.
|
|
49
|
+
2. Create: `createComponent({ type: 'SemanticLink', config: { ...builtConfig } })`.
|
|
50
|
+
3. Render the created `SemanticLink` component.
|
|
51
|
+
|
|
52
|
+
Else:
|
|
53
|
+
- Render a plain read-only display using `<FormControl variant='standard'>` + `<FormLabel>` + value text.
|
|
54
|
+
|
|
55
|
+
### Layout
|
|
56
|
+
|
|
57
|
+
For both variants, wrap with:
|
|
58
|
+
```tsx
|
|
59
|
+
<FormControl variant='standard' sx={{ flexDirection: 'row' }}>
|
|
60
|
+
<FormLabel sx={{ marginRight: '2rem' }}>{label}</FormLabel>
|
|
61
|
+
{semanLinkOrValue}
|
|
62
|
+
</FormControl>
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Visual Specifications
|
|
66
|
+
|
|
67
|
+
| Variant | Layout |
|
|
68
|
+
|---------|--------|
|
|
69
|
+
| SemanticLink | Label (left) + clickable link (right) |
|
|
70
|
+
| Plain read-only | Label (left) + plain text (right) |
|
|
71
|
+
|
|
72
|
+
**CSS-only implementation notes:**
|
|
73
|
+
- Wrapper: `display: flex; flex-direction: row; align-items: baseline; gap: 1rem`.
|
|
74
|
+
- Label: `font-size: 0.875rem; color: var(--secondary-text-color); min-width: 120px`.
|
|
75
|
+
- Semantic link: `color: var(--link-color); text-decoration: underline; cursor: pointer`.
|
|
76
|
+
- Plain value: `font-size: 0.875rem; color: var(--primary-text-color)`.
|
|
77
|
+
|
|
78
|
+
## Edge Cases & Special Logic
|
|
79
|
+
|
|
80
|
+
- `displayAs` check is case-sensitive — values are `'AutoComplete'`, `'SimpleTableSelect'`, `'Dropdown'` (exact match).
|
|
81
|
+
- `createComponent` returns a PConnect config — render via `createElement(PConnectComponent, { ...createdConfig })`.
|
|
82
|
+
- If `text` is empty/undefined, the semantic link shows the `caseID` as fallback text.
|
|
83
|
+
- `SemanticLink` navigation requires `caseClass` and `caseID` — if either is missing, fall back to plain read-only display.
|
|
84
|
+
|
|
85
|
+
## Dependencies
|
|
86
|
+
|
|
87
|
+
- `PConnectComponent` from `@pega/sdk-react` — for rendering the `SemanticLink`
|
|
88
|
+
- `getPConnect().createComponent()` — creates the SemanticLink component config
|
|
89
|
+
- MUI: `<FormControl>`, `<FormLabel>`
|
|
90
|
+
|
|
91
|
+
## Design System Mapping
|
|
92
|
+
|
|
93
|
+
**UI control type:** Read-only reference field — semantic link for navigable references, plain label otherwise.
|
|
94
|
+
|
|
95
|
+
Listed design systems are examples only.
|
|
96
|
+
|
|
97
|
+
| Design System | Semantic Link | Plain Read-Only |
|
|
98
|
+
|---|---|---|
|
|
99
|
+
| Default (CSS only) | `<a>` with case navigation | `<span>` |
|
|
100
|
+
| MUI | `SemanticLink` rendered via `createComponent` | `<Typography>` |
|
|
101
|
+
| Ant Design | `<Typography.Link>` | `<Typography.Text>` |
|
|
102
|
+
| Chakra UI | `<Link>` | `<Text>` |
|
|
103
|
+
| Shadcn/ui | Custom link | `<span>` |
|
|
104
|
+
|
|
105
|
+
When implementing in a specific design system:
|
|
106
|
+
- The `editableComponents` list (`'AutoComplete'`, `'SimpleTableSelect'`, `'Dropdown'`) controls semantic link vs plain display
|
|
107
|
+
- `SemanticLink` must be rendered via `createComponent` — do not implement the link logic directly in this component
|
|
108
|
+
- Horizontal label + value layout (row direction) is required
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: SubTabs
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: SubTabs
|
|
7
|
+
|
|
8
|
+
Sub-tabs navigation template. Renders a tab container for case view sections using shared tab utilities with deferred content loading.
|
|
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 horizontal tab bar for navigating between case view sections. Uses shared `tabUtils` for tab state management (visible tabs, transient tabs, tab click). Tab content is deferred — only the active tab loads content. No section heading.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `SubTabs` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Navigation template
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `children` | `ReactNode[]` | Yes | `children[0]` is the deferred-loaded tabs container |
|
|
29
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
30
|
+
|
|
31
|
+
## Behavioral Contract
|
|
32
|
+
|
|
33
|
+
1. **Extract deferred tabs:** `deferLoadedTabs = Children.toArray(children)[0]`.
|
|
34
|
+
2. **State:** `currentTabId` (string, default `'0'`), `tabItems` (array).
|
|
35
|
+
3. **Compute visible tabs:** `getVisibleTabs(deferLoadedTabs, 'tabsSubs')` in `useEffect([deferLoadedTabs])` → `availableTabs`.
|
|
36
|
+
4. **Transient tabs:** `useEffect([currentTabId])` → `setTabItems(getTransientTabs(availableTabs, currentTabId, tabItems))`.
|
|
37
|
+
5. **Tab click:** `tabClick(index, availableTabs, currentTabId, setCurrentTabId, tabItems)` from `tabUtils`.
|
|
38
|
+
6. **Render:**
|
|
39
|
+
- `<TabContext value={currentTabId}>`
|
|
40
|
+
- `<Tabs onChange={handleTabClick} value={currentTabId}>` — one `<Tab>` per `tabItems`
|
|
41
|
+
- One `<TabPanel>` per `tabItems` with `tab.content || ''`
|
|
42
|
+
7. No section heading (unlike `DetailsSubTabs`).
|
|
43
|
+
|
|
44
|
+
> **Difference from `DetailsSubTabs`:** SubTabs has no `label`/`showLabel` props and no `<h3>` heading. Uses `'tabsSubs'` identifier for `getVisibleTabs` (vs `'detailsSubTabs'`).
|
|
45
|
+
|
|
46
|
+
## Visual Specifications
|
|
47
|
+
|
|
48
|
+
Identical to `DetailsSubTabs` except no heading above the tab bar.
|
|
49
|
+
|
|
50
|
+
**CSS-only implementation notes:**
|
|
51
|
+
- Tab bar: `display: flex; border-bottom: 2px solid var(--divider)`.
|
|
52
|
+
- Each tab: `padding: 8px 16px; cursor: pointer; border-bottom: 2px solid transparent`.
|
|
53
|
+
- Active tab: `border-bottom-color: var(--app-primary-color); font-weight: 600`.
|
|
54
|
+
- Tab panel: `padding: 16px 0`.
|
|
55
|
+
|
|
56
|
+
## Edge Cases & Special Logic
|
|
57
|
+
|
|
58
|
+
See `DetailsSubTabs.md` for shared edge cases. Additional:
|
|
59
|
+
- `tabUtils` identifier string `'tabsSubs'` must match exactly — it is used internally by `getVisibleTabs` for scoping.
|
|
60
|
+
|
|
61
|
+
## Dependencies
|
|
62
|
+
|
|
63
|
+
- `getTransientTabs`, `getVisibleTabs`, `tabClick` from `./tabUtils`
|
|
64
|
+
- `TabContext`, `TabPanel` from `@mui/lab`
|
|
65
|
+
- `Tab`, `Tabs` from `@mui/material`
|
|
66
|
+
|
|
67
|
+
## Design System Mapping
|
|
68
|
+
|
|
69
|
+
**UI control type:** Tab navigation container — no heading, deferred content loading.
|
|
70
|
+
|
|
71
|
+
Listed design systems are examples only.
|
|
72
|
+
|
|
73
|
+
| Design System | Recommended Component |
|
|
74
|
+
|---|---|
|
|
75
|
+
| Default (CSS only) | Custom tab bar with CSS underline indicator |
|
|
76
|
+
| MUI | `<TabContext>` + `<Tabs>` + `<TabPanel>` from `@mui/lab` |
|
|
77
|
+
| Ant Design | `<Tabs>` with `items` array |
|
|
78
|
+
| Chakra UI | `<Tabs>` + `<TabList>` + `<TabPanels>` |
|
|
79
|
+
| Shadcn/ui | `<Tabs>` + `<TabsList>` + `<TabsContent>` |
|
|
80
|
+
|
|
81
|
+
When implementing in a specific design system:
|
|
82
|
+
- Use `getVisibleTabs(tabs, 'tabsSubs')` — the identifier string must be `'tabsSubs'`
|
|
83
|
+
- No heading above the tab bar (unlike `DetailsSubTabs`)
|
|
84
|
+
- Deferred loading: content populates lazily via `getTransientTabs`
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: TwoColumn
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: TwoColumn
|
|
7
|
+
|
|
8
|
+
Two-column layout template that splits children into two responsive grid columns with configurable width ratios.
|
|
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 two child components side by side in a responsive grid. Column widths are driven by the `templateCol` prop (e.g., `'1fr 1fr'`, `'2fr 1fr'`). On mobile (`xs`), both columns collapse to full width. Three closely related sub-variants share this same layout logic:
|
|
17
|
+
|
|
18
|
+
- **`TwoColumn`** — core layout, used inside forms and views
|
|
19
|
+
- **`TwoColumnPage`** — thin wrapper that delegates to `TwoColumn` via the component registry
|
|
20
|
+
- **`TwoColumnTab`** — identical layout implementation used inside tab contexts
|
|
21
|
+
|
|
22
|
+
## Pega Metadata
|
|
23
|
+
|
|
24
|
+
| Variant | Registration Key |
|
|
25
|
+
|---------|-----------------|
|
|
26
|
+
| TwoColumn | `TwoColumn` |
|
|
27
|
+
| TwoColumnPage | `TwoColumnPage` |
|
|
28
|
+
| TwoColumnTab | `TwoColumnTab` |
|
|
29
|
+
|
|
30
|
+
All three extend `PConnProps`. Children are received as React `children` (not via `getPConnect().getChildren()`).
|
|
31
|
+
|
|
32
|
+
## Props
|
|
33
|
+
|
|
34
|
+
| Prop | Type | Required | Description |
|
|
35
|
+
|------|------|----------|-------------|
|
|
36
|
+
| `children` | `ReactNode[]` | Yes | Exactly 2 children (left column, right column) |
|
|
37
|
+
| `templateCol` | `string` | No | Column width ratio string, e.g., `'1fr 1fr'`, `'2fr 1fr'`. Default `'1fr 1fr'` |
|
|
38
|
+
|
|
39
|
+
## Sub-Variants
|
|
40
|
+
|
|
41
|
+
### TwoColumnPage
|
|
42
|
+
|
|
43
|
+
Thin pass-through wrapper. Retrieves `TwoColumn` from the component registry and renders it with all props forwarded:
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
const TwoColumn = getComponentFromRegistry('TwoColumn');
|
|
47
|
+
return <TwoColumn {...props} />;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### TwoColumnTab
|
|
51
|
+
|
|
52
|
+
Identical implementation to `TwoColumn` — same grid layout, same `templateCol` parsing, same column styles. Registered separately under `TwoColumnTab` key to support tab context rendering.
|
|
53
|
+
|
|
54
|
+
## Behavioral Contract
|
|
55
|
+
|
|
56
|
+
1. Accept exactly 2 children. If a different count is received, log an error (console only — still render).
|
|
57
|
+
2. Parse `templateCol` to compute MUI Grid column sizes:
|
|
58
|
+
- Strip unit suffixes (e.g., `'fr'`) from each token using regex: `.replaceAll(/[a-z]+/g, '')`.
|
|
59
|
+
- Split on whitespace and convert to numbers.
|
|
60
|
+
- Compute `totalCols = sum(colArray)`.
|
|
61
|
+
- Compute `ratio = 12 / totalCols`.
|
|
62
|
+
- `aSize = ratio * colArray[0]`, `bSize = ratio * colArray[1]` (both clamped to MUI's 1–12 GridSize range).
|
|
63
|
+
3. Render a Grid container with `spacing={1}`.
|
|
64
|
+
4. Render `children[0]` in the left column at `size={{ xs: 12, md: aSize }}`.
|
|
65
|
+
5. Render `children[1]` in the right column at `size={{ xs: 12, md: bSize }}`.
|
|
66
|
+
6. Apply `colStyles` class to each column: `display: grid; gap: 1rem; alignContent: baseline`.
|
|
67
|
+
|
|
68
|
+
## Visual Specifications
|
|
69
|
+
|
|
70
|
+
Derived from `TwoColumn.tsx` and `TwoColumnTab.tsx` makeStyles:
|
|
71
|
+
|
|
72
|
+
### Column Style
|
|
73
|
+
|
|
74
|
+
| Property | Value |
|
|
75
|
+
|----------|-------|
|
|
76
|
+
| Display | grid |
|
|
77
|
+
| Gap | 1rem |
|
|
78
|
+
| Align content | baseline (children stack top-aligned) |
|
|
79
|
+
|
|
80
|
+
### Grid Spacing
|
|
81
|
+
|
|
82
|
+
| Property | Value |
|
|
83
|
+
|----------|-------|
|
|
84
|
+
| Container spacing | 1 (≈ 8px between columns) |
|
|
85
|
+
|
|
86
|
+
### Responsive Behavior
|
|
87
|
+
|
|
88
|
+
| Breakpoint | Column A | Column B |
|
|
89
|
+
|-----------|----------|----------|
|
|
90
|
+
| xs (mobile) | 12/12 (full width) | 12/12 (full width, stacks below) |
|
|
91
|
+
| md+ (desktop) | `aSize`/12 | `bSize`/12 |
|
|
92
|
+
|
|
93
|
+
**Column ratio examples:**
|
|
94
|
+
|
|
95
|
+
| `templateCol` | Column A | Column B |
|
|
96
|
+
|--------------|----------|----------|
|
|
97
|
+
| `'1fr 1fr'` | 6/12 (50%) | 6/12 (50%) |
|
|
98
|
+
| `'2fr 1fr'` | 8/12 (67%) | 4/12 (33%) |
|
|
99
|
+
| `'1fr 2fr'` | 4/12 (33%) | 8/12 (67%) |
|
|
100
|
+
| `'3fr 1fr'` | 9/12 (75%) | 3/12 (25%) |
|
|
101
|
+
|
|
102
|
+
**CSS-only implementation notes:**
|
|
103
|
+
- Column container: `display: grid; gap: 1rem; align-content: start`.
|
|
104
|
+
- Outer grid: `display: grid; grid-template-columns: <aFraction>fr <bFraction>fr; gap: 8px`.
|
|
105
|
+
- Mobile: `grid-template-columns: 1fr` (single column stack).
|
|
106
|
+
- Each column has `display: grid; gap: 1rem; align-content: baseline` for internal stacking.
|
|
107
|
+
|
|
108
|
+
## Edge Cases & Special Logic
|
|
109
|
+
|
|
110
|
+
- Default `templateCol` is `'1fr 1fr'` (equal split) when not provided.
|
|
111
|
+
- The `templateCol` parsing is regex-based — any non-numeric suffix is stripped. If only numbers are provided (e.g., `'6 6'`), it still works.
|
|
112
|
+
- `TwoColumnPage` uses `getComponentFromRegistry('TwoColumn')` — if the registry returns an override, that override is used instead of the default `TwoColumn` implementation.
|
|
113
|
+
|
|
114
|
+
## Dependencies
|
|
115
|
+
|
|
116
|
+
- `TwoColumnPage`: `getComponentFromRegistry` from `@pega/sdk-react` — to resolve the `TwoColumn` component at runtime
|
|
117
|
+
- `TwoColumn` / `TwoColumnTab`: no special dependencies beyond layout
|
|
118
|
+
|
|
119
|
+
## Design System Mapping
|
|
120
|
+
|
|
121
|
+
**UI control type:** Responsive two-column grid layout.
|
|
122
|
+
|
|
123
|
+
Listed design systems are examples only.
|
|
124
|
+
|
|
125
|
+
| Design System | Recommended Component |
|
|
126
|
+
|---|---|
|
|
127
|
+
| Default (CSS only) | CSS Grid with `grid-template-columns: <a>fr <b>fr; gap: 8px` |
|
|
128
|
+
| MUI | `<Grid container spacing={1}><Grid size={{ xs: 12, md: N }}>` |
|
|
129
|
+
| Ant Design | `<Row gutter={8}><Col xs={24} md={N * 2}>` (Ant uses 24-column grid) |
|
|
130
|
+
| Chakra UI | `<SimpleGrid columns={{ base: 1, md: 2 }} spacing={2}>` |
|
|
131
|
+
| Shadcn/ui | Tailwind `grid grid-cols-1 md:grid-cols-[<a>fr_<b>fr] gap-2` |
|
|
132
|
+
|
|
133
|
+
When implementing in a specific design system:
|
|
134
|
+
- Parse `templateCol` using the same ratio algorithm (strip units, divide 12 by total)
|
|
135
|
+
- Apply `align-content: baseline` so children within each column stack top-aligned
|
|
136
|
+
- Collapse to single column on mobile breakpoint
|