@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/.cursor/rules/skills/template-skills/DefaultForm.mdrules
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: DefaultForm
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: DefaultForm
|
|
7
|
+
|
|
8
|
+
Standard form layout template supporting 1, 2, or 3 column arrangements. Renders form fields from the first PConnect region child and optionally displays instruction text above.
|
|
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 form's fields in a 1, 2, or 3-column grid layout. Children come from a PConnect region (unwrapped one level). Each child field is connected to the Redux store via a `connectToState` HOC so visibility and prop updates flow reactively. Instruction HTML is displayed above the form when present.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `DefaultForm` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Form template
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `NumCols` | `string` | No | Number of columns: `'1'`, `'2'`, or `'3'`. Default `'1'` |
|
|
29
|
+
| `instructions` | `string` | No | HTML instruction text shown above the form |
|
|
30
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
31
|
+
|
|
32
|
+
## Behavioral Contract
|
|
33
|
+
|
|
34
|
+
1. **Resolve column count:** Use `NumCols || '1'`. Switch to CSS class:
|
|
35
|
+
- `'1'` → `psdk-default-form-one-column`
|
|
36
|
+
- `'2'` → `psdk-default-form-two-column`
|
|
37
|
+
- `'3'` → `psdk-default-form-three-column`
|
|
38
|
+
- Default → `psdk-default-form-one-column`
|
|
39
|
+
2. **Get instructions:** Call `getInstructions(getPConnect(), props.instructions)` — returns sanitized HTML string or empty.
|
|
40
|
+
3. **Unwrap region children:** `arChildren = getPConnect().getChildren()[0].getPConnect().getChildren()` — the first child is a region; its children are the actual form fields.
|
|
41
|
+
4. **Wrap each child:** Create a `Child` component using `connectToState(mapStateToProps)` HOC wrapping `PConnectComponent`. Map each field:
|
|
42
|
+
```
|
|
43
|
+
arChildren.map((kid) => <Child key={getKeyForMappedField(kid)} {...kid} />)
|
|
44
|
+
```
|
|
45
|
+
5. **Render:**
|
|
46
|
+
- If instructions, render `<div className='psdk-default-form-instruction-text'>` with `dangerouslySetInnerHTML={{ __html: instructions }}`.
|
|
47
|
+
- Render `<div className={divClass}>{dfChildren}</div>`.
|
|
48
|
+
|
|
49
|
+
## Visual Specifications
|
|
50
|
+
|
|
51
|
+
Derived from `DefaultForm.css`:
|
|
52
|
+
|
|
53
|
+
### Column Layouts
|
|
54
|
+
|
|
55
|
+
| Class | Layout |
|
|
56
|
+
|-------|--------|
|
|
57
|
+
| `psdk-default-form-one-column` | Single column, full width |
|
|
58
|
+
| `psdk-default-form-two-column` | Two equal columns |
|
|
59
|
+
| `psdk-default-form-three-column` | Three equal columns |
|
|
60
|
+
|
|
61
|
+
**CSS-only implementation notes:**
|
|
62
|
+
- One column: `display: grid; grid-template-columns: 1fr; gap: 1rem`.
|
|
63
|
+
- Two column: `display: grid; grid-template-columns: 1fr 1fr; gap: 1rem`.
|
|
64
|
+
- Three column: `display: grid; grid-template-columns: 1fr 1fr 1fr; gap: 1rem`.
|
|
65
|
+
- Instructions container: `padding: 0.5rem 0; margin-bottom: 0.5rem; font-size: 0.875rem`.
|
|
66
|
+
- Responsive: collapse multi-column to single column on mobile.
|
|
67
|
+
|
|
68
|
+
### Instruction Text
|
|
69
|
+
|
|
70
|
+
| Property | Value |
|
|
71
|
+
|----------|-------|
|
|
72
|
+
| CSS class | `psdk-default-form-instruction-text` |
|
|
73
|
+
| Content | Raw HTML rendered with `dangerouslySetInnerHTML` |
|
|
74
|
+
|
|
75
|
+
## Edge Cases & Special Logic
|
|
76
|
+
|
|
77
|
+
- `NumCols` is a string (not number) — always compare with string literals `'1'`, `'2'`, `'3'`.
|
|
78
|
+
- The region unwrap (`getChildren()[0].getPConnect().getChildren()`) assumes the form metadata has exactly one region child. Guard against `undefined` if the region child is missing.
|
|
79
|
+
- `connectToState(mapStateToProps)` HOC subscribes each field to the Redux store — if Redux is not available, fall back to rendering `PConnectComponent` directly without the HOC.
|
|
80
|
+
- `getKeyForMappedField(kid)` generates a stable key for each field from the field's metadata path — import from `./utils`.
|
|
81
|
+
- Instructions HTML is server-sanitized (comment in source code) — do not sanitize again on the client.
|
|
82
|
+
|
|
83
|
+
## Dependencies
|
|
84
|
+
|
|
85
|
+
- `getInstructions` from `../../helpers/template-utils` — extracts instruction text from PConnect metadata
|
|
86
|
+
- `connectToState` from `../../helpers/state-utils` — HOC for Redux store subscription
|
|
87
|
+
- `PConnectComponent` from `@pega/sdk-react` — renders each child field
|
|
88
|
+
- `getKeyForMappedField`, `mapStateToProps` from `./utils` — key generation and state mapping
|
|
89
|
+
|
|
90
|
+
## Design System Mapping
|
|
91
|
+
|
|
92
|
+
**UI control type:** Multi-column form field grid with optional instruction text header.
|
|
93
|
+
|
|
94
|
+
Listed design systems are examples only.
|
|
95
|
+
|
|
96
|
+
| Design System | Recommended Component |
|
|
97
|
+
|---|---|
|
|
98
|
+
| Default (CSS only) | CSS Grid with column count driven by `NumCols` |
|
|
99
|
+
| MUI | CSS Grid via `sx` prop or makeStyles |
|
|
100
|
+
| Ant Design | `<Form layout='vertical'>` with `<Row>/<Col>` for multi-column |
|
|
101
|
+
| Chakra UI | `<SimpleGrid columns={N} spacing={4}>` |
|
|
102
|
+
| Shadcn/ui | Tailwind `grid grid-cols-1/2/3 gap-4` |
|
|
103
|
+
|
|
104
|
+
When implementing in a specific design system:
|
|
105
|
+
- `NumCols` is always a string (`'1'`/`'2'`/`'3'`) — parse before use
|
|
106
|
+
- Instructions HTML is rendered above the form, before any fields
|
|
107
|
+
- Each child field must be subscribed to the store for reactive visibility/prop updates
|
package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultPage.mdrules
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: DefaultPage
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: DefaultPage
|
|
7
|
+
|
|
8
|
+
Flexible page layout template that renders children in a configurable column layout, with optional banner hero section.
|
|
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 page's child regions in a responsive grid layout. The number and proportions of columns are driven by the `layout` prop. When `enableBanner` is true, delegates to the `Banner` DSE component for a full-width hero section with the child columns below it.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `DefaultPage` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Page template
|
|
22
|
+
- **Extends:** `CommonPageProps` (does NOT directly extend `PConnProps` — no `getPConnect` in props)
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `layout` | `'one-column' \| 'two-column' \| 'narrow-wide' \| 'wide-narrow' \| 'dynamic'` | No | Column layout. Default `'one-column'` |
|
|
29
|
+
| `children` | `ReactNode \| ReactNode[]` | Yes | Child region components to render in columns |
|
|
30
|
+
| `title` | `string` | Yes | Page title (part of `CommonPageProps`, not directly rendered) |
|
|
31
|
+
| `icon` | `string` | Yes | Page icon (part of `CommonPageProps`, not directly rendered) |
|
|
32
|
+
| `localeReference` | `string` | Yes | Locale reference key |
|
|
33
|
+
| `enableBanner` | `boolean` | No | If `true`, render `Banner` hero with children as `a`/`b` columns |
|
|
34
|
+
| `heading` | `string` | No | Banner heading. Default `''` |
|
|
35
|
+
| `message` | `string` | No | Banner message. Default `''` |
|
|
36
|
+
| `imageTheme` | `'light' \| 'dark' \| undefined` | No | Banner image theme |
|
|
37
|
+
| `backgroundImage` | `string` | No | Banner background image URL. Default `''` |
|
|
38
|
+
| `backgroundColor` | `string` | No | Banner background color. Default `''` |
|
|
39
|
+
| `tintImage` | `boolean` | No | Banner image tint flag |
|
|
40
|
+
|
|
41
|
+
## Behavioral Contract
|
|
42
|
+
|
|
43
|
+
### Without Banner (`enableBanner` is falsy)
|
|
44
|
+
|
|
45
|
+
1. Convert children to an array using `Children.toArray(children)` (memoized).
|
|
46
|
+
2. Look up column widths from `COLUMNS_WIDTHS` map using `layout`:
|
|
47
|
+
- `'one-column'`: `[12]` (single column, full width)
|
|
48
|
+
- `'two-column'`: `[6, 6]` (equal split)
|
|
49
|
+
- `'narrow-wide'`: `[4, 8]`
|
|
50
|
+
- `'wide-narrow'`: `[8, 4]`
|
|
51
|
+
3. Render a `<Grid container spacing={1}>`.
|
|
52
|
+
4. Map over children array: for each child at index `i`, render `<Grid key={i} size={COLUMNS_WIDTHS[layout][i]}>{child}</Grid>`.
|
|
53
|
+
|
|
54
|
+
### With Banner (`enableBanner` is true)
|
|
55
|
+
|
|
56
|
+
1. Retrieve `Banner` from the component registry.
|
|
57
|
+
2. Determine banner variant:
|
|
58
|
+
- If `layout === 'one-column'`, use `'two-column'` for the banner layout (equal split for `a`/`b`).
|
|
59
|
+
- Otherwise use the `layout` value directly.
|
|
60
|
+
3. Render `<Banner variant={...} a={[childArray[0]]} b={[childArray[1]]} banner={{ variant: imageTheme, backgroundColor, title: heading, message, backgroundImage, tintImage }} />`.
|
|
61
|
+
|
|
62
|
+
## Visual Specifications
|
|
63
|
+
|
|
64
|
+
### Column Widths
|
|
65
|
+
|
|
66
|
+
| `layout` | Column sizes (MUI 12-grid) |
|
|
67
|
+
|----------|--------------------------|
|
|
68
|
+
| `'one-column'` | 12 |
|
|
69
|
+
| `'two-column'` | 6, 6 |
|
|
70
|
+
| `'narrow-wide'` | 4, 8 |
|
|
71
|
+
| `'wide-narrow'` | 8, 4 |
|
|
72
|
+
|
|
73
|
+
### Grid Spacing
|
|
74
|
+
|
|
75
|
+
| Property | Value |
|
|
76
|
+
|----------|-------|
|
|
77
|
+
| Container spacing | 1 (≈ 8px between columns) |
|
|
78
|
+
|
|
79
|
+
**CSS-only implementation notes:**
|
|
80
|
+
- One-column: `display: grid; grid-template-columns: 1fr; gap: 8px`.
|
|
81
|
+
- Two-column: `display: grid; grid-template-columns: 1fr 1fr; gap: 8px`.
|
|
82
|
+
- Narrow-wide: `display: grid; grid-template-columns: 1fr 2fr; gap: 8px`.
|
|
83
|
+
- Wide-narrow: `display: grid; grid-template-columns: 2fr 1fr; gap: 8px`.
|
|
84
|
+
- With banner: delegate to Banner component structure (see `Banner.md`).
|
|
85
|
+
- Responsive: collapse all to single column on mobile.
|
|
86
|
+
|
|
87
|
+
## Edge Cases & Special Logic
|
|
88
|
+
|
|
89
|
+
- `layout='dynamic'` is listed in the type union but has no entry in `COLUMNS_WIDTHS` — if accessed, it returns `undefined`, and no columns are rendered. This is a known stub.
|
|
90
|
+
- When `enableBanner` is true and `layout === 'one-column'`, the banner layout is forced to `'two-column'` to provide a meaningful two-slot layout for `a` and `b`.
|
|
91
|
+
- Children are memoized via `useMemo(() => Children.toArray(children), [children])` to avoid unnecessary re-renders.
|
|
92
|
+
|
|
93
|
+
## Dependencies
|
|
94
|
+
|
|
95
|
+
- When `enableBanner` is true: `getComponentFromRegistry('Banner')` from `@pega/sdk-react`
|
|
96
|
+
- `Grid` from `@mui/material` (or equivalent CSS grid in non-MUI implementations)
|
|
97
|
+
|
|
98
|
+
## Design System Mapping
|
|
99
|
+
|
|
100
|
+
**UI control type:** Responsive multi-column page grid layout with optional banner hero.
|
|
101
|
+
|
|
102
|
+
Listed design systems are examples only.
|
|
103
|
+
|
|
104
|
+
| Design System | Recommended Component |
|
|
105
|
+
|---|---|
|
|
106
|
+
| Default (CSS only) | CSS Grid with column template driven by `layout` prop |
|
|
107
|
+
| MUI | `<Grid container spacing={1}>` with `<Grid size={N}>` per child |
|
|
108
|
+
| Ant Design | `<Row gutter={8}>` with `<Col span={N * 2}>` (24-col grid) |
|
|
109
|
+
| Chakra UI | `<SimpleGrid columns={{ base: 1, md: N }}>` |
|
|
110
|
+
| Shadcn/ui | Tailwind grid utilities matching the layout |
|
|
111
|
+
|
|
112
|
+
When implementing in a specific design system:
|
|
113
|
+
- Map `layout` prop to the appropriate column template
|
|
114
|
+
- Banner mode delegates to the `Banner` component — implement Banner first
|
|
115
|
+
- All children are sized uniformly within their column (no per-child overrides)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: Details
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: Details
|
|
7
|
+
|
|
8
|
+
Read-only single-column details template. Renders all child fields in DISPLAY_ONLY mode inside a labeled FieldGroup, with optional highlighted data strip above.
|
|
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 labeled group of read-only fields in a single-column vertical stack. Forces all children into `DISPLAY_ONLY` + `readOnly` mode via inherited props. Optionally renders a "highlighted data" banner row at the top (full-width, stacked-large-val display).
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `Details` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Display template
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `label` | `string` | Yes | Section heading for the FieldGroup wrapper |
|
|
29
|
+
| `showLabel` | `boolean` | Yes | Whether to show the section label |
|
|
30
|
+
| `showHighlightedData` | `boolean` | Yes | Whether to render highlighted fields above children |
|
|
31
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
32
|
+
|
|
33
|
+
## Behavioral Contract
|
|
34
|
+
|
|
35
|
+
1. **Inherited props merge:** `propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() }` — inherited props can override label/showLabel.
|
|
36
|
+
2. **Force display mode:** Call `getPConnect().setInheritedProp('displayMode', 'DISPLAY_ONLY')` and `getPConnect().setInheritedProp('readOnly', true)` — ensures all child fields render in read-only display mode.
|
|
37
|
+
3. **Render children:** Map `getPConnect().getChildren()` → `createElement(PConnectComponent, { ...configObject, key: index.toString() })`.
|
|
38
|
+
4. **Highlighted data (when `showHighlightedData` is true):**
|
|
39
|
+
a. Read `getPConnect().getRawMetadata().config.highlightedData` (defaults to `[]`).
|
|
40
|
+
b. For each highlighted field, set `field.config.displayMode = 'STACKED_LARGE_VAL'`.
|
|
41
|
+
c. For fields with `field.config.value === '@P .pyStatusWork'`: set `field.type = 'TextInput'` and `field.config.displayAsStatus = true`.
|
|
42
|
+
d. Create each field via `getPConnect().createComponent(field, '', 0, {})`.
|
|
43
|
+
5. **Layout:**
|
|
44
|
+
- Wrap all content in `<FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>`.
|
|
45
|
+
- Highlighted data: `<Grid container spacing={1} style={{ padding: '0 0 1em' }}>` with each child at `Grid size={{ xs: 12 }}`.
|
|
46
|
+
- Regular children: `<Grid container spacing={1}>` with each child at `Grid size={{ xs: 12 }}`.
|
|
47
|
+
|
|
48
|
+
## Visual Specifications
|
|
49
|
+
|
|
50
|
+
### Overall Layout
|
|
51
|
+
|
|
52
|
+
| Property | Value |
|
|
53
|
+
|----------|-------|
|
|
54
|
+
| Column structure | Single column (xs: 12 for each child) |
|
|
55
|
+
| Inner spacing | Grid spacing 1 (≈ 8px between fields) |
|
|
56
|
+
| Highlighted data padding | `padding: 0 0 1em` (space below before regular children) |
|
|
57
|
+
|
|
58
|
+
**CSS-only implementation notes:**
|
|
59
|
+
- Outer wrapper: `FieldGroup` component (see `FieldGroupDSE.md` for styles).
|
|
60
|
+
- Children grid: `display: grid; grid-template-columns: 1fr; gap: 8px`.
|
|
61
|
+
- Highlighted data row: `display: grid; grid-template-columns: 1fr; gap: 8px; padding-bottom: 1rem`.
|
|
62
|
+
- Fields inside highlighted data use `STACKED_LARGE_VAL` display (larger value typography).
|
|
63
|
+
|
|
64
|
+
## Edge Cases & Special Logic
|
|
65
|
+
|
|
66
|
+
- `setInheritedProp` is called with side effects before rendering — this modifies the PConnect context and affects all children.
|
|
67
|
+
- The `highlightedData` array defaults to `[]` if not present in metadata.
|
|
68
|
+
- The `pyStatusWork` special case: sets both `type` and `displayAsStatus` to ensure the status field renders as a badge/chip rather than plain text.
|
|
69
|
+
- `showHighlightedData` must be explicitly `true` — even if `highlightedData` has items, they won't render if the flag is false.
|
|
70
|
+
|
|
71
|
+
## Dependencies
|
|
72
|
+
|
|
73
|
+
- `createElement` from React
|
|
74
|
+
- `PConnectComponent`, `getComponentFromRegistry('FieldGroup')` from `@pega/sdk-react`
|
|
75
|
+
|
|
76
|
+
## Design System Mapping
|
|
77
|
+
|
|
78
|
+
**UI control type:** Read-only labeled section with vertically stacked fields.
|
|
79
|
+
|
|
80
|
+
Listed design systems are examples only.
|
|
81
|
+
|
|
82
|
+
| Design System | Recommended Component |
|
|
83
|
+
|---|---|
|
|
84
|
+
| Default (CSS only) | `<fieldset>/<legend>` wrapper with CSS grid single column |
|
|
85
|
+
| MUI | `<Grid container spacing={1}>` with `<Grid size={{ xs: 12 }}>` per field |
|
|
86
|
+
| Ant Design | `<Card title={label}>` with `<Row><Col span={24}>` per field |
|
|
87
|
+
| Chakra UI | `<Box>` with heading + `<Stack spacing={2}>` |
|
|
88
|
+
| Shadcn/ui | `<Card><CardHeader><CardContent>` with stacked field items |
|
|
89
|
+
|
|
90
|
+
When implementing in a specific design system:
|
|
91
|
+
- All children must have `displayMode='DISPLAY_ONLY'` and `readOnly=true` inherited
|
|
92
|
+
- Highlighted data uses `STACKED_LARGE_VAL` — larger/bolder value display
|
|
93
|
+
- `showLabel=false` hides the section heading entirely
|
package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsSubTabs.mdrules
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: DetailsSubTabs
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: DetailsSubTabs
|
|
7
|
+
|
|
8
|
+
Read-only tabbed details template. Renders sub-tabs with deferred-loaded tab content, using shared tab utilities.
|
|
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 tabbed layout for a details region. Each tab contains display-only content loaded on demand. Uses the same `tabUtils` as `SubTabs` but is scoped to a details/display context. Optionally shows a section heading above the tabs.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `DetailsSubTabs` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Navigation / Display template
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `children` | `ReactNode[]` | Yes | Tab content — `children[0]` is the deferred-loaded tabs container |
|
|
29
|
+
| `label` | `string` | Yes | Section heading shown above tabs when `showLabel` is true |
|
|
30
|
+
| `showLabel` | `boolean` | No | Whether to show the section heading. Default `true` |
|
|
31
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
32
|
+
|
|
33
|
+
## Behavioral Contract
|
|
34
|
+
|
|
35
|
+
1. **Inherited props merge:** `propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() }`.
|
|
36
|
+
2. **Extract deferred tabs:** `deferLoadedTabs = Children.toArray(children)[0]`.
|
|
37
|
+
3. **Compute visible tabs:** On mount and when `availableTabs` changes, call `getVisibleTabs(deferLoadedTabs, 'detailsSubTabs')` to get the filtered visible tab list.
|
|
38
|
+
4. **State:** `currentTabId` (string, default `'0'`), `tabItems` (array of `{ id, name, content }` objects).
|
|
39
|
+
5. **Transient tabs:** On `currentTabId` change, call `getTransientTabs(availableTabs, currentTabId, tabItems)` and update `tabItems` state.
|
|
40
|
+
6. **Tab click handler:** `handleTabClick(id, index)` → calls `setCurrentTabId(index)` and `tabClick(index, availableTabs, currentTabId, setCurrentTabId, tabItems)` from `tabUtils`.
|
|
41
|
+
7. **Render:**
|
|
42
|
+
- If `propsToUse.showLabel`, render `<h3>{propsToUse.label}</h3>`.
|
|
43
|
+
- Render `<TabContext value={currentTabId}>`.
|
|
44
|
+
- Render `<Tabs onChange={handleTabClick} value={currentTabId}>` with one `<Tab key={tab.id} label={tab.name} value={tab.id} />` per `tabItems` entry.
|
|
45
|
+
- Render one `<TabPanel key={tab.id} value={tab.id} tabIndex={+tab.id}>` per `tabItems` entry containing `tab.content || 'No content exists'`.
|
|
46
|
+
|
|
47
|
+
## Visual Specifications
|
|
48
|
+
|
|
49
|
+
### Heading
|
|
50
|
+
|
|
51
|
+
| Property | Value |
|
|
52
|
+
|----------|-------|
|
|
53
|
+
| Tag | `<h3>` |
|
|
54
|
+
| Shown only when | `propsToUse.showLabel === true` |
|
|
55
|
+
|
|
56
|
+
### Tab Bar
|
|
57
|
+
|
|
58
|
+
| Property | Value |
|
|
59
|
+
|----------|-------|
|
|
60
|
+
| Scrollable | Not specified (default non-scrollable in reference implementation) |
|
|
61
|
+
| Tab text transform | Inherits design system default |
|
|
62
|
+
|
|
63
|
+
**CSS-only implementation notes:**
|
|
64
|
+
- Heading: `font-size: 1.25rem; font-weight: 600; margin-bottom: 8px`.
|
|
65
|
+
- Tab bar: `display: flex; border-bottom: 2px solid var(--divider); gap: 0`.
|
|
66
|
+
- Each tab: `padding: 8px 16px; cursor: pointer; border-bottom: 2px solid transparent`.
|
|
67
|
+
- Active tab: `border-bottom-color: var(--app-primary-color)`.
|
|
68
|
+
- Tab panel: `padding: 16px 0`.
|
|
69
|
+
|
|
70
|
+
## Edge Cases & Special Logic
|
|
71
|
+
|
|
72
|
+
- `availableTabs` is computed inside `useEffect` (not via useState) — this means the initial render uses an empty array, and tabs populate after mount.
|
|
73
|
+
- The `useEffect` on `[availableTabs]` has a stale closure issue in the reference implementation — use a `useRef` or `useMemo` for production implementations if needed.
|
|
74
|
+
- `tabItems` starts as `[]` — the tab bar renders empty until the first `currentTabId` change triggers `getTransientTabs`.
|
|
75
|
+
- `propsToUse` label/showLabel may be overridden by inherited props — always use `propsToUse` for the label, not raw `label`/`showLabel` props.
|
|
76
|
+
|
|
77
|
+
## Dependencies
|
|
78
|
+
|
|
79
|
+
- `getTransientTabs`, `getVisibleTabs`, `tabClick` from `../../SubTabs/tabUtils`
|
|
80
|
+
- `TabContext`, `TabPanel` from `@mui/lab`
|
|
81
|
+
- `Tab`, `Tabs` from `@mui/material`
|
|
82
|
+
|
|
83
|
+
## Design System Mapping
|
|
84
|
+
|
|
85
|
+
**UI control type:** Tabbed section container for read-only details content.
|
|
86
|
+
|
|
87
|
+
Listed design systems are examples only.
|
|
88
|
+
|
|
89
|
+
| Design System | Recommended Component |
|
|
90
|
+
|---|---|
|
|
91
|
+
| Default (CSS only) | Custom tab bar with CSS underline indicator |
|
|
92
|
+
| MUI | `<TabContext>` + `<Tabs>` + `<TabPanel>` from `@mui/lab` |
|
|
93
|
+
| Ant Design | `<Tabs>` with `items` array |
|
|
94
|
+
| Chakra UI | `<Tabs>` + `<TabList>` + `<TabPanels>` |
|
|
95
|
+
| Shadcn/ui | `<Tabs>` + `<TabsList>` + `<TabsContent>` |
|
|
96
|
+
|
|
97
|
+
When implementing in a specific design system:
|
|
98
|
+
- `getVisibleTabs` and `getTransientTabs` are tabUtils helpers — use them regardless of UI library
|
|
99
|
+
- Tab content is lazily loaded via the transient tab pattern
|
|
100
|
+
- Optional `<h3>` heading above the tab bar (controlled by `showLabel`)
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: DetailsThreeColumn
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: DetailsThreeColumn
|
|
7
|
+
|
|
8
|
+
Read-only three-column details template. Renders child fields in DISPLAY_ONLY mode in a 3-column grid inside a FieldGroup, with optional highlighted data.
|
|
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
|
+
Identical to `Details` and `DetailsTwoColumn` in all behavior except children are distributed into a **three-column grid** (`xs: 4` per child). Used in wide details regions where the design calls for three equal columns of fields.
|
|
17
|
+
|
|
18
|
+
> The implementation is nearly identical to `Details`. See `Details.md` for full pattern descriptions. Only the column width differs.
|
|
19
|
+
|
|
20
|
+
## Pega Metadata
|
|
21
|
+
|
|
22
|
+
- **Registration key:** `DetailsThreeColumn` (in `component-map.ts`)
|
|
23
|
+
- **Category:** Display template
|
|
24
|
+
- **Extends:** `PConnProps`
|
|
25
|
+
|
|
26
|
+
## Props
|
|
27
|
+
|
|
28
|
+
| Prop | Type | Required | Description |
|
|
29
|
+
|------|------|----------|-------------|
|
|
30
|
+
| `label` | `string` | Yes | Section heading for the FieldGroup wrapper |
|
|
31
|
+
| `showLabel` | `boolean` | No | Whether to show the section label. Default `true` |
|
|
32
|
+
| `showHighlightedData` | `boolean` | No | Whether to render highlighted fields above children. Default `false` |
|
|
33
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
34
|
+
|
|
35
|
+
## Behavioral Contract
|
|
36
|
+
|
|
37
|
+
All steps identical to `Details`, except:
|
|
38
|
+
|
|
39
|
+
- **Regular children grid:** Each child renders at `Grid size={{ xs: 4 }}` (three per row).
|
|
40
|
+
- **Highlighted data grid:** Each highlighted field also renders at `Grid size={{ xs: 4 }}`.
|
|
41
|
+
- All other behaviors (inherited props merge, `setInheritedProp('displayMode', 'DISPLAY_ONLY')`, `setInheritedProp('readOnly', true)`, FieldGroup wrapper, pyStatusWork handling) are identical to `Details`.
|
|
42
|
+
|
|
43
|
+
## Visual Specifications
|
|
44
|
+
|
|
45
|
+
### Column Structure
|
|
46
|
+
|
|
47
|
+
| | Details | DetailsTwoColumn | DetailsThreeColumn |
|
|
48
|
+
|-|---------|-----------------|-------------------|
|
|
49
|
+
| Column width per child | xs: 12 | xs: 6 | **xs: 4** |
|
|
50
|
+
| Columns per row | 1 | 2 | **3** |
|
|
51
|
+
| Highlighted data column | xs: 12 | xs: 6 | **xs: 4** |
|
|
52
|
+
|
|
53
|
+
**CSS-only implementation notes:**
|
|
54
|
+
- Children grid: `display: grid; grid-template-columns: 1fr 1fr 1fr; gap: 8px`.
|
|
55
|
+
- Highlighted data row: `display: grid; grid-template-columns: 1fr 1fr 1fr; gap: 8px; padding-bottom: 1rem`.
|
|
56
|
+
- Wrap in FieldGroup (see `FieldGroup.md` DSE skill).
|
|
57
|
+
|
|
58
|
+
## Edge Cases & Special Logic
|
|
59
|
+
|
|
60
|
+
All edge cases identical to `Details`. See `Details.md`.
|
|
61
|
+
|
|
62
|
+
## Dependencies
|
|
63
|
+
|
|
64
|
+
- `createElement` from React
|
|
65
|
+
- `PConnectComponent`, `getComponentFromRegistry('FieldGroup')` from `@pega/sdk-react`
|
|
66
|
+
|
|
67
|
+
## Design System Mapping
|
|
68
|
+
|
|
69
|
+
**UI control type:** Read-only labeled section with fields in a three-column grid.
|
|
70
|
+
|
|
71
|
+
Listed design systems are examples only.
|
|
72
|
+
|
|
73
|
+
| Design System | Recommended Component |
|
|
74
|
+
|---|---|
|
|
75
|
+
| Default (CSS only) | `<fieldset>/<legend>` with CSS `grid-template-columns: 1fr 1fr 1fr; gap: 8px` |
|
|
76
|
+
| MUI | `<Grid container spacing={1}>` with `<Grid size={{ xs: 4 }}>` per field |
|
|
77
|
+
| Ant Design | `<Descriptions column={3}>` or `<Row><Col span={8}>` per field |
|
|
78
|
+
| Chakra UI | `<SimpleGrid columns={3} spacing={2}>` |
|
|
79
|
+
| Shadcn/ui | Tailwind `grid grid-cols-3 gap-2` |
|
|
80
|
+
|
|
81
|
+
When implementing in a specific design system:
|
|
82
|
+
- 3-column layout — each field takes one-third of the available width
|
|
83
|
+
- All other behaviors inherited from `Details` (DISPLAY_ONLY, readOnly, FieldGroup, highlighted data)
|
package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsTwoColumn.mdrules
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: DetailsTwoColumn
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: DetailsTwoColumn
|
|
7
|
+
|
|
8
|
+
Read-only two-column details template. Renders child fields in DISPLAY_ONLY mode in a 2-column grid inside a FieldGroup, with optional highlighted data.
|
|
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
|
+
Identical to `Details` in all behavior except children are distributed into a **two-column grid** (`xs: 6` per child) instead of single-column. Used in details regions where the design calls for side-by-side field pairs.
|
|
17
|
+
|
|
18
|
+
> The implementation is nearly identical to `Details`. See `Details.md` for full pattern descriptions. Only the column width differs.
|
|
19
|
+
|
|
20
|
+
## Pega Metadata
|
|
21
|
+
|
|
22
|
+
- **Registration key:** `DetailsTwoColumn` (in `component-map.ts`)
|
|
23
|
+
- **Category:** Display template
|
|
24
|
+
- **Extends:** `PConnProps`
|
|
25
|
+
|
|
26
|
+
## Props
|
|
27
|
+
|
|
28
|
+
| Prop | Type | Required | Description |
|
|
29
|
+
|------|------|----------|-------------|
|
|
30
|
+
| `label` | `string` | Yes | Section heading for the FieldGroup wrapper |
|
|
31
|
+
| `showLabel` | `boolean` | No | Whether to show the section label. Default `true` |
|
|
32
|
+
| `showHighlightedData` | `boolean` | No | Whether to render highlighted fields above children. Default `false` |
|
|
33
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
34
|
+
|
|
35
|
+
## Behavioral Contract
|
|
36
|
+
|
|
37
|
+
All steps identical to `Details`, except:
|
|
38
|
+
|
|
39
|
+
- **Regular children grid:** Each child renders at `Grid size={{ xs: 6 }}` (two per row, side by side).
|
|
40
|
+
- **Highlighted data grid:** Each highlighted field also renders at `Grid size={{ xs: 6 }}`.
|
|
41
|
+
- All other behaviors (inherited props merge, `setInheritedProp('displayMode', 'DISPLAY_ONLY')`, `setInheritedProp('readOnly', true)`, FieldGroup wrapper, pyStatusWork handling) are identical to `Details`.
|
|
42
|
+
|
|
43
|
+
## Visual Specifications
|
|
44
|
+
|
|
45
|
+
### Column Structure
|
|
46
|
+
|
|
47
|
+
| | Details | DetailsTwoColumn |
|
|
48
|
+
|-|---------|-----------------|
|
|
49
|
+
| Column width per child | xs: 12 (full width) | **xs: 6 (half width)** |
|
|
50
|
+
| Columns per row | 1 | **2** |
|
|
51
|
+
| Highlighted data column | xs: 12 | **xs: 6** |
|
|
52
|
+
|
|
53
|
+
**CSS-only implementation notes:**
|
|
54
|
+
- Children grid: `display: grid; grid-template-columns: 1fr 1fr; gap: 8px`.
|
|
55
|
+
- Highlighted data row: `display: grid; grid-template-columns: 1fr 1fr; gap: 8px; padding-bottom: 1rem`.
|
|
56
|
+
- Wrap in FieldGroup (see `FieldGroup.md` DSE skill).
|
|
57
|
+
|
|
58
|
+
## Edge Cases & Special Logic
|
|
59
|
+
|
|
60
|
+
All edge cases identical to `Details`. See `Details.md`.
|
|
61
|
+
|
|
62
|
+
## Dependencies
|
|
63
|
+
|
|
64
|
+
- `createElement` from React
|
|
65
|
+
- `PConnectComponent`, `getComponentFromRegistry('FieldGroup')` from `@pega/sdk-react`
|
|
66
|
+
|
|
67
|
+
## Design System Mapping
|
|
68
|
+
|
|
69
|
+
**UI control type:** Read-only labeled section with fields in a two-column grid.
|
|
70
|
+
|
|
71
|
+
Listed design systems are examples only.
|
|
72
|
+
|
|
73
|
+
| Design System | Recommended Component |
|
|
74
|
+
|---|---|
|
|
75
|
+
| Default (CSS only) | `<fieldset>/<legend>` with CSS `grid-template-columns: 1fr 1fr; gap: 8px` |
|
|
76
|
+
| MUI | `<Grid container spacing={1}>` with `<Grid size={{ xs: 6 }}>` per field |
|
|
77
|
+
| Ant Design | `<Descriptions column={2}>` or `<Row><Col span={12}>` per field |
|
|
78
|
+
| Chakra UI | `<SimpleGrid columns={2} spacing={2}>` |
|
|
79
|
+
| Shadcn/ui | Tailwind `grid grid-cols-2 gap-2` |
|
|
80
|
+
|
|
81
|
+
When implementing in a specific design system:
|
|
82
|
+
- 2-column layout — each field takes half the available width
|
|
83
|
+
- All other behaviors inherited from `Details` (DISPLAY_ONLY, readOnly, FieldGroup, highlighted data)
|