@pega/sdk 0.0.2 → 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 -2
- package/package.json +1 -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 +1 -1
- 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/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/pega-constellationjs-0.26.2.tgz +0 -0
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: component-contracts
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: Component Contracts Reference
|
|
7
|
+
|
|
8
|
+
Quick-reference lookup of all registered component names and their prop contracts. Use this when you need to know what props a specific component receives from the Pega platform.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Field Components
|
|
13
|
+
|
|
14
|
+
All extend `PConnFieldProps` from `@pega/sdk-react`.
|
|
15
|
+
|
|
16
|
+
| Registry Name | File | Additional Props |
|
|
17
|
+
|---------------|------|-----------------|
|
|
18
|
+
| `TextInput` | `field/TextInput/TextInput.tsx` | `fieldMetadata?: any` |
|
|
19
|
+
| `TextArea` | `field/TextArea/` | `fieldMetadata?: any` |
|
|
20
|
+
| `Dropdown` | `field/Dropdown/` | `datasource?, listType?` |
|
|
21
|
+
| `Checkbox` | `field/Checkbox/` | `value: boolean` (not string) |
|
|
22
|
+
| `RadioButtons` | `field/RadioButtons/` | `datasource?, listType?` |
|
|
23
|
+
| `Date` | `field/Date/` | — |
|
|
24
|
+
| `DateTime` | `field/DateTime/` | — |
|
|
25
|
+
| `Time` | `field/Time/` | — |
|
|
26
|
+
| `Currency` | `field/Currency/` | `currencyISOCode?, formatterType?` |
|
|
27
|
+
| `Decimal` | `field/Decimal/` | `decimalPrecision?` |
|
|
28
|
+
| `Integer` | `field/Integer/` | — |
|
|
29
|
+
| `Percentage` | `field/Percentage/` | — |
|
|
30
|
+
| `Email` | `field/Email/Email.tsx` | — |
|
|
31
|
+
| `Phone` | `field/Phone/Phone.tsx` | `datasource?` (country codes) |
|
|
32
|
+
| `URL` | `field/URL/` | — |
|
|
33
|
+
| `AutoComplete` | `field/AutoComplete/` | `datasource?, listType?, columns?` |
|
|
34
|
+
| `Multiselect` | `field/Multiselect/Multiselect.tsx` | `datasource?, listType?` |
|
|
35
|
+
| `RichText` | `field/RichText/` | — |
|
|
36
|
+
| `ScalarList` | `field/ScalarList/` | `datasource?` |
|
|
37
|
+
| `SelectableCard` | `field/SelectableCard/` | `datasource?` |
|
|
38
|
+
| `Group` | `field/Group/` | — |
|
|
39
|
+
| `Location` | `field/Location/` | — |
|
|
40
|
+
| `ObjectReference` | `field/ObjectReference/` | `value: object` |
|
|
41
|
+
| `SemanticLink` | `field/SemanticLink/` | `text?, displayAs?` |
|
|
42
|
+
| `UserReference` | `field/UserReference/` | `showAsFormattedText?` |
|
|
43
|
+
| `CancelAlert` | `field/CancelAlert/` | — |
|
|
44
|
+
| `TextContent` | `field/TextContent/` | `content?` |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Template Components
|
|
49
|
+
|
|
50
|
+
All extend `PConnProps`. Most receive React `children` or use `getPConnect().getChildren()`.
|
|
51
|
+
|
|
52
|
+
| Registry Name | File | Key Props |
|
|
53
|
+
|---------------|------|-----------|
|
|
54
|
+
| `OneColumn` | `template/OneColumn/OneColumn.tsx` | `children` |
|
|
55
|
+
| `OneColumnPage` | `template/OneColumn/OneColumnPage.tsx` | `children` |
|
|
56
|
+
| `OneColumnTab` | `template/OneColumn/OneColumnTab.tsx` | `children` |
|
|
57
|
+
| `TwoColumn` | `template/TwoColumn/TwoColumn.tsx` | `children, templateCol?` |
|
|
58
|
+
| `TwoColumnPage` | `template/TwoColumn/TwoColumnPage.tsx` | `children` |
|
|
59
|
+
| `TwoColumnTab` | `template/TwoColumn/TwoColumnTab.tsx` | `children` |
|
|
60
|
+
| `NarrowWide` | `template/NarrowWide/NarrowWide.tsx` | `children, templateCol?` |
|
|
61
|
+
| `WideNarrow` | `template/WideNarrow/WideNarrow.tsx` | `children, templateCol?` |
|
|
62
|
+
| `Details` | `template/Details/Details.tsx` | `children` |
|
|
63
|
+
| `DefaultForm` | `template/DefaultForm/` | PConnect children |
|
|
64
|
+
| `DefaultPage` | `template/DefaultPage/` | PConnect children |
|
|
65
|
+
| `CaseView` | `template/CaseView/` | PConnect children, `header?, subheader?` |
|
|
66
|
+
| `CaseSummary` | `template/CaseSummary/` | PConnect children |
|
|
67
|
+
| `Confirmation` | `template/Confirmation/` | `label?` |
|
|
68
|
+
| `SimpleTable` | `template/SimpleTable/SimpleTable.tsx` | `datasource?, fields?, label?` |
|
|
69
|
+
| `ListView` | `template/ListView/` | `datasource?, fields?` |
|
|
70
|
+
| `SubTabs` | `template/SubTabs/` | PConnect children |
|
|
71
|
+
| `AppShell` | `template/AppShell/AppShell.tsx` | PConnect children |
|
|
72
|
+
| `DataReference` | `template/DataReference/` | PConnect children |
|
|
73
|
+
| `ListPage` | `template/ListPage/ListPage.tsx` | PConnect children |
|
|
74
|
+
| `InlineDashboard` | `template/InlineDashboard/` | PConnect children |
|
|
75
|
+
| `FieldGroupTemplate` | `template/FieldGroupTemplate/` | PConnect children |
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Widget Components
|
|
80
|
+
|
|
81
|
+
All extend `PConnProps`. Fetch their own data.
|
|
82
|
+
|
|
83
|
+
| Registry Name | File | Key Props |
|
|
84
|
+
|---------------|------|-----------|
|
|
85
|
+
| `Todo` | `widget/ToDo/` | `datasource?, headerText?, context?` |
|
|
86
|
+
| `Attachment` | `widget/Attachment/` | `value, allowMultiple?, extensions?` |
|
|
87
|
+
| `CaseHistory` | `widget/CaseHistory/` | `datasource?` |
|
|
88
|
+
| `FileUtility` | `widget/FileUtility/FileUtility.tsx` | `datasource?` |
|
|
89
|
+
| `Followers` | `widget/Followers/` | — |
|
|
90
|
+
| `AppAnnouncement` | `widget/AppAnnouncement/` | `datasource?, headerText?` |
|
|
91
|
+
| `QuickCreate` | `widget/QuickCreate/` | — |
|
|
92
|
+
| `SummaryItem` | `widget/SummaryItem/` | `label?, value?, actions?` |
|
|
93
|
+
| `SummaryList` | `widget/SummaryList/` | `datasource?` |
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## Design System Extension Components
|
|
98
|
+
|
|
99
|
+
| Registry Name | File | Key Props |
|
|
100
|
+
|---------------|------|-----------|
|
|
101
|
+
| `FieldValueList` | `designSystemExtension/FieldValueList/` | `name?, value?, variant?` |
|
|
102
|
+
| `AlertBanner` | `designSystemExtension/AlertBanner/` | `variant, heading?, messages, onClose?` |
|
|
103
|
+
| `Banner` | `designSystemExtension/Banner/` | `variant?, text?` |
|
|
104
|
+
| `CaseSummaryFields` | `designSystemExtension/CaseSummaryFields/` | PConnect-based |
|
|
105
|
+
| `DetailsFields` | `designSystemExtension/DetailsFields/` | PConnect-based |
|
|
106
|
+
| `FieldGroup` | `designSystemExtension/FieldGroup/` | PConnect-based |
|
|
107
|
+
| `FieldGroupList` | `designSystemExtension/FieldGroupList/` | PConnect-based |
|
|
108
|
+
| `Operator` | `designSystemExtension/Operator/` | `label?, name?, id?` |
|
|
109
|
+
| `Pulse` | `designSystemExtension/Pulse/` | PConnect-based |
|
|
110
|
+
| `RichTextEditor` | `designSystemExtension/RichTextEditor/` | extends `PConnFieldProps` |
|
|
111
|
+
| `WssQuickCreate` | `designSystemExtension/WssQuickCreate/` | — |
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Infrastructure (from `sdkComponents` — do NOT replace)
|
|
116
|
+
|
|
117
|
+
| Registry Name | Source |
|
|
118
|
+
|---------------|--------|
|
|
119
|
+
| `RootContainer` | `@pega/sdk-react` |
|
|
120
|
+
| `ViewContainer` | `@pega/sdk-react` |
|
|
121
|
+
| `FlowContainer` | `@pega/sdk-react` |
|
|
122
|
+
| `Reference` | `@pega/sdk-react` |
|
|
123
|
+
| `View` | `@pega/sdk-react` |
|
|
124
|
+
| `Region` | `@pega/sdk-react` |
|
|
125
|
+
| `CaseView` (infra) | `@pega/sdk-react` |
|
|
126
|
+
| `Assignment` | `@pega/sdk-react` |
|
|
127
|
+
| `AssignmentCard` | `@pega/sdk-react` |
|
|
128
|
+
| `ActionButtons` | `@pega/sdk-react` |
|
|
129
|
+
| `CaseSummary` (infra) | `@pega/sdk-react` |
|
|
130
|
+
| `ErrorBoundary` | `@pega/sdk-react` |
|
|
131
|
+
| `MultiStep` | `@pega/sdk-react` |
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## Infra (sample-local, replaceable but exercise caution)
|
|
136
|
+
|
|
137
|
+
| Registry Name | File |
|
|
138
|
+
|---------------|------|
|
|
139
|
+
| `ActionButtons` | `infra/ActionButtons/` |
|
|
140
|
+
| `DeferLoad` | `infra/DeferLoad/` |
|
|
141
|
+
| `NavBar` | `infra/NavBar/` |
|
|
142
|
+
| `Stages` | `infra/Stages/` |
|
|
143
|
+
| `DashboardFilter` | `infra/DashboardFilter/` |
|
|
144
|
+
| `VerticalTabs` | `infra/VerticalTabs/VerticalTabs.tsx` |
|
|
145
|
+
| `LeftAlignVerticalTabs` | `infra/VerticalTabs/LeftAlignVerticalTabs.tsx` |
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: DSE component skill: AlertBanner
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: AlertBanner
|
|
7
|
+
|
|
8
|
+
Alert/notification banner that displays one or more messages with a severity variant and an optional dismiss button.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a visually-styled alert box tied to a Pega `variant` value (urgent, warning, success, info). When multiple messages are present, it shows a count badge in the title and lists items in a `<ul>`. A single message is rendered inline. The component optionally shows a close/dismiss button.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `AlertBanner`
|
|
21
|
+
- **Registration key:** `AlertBanner` (in `component-map.ts`)
|
|
22
|
+
- **Does NOT use `getPConnect`** — receives all data as direct props
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `id` | `string` | Yes | DOM id for the root wrapper element |
|
|
29
|
+
| `variant` | `string` | Yes | Alert variant: `'urgent'`, `'warning'`, `'success'`, `'info'` |
|
|
30
|
+
| `messages` | `Array<string \| { label?: string; description?: string }>` | Yes | One or more messages (string or structured object) |
|
|
31
|
+
| `onDismiss` | `function` (optional) | No | Dismiss/close handler; if provided, show a close button |
|
|
32
|
+
|
|
33
|
+
## Behavioral Contract
|
|
34
|
+
|
|
35
|
+
1. **Variant mapping:** Map the Pega `variant` string to a UI severity level and display label:
|
|
36
|
+
- `'urgent'` → severity `error`, label `'Error'`
|
|
37
|
+
- `'warning'` → severity `warning`, label `'Warning'`
|
|
38
|
+
- `'success'` → severity `success`, label `'Success'`
|
|
39
|
+
- `'info'` → severity `info`, label `'Info'`
|
|
40
|
+
- Unknown/missing variant → fall back to `info`
|
|
41
|
+
2. **Single message:** Render `renderMessage(messages[0])` inline (no title, no list).
|
|
42
|
+
3. **Multiple messages (`messages.length > 1`):**
|
|
43
|
+
- Render a title containing the display label (e.g., "Error") plus a circular count badge showing `messages.length`.
|
|
44
|
+
- Render messages as a `<ul>` with one `<li>` per message.
|
|
45
|
+
4. **`renderMessage(message)` logic:**
|
|
46
|
+
- If `message` is an object with a truthy `label`, render `<strong>{label}</strong> {description}`.
|
|
47
|
+
- If `message` is an object without a label, render `description` only.
|
|
48
|
+
- If `message` is a string with no colon (`:`), render it as plain text.
|
|
49
|
+
- If `message` is a string containing a colon, bold everything up to and including the colon, then render the rest as plain text.
|
|
50
|
+
5. **Dismiss button:** Only render the close button if `onDismiss` is provided.
|
|
51
|
+
6. **Root wrapper:** Wrap the alert in a `<div id={id}>`.
|
|
52
|
+
|
|
53
|
+
## Visual Specifications
|
|
54
|
+
|
|
55
|
+
Derived from `AlertBanner.css` and MUI Alert usage:
|
|
56
|
+
|
|
57
|
+
### Alert Container
|
|
58
|
+
|
|
59
|
+
| Property | Value |
|
|
60
|
+
|----------|-------|
|
|
61
|
+
| Variant | Outlined (border visible) |
|
|
62
|
+
| Border color | Driven by severity (error → red, warning → orange, success → green, info → blue) |
|
|
63
|
+
|
|
64
|
+
### Title Row (multiple messages only)
|
|
65
|
+
|
|
66
|
+
| Property | Value |
|
|
67
|
+
|----------|-------|
|
|
68
|
+
| Font weight | 700 |
|
|
69
|
+
| Font size | 1rem |
|
|
70
|
+
| Layout | `display: flex; align-items: center; gap: 0.25rem` |
|
|
71
|
+
|
|
72
|
+
### Count Badge
|
|
73
|
+
|
|
74
|
+
| Property | Value |
|
|
75
|
+
|----------|-------|
|
|
76
|
+
| Layout | `display: inline-flex; align-items: center; justify-content: center` |
|
|
77
|
+
| Min width | 1rem |
|
|
78
|
+
| Height | 1rem |
|
|
79
|
+
| Padding | `0 0.2rem` |
|
|
80
|
+
| Border radius | 999px (fully rounded / pill) |
|
|
81
|
+
| Font size | 0.6rem |
|
|
82
|
+
| Font weight | 700 |
|
|
83
|
+
| `urgent` background | `var(--app-error-dark-color)` |
|
|
84
|
+
| `warning` background | `var(--app-warning-color-dark)` |
|
|
85
|
+
| `success` background | `var(--stepper-completed-bg-color)` |
|
|
86
|
+
| `info` background | `var(--link-button-color)` |
|
|
87
|
+
| Badge text color | `#fff` (all variants) |
|
|
88
|
+
|
|
89
|
+
### Message List
|
|
90
|
+
|
|
91
|
+
| Property | Value |
|
|
92
|
+
|----------|-------|
|
|
93
|
+
| Margin | 0 |
|
|
94
|
+
| Padding left | 1.25rem |
|
|
95
|
+
|
|
96
|
+
**CSS-only implementation notes:**
|
|
97
|
+
- Wrap the entire component in a container `<div>` with `role="alert"`.
|
|
98
|
+
- Use CSS custom properties (`--app-error-dark-color`, etc.) for badge colors.
|
|
99
|
+
- For the outlined alert box: `border: 1px solid currentColor; border-radius: 4px; padding: 0.75rem 1rem`.
|
|
100
|
+
- Severity colors (for border and icon): error `#d32f2f`, warning `#ed6c02`, success `#2e7d32`, info `#0288d1`.
|
|
101
|
+
- Badge: `display: inline-flex; align-items: center; justify-content: center; min-width: 1rem; height: 1rem; padding: 0 0.2rem; border-radius: 999px; font-size: 0.6rem; font-weight: 700; color: #fff`.
|
|
102
|
+
- Left accent icon: use an SVG or Unicode symbol matching the severity (⚠, ✓, ℹ, ✕).
|
|
103
|
+
- Close button (if `onDismiss`): absolutely positioned top-right, `background: none; border: none; cursor: pointer; font-size: 1.25rem`.
|
|
104
|
+
- Message list: `margin: 0; padding-left: 1.25rem; list-style: disc`.
|
|
105
|
+
|
|
106
|
+
## Edge Cases & Special Logic
|
|
107
|
+
|
|
108
|
+
- If `variant` is not one of the four known values, default to `info` severity.
|
|
109
|
+
- If `messages` is an empty array, render nothing (or render the alert shell with no content).
|
|
110
|
+
- If `message.label` is falsy but `message.description` is set, render description without `<strong>`.
|
|
111
|
+
- If a string message has no colon, render it entirely as plain text (no bold).
|
|
112
|
+
- The colon-split only applies to the **first** colon in the string.
|
|
113
|
+
|
|
114
|
+
## Dependencies
|
|
115
|
+
|
|
116
|
+
- No Pega SDK imports required (no `getPConnect`)
|
|
117
|
+
- No helper utilities required
|
|
118
|
+
|
|
119
|
+
## Design System Mapping
|
|
120
|
+
|
|
121
|
+
**UI control type:** Alert / Notification banner with severity levels.
|
|
122
|
+
|
|
123
|
+
Listed design systems are examples only.
|
|
124
|
+
|
|
125
|
+
| Design System | Recommended Component |
|
|
126
|
+
|---|---|
|
|
127
|
+
| Default (CSS only) | `<div role="alert">` with severity border + inline close button |
|
|
128
|
+
| MUI | `<Alert variant='outlined' severity={severity} onClose={onDismiss}><AlertTitle>` |
|
|
129
|
+
| Ant Design | `<Alert type={type} message={title} description={…} closable banner />` |
|
|
130
|
+
| Chakra UI | `<Alert status={status}><AlertIcon /><AlertTitle /><AlertDescription /><CloseButton />` |
|
|
131
|
+
| Shadcn/ui | Custom `<Alert>` with `variant` prop |
|
|
132
|
+
|
|
133
|
+
When implementing in a specific design system, map the following:
|
|
134
|
+
- `variant='urgent'` → `severity/type/status='error'` or `'danger'`
|
|
135
|
+
- `variant='warning'` → `severity/type/status='warning'`
|
|
136
|
+
- `variant='success'` → `severity/type/status='success'`
|
|
137
|
+
- `variant='info'` → `severity/type/status='info'`
|
|
138
|
+
- `onDismiss` → `onClose` / `closable` / close button prop
|
|
139
|
+
- Multiple messages → render as a list inside the alert description area
|
|
140
|
+
- Badge count → render as a tag/badge chip next to the title
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: DSE component skill: Banner
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: Banner
|
|
7
|
+
|
|
8
|
+
Promotional/informational banner with a full-width background image hero section and a two-column content layout below it.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a visually rich banner composed of two parts:
|
|
17
|
+
1. **Hero section:** Full-width area with a background image, centered title and message text overlaid.
|
|
18
|
+
2. **Content columns:** Two adjustable-width columns below the hero, rendered from the `a` and `b` slot props. Column widths are controlled by the `variant` prop.
|
|
19
|
+
|
|
20
|
+
## Pega Metadata
|
|
21
|
+
|
|
22
|
+
- **Pega Name:** `Banner`
|
|
23
|
+
- **Registration key:** `Banner` (in `component-map.ts`)
|
|
24
|
+
- **Does NOT use `getPConnect`** — receives all data as direct props
|
|
25
|
+
|
|
26
|
+
## Props
|
|
27
|
+
|
|
28
|
+
| Prop | Type | Required | Description |
|
|
29
|
+
|------|------|----------|-------------|
|
|
30
|
+
| `a` | `ReactNode` | Yes | Content for the first (left/narrower) column |
|
|
31
|
+
| `b` | `ReactNode` | Yes | Content for the second (right/wider) column |
|
|
32
|
+
| `banner` | `object` | Yes | Banner metadata (see sub-props below) |
|
|
33
|
+
| `banner.title` | `string` | Yes | Title text displayed in the hero section |
|
|
34
|
+
| `banner.message` | `string` | Yes | Descriptive message text in the hero section |
|
|
35
|
+
| `banner.backgroundImage` | `string` | Yes | URL of the background image for the hero section |
|
|
36
|
+
| `banner.variant` | `any` | No | Unused internally (layout variant comes from top-level `variant`) |
|
|
37
|
+
| `banner.backgroundColor` | `any` | No | Unused internally |
|
|
38
|
+
| `banner.tintImage` | `any` | No | Unused internally |
|
|
39
|
+
| `variant` | `string` | Yes | Column layout: `'two-column'`, `'narrow-wide'`, or `'wide-narrow'` |
|
|
40
|
+
|
|
41
|
+
## Behavioral Contract
|
|
42
|
+
|
|
43
|
+
1. **Hero section:** Render a `<div>` with class `background-image-style` and the inline style `backgroundImage: url(${backgroundImage})`.
|
|
44
|
+
2. Inside the hero, render an overlay `<div>` with classes `background-style content`.
|
|
45
|
+
3. Inside the overlay, render `<h1 className='title'>{title}</h1>` and `<p className='message'>{message}</p>`.
|
|
46
|
+
4. **Column layout:** Below the hero, render a 12-column grid container with two columns:
|
|
47
|
+
- Column `a`: sized according to the variant (left/first column).
|
|
48
|
+
- Column `b`: sized according to the variant (right/second column).
|
|
49
|
+
5. **Variant column widths:**
|
|
50
|
+
- `'two-column'`: column A = 6/12, column B = 6/12 (equal split).
|
|
51
|
+
- `'narrow-wide'`: column A = 4/12, column B = 8/12.
|
|
52
|
+
- `'wide-narrow'`: column A = 8/12, column B = 4/12.
|
|
53
|
+
6. **Column A styles:** `padding: 1rem; background-color: var(--app-form-bg-color); border-radius: 16px; height: fit-content`.
|
|
54
|
+
7. **Column B styles:** `padding: 0rem 1rem` (no background).
|
|
55
|
+
8. **Outer wrapper:** `<div style={{ marginBottom: '2rem' }}>`.
|
|
56
|
+
|
|
57
|
+
## Layout Variants
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
two-column: [A 50%] [B 50%]
|
|
61
|
+
narrow-wide: [A 33%] [B 67%]
|
|
62
|
+
wide-narrow: [A 67%] [B 33%]
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Visual Specifications
|
|
66
|
+
|
|
67
|
+
Derived from `Banner.css`:
|
|
68
|
+
|
|
69
|
+
### Hero Section
|
|
70
|
+
|
|
71
|
+
| Property | Value |
|
|
72
|
+
|----------|-------|
|
|
73
|
+
| Margin left | -16px (bleeds to container edge) |
|
|
74
|
+
| Margin right | -16px |
|
|
75
|
+
| Height | `calc(19rem)` |
|
|
76
|
+
| Background size | cover |
|
|
77
|
+
| Background position | center center |
|
|
78
|
+
|
|
79
|
+
### Hero Overlay
|
|
80
|
+
|
|
81
|
+
| Property | Value |
|
|
82
|
+
|----------|-------|
|
|
83
|
+
| Background color | transparent |
|
|
84
|
+
| Color | `var(--banner-text-color)` |
|
|
85
|
+
| Width | 100% |
|
|
86
|
+
| Height | 100% |
|
|
87
|
+
| Text align | center |
|
|
88
|
+
| Display | flex |
|
|
89
|
+
| Flex direction | column |
|
|
90
|
+
| Justify content | center |
|
|
91
|
+
| Align items | center |
|
|
92
|
+
| Gap | `calc(0.5rem)` |
|
|
93
|
+
|
|
94
|
+
### Hero Title
|
|
95
|
+
|
|
96
|
+
| Property | Value |
|
|
97
|
+
|----------|-------|
|
|
98
|
+
| Margin | 0 |
|
|
99
|
+
| Font size | 1.728rem |
|
|
100
|
+
| Font weight | 600 |
|
|
101
|
+
|
|
102
|
+
### Hero Message
|
|
103
|
+
|
|
104
|
+
| Property | Value |
|
|
105
|
+
|----------|-------|
|
|
106
|
+
| Margin | 0 |
|
|
107
|
+
| Font size | 1rem |
|
|
108
|
+
| Font weight | 400 |
|
|
109
|
+
|
|
110
|
+
### Content Grid
|
|
111
|
+
|
|
112
|
+
| Property | Value |
|
|
113
|
+
|----------|-------|
|
|
114
|
+
| Padding | 1rem |
|
|
115
|
+
| Column spacing | 1 spacing unit (≈ 8px) |
|
|
116
|
+
|
|
117
|
+
**CSS-only implementation notes:**
|
|
118
|
+
- Hero: `margin: 0 -16px; height: 19rem; background-size: cover; background-position: center; position: relative`.
|
|
119
|
+
- Overlay: `position: absolute; inset: 0; display: flex; flex-direction: column; justify-content: center; align-items: center; gap: 0.5rem; color: var(--banner-text-color); text-align: center`.
|
|
120
|
+
- Content grid below hero: `display: grid; grid-template-columns: <a-cols>fr <b-cols>fr; gap: 8px; padding: 1rem`.
|
|
121
|
+
- Column A: `padding: 1rem; background-color: var(--app-form-bg-color); border-radius: 16px; height: fit-content`.
|
|
122
|
+
- Column B: `padding: 0 1rem`.
|
|
123
|
+
- For responsive behavior, collapse to single column on small viewports.
|
|
124
|
+
|
|
125
|
+
## Edge Cases & Special Logic
|
|
126
|
+
|
|
127
|
+
- If `backgroundImage` is an empty string or undefined, the hero section renders without a background image (transparent/color background).
|
|
128
|
+
- If `variant` is not one of the three known values, implement a safe default (e.g., `'two-column'`).
|
|
129
|
+
- The `banner.backgroundColor`, `banner.variant`, and `banner.tintImage` props are received but not rendered in the reference implementation.
|
|
130
|
+
|
|
131
|
+
## Dependencies
|
|
132
|
+
|
|
133
|
+
- No Pega SDK imports required (no `getPConnect`)
|
|
134
|
+
- No helper utilities required
|
|
135
|
+
|
|
136
|
+
## Design System Mapping
|
|
137
|
+
|
|
138
|
+
**UI control type:** Full-width banner hero with responsive two-column content area.
|
|
139
|
+
|
|
140
|
+
Listed design systems are examples only.
|
|
141
|
+
|
|
142
|
+
| Design System | Recommended Component |
|
|
143
|
+
|---|---|
|
|
144
|
+
| Default (CSS only) | CSS Grid for columns, CSS background for hero |
|
|
145
|
+
| MUI | `<Grid container size={12}>` with `<Grid size={{ xs: ... }}>` for columns |
|
|
146
|
+
| Ant Design | `<Row gutter={8}>` with `<Col span={...}>` for columns |
|
|
147
|
+
| Chakra UI | `<SimpleGrid columns={2}>` or `<Grid templateColumns='...'>` |
|
|
148
|
+
| Shadcn/ui | CSS Grid with Tailwind column utilities |
|
|
149
|
+
|
|
150
|
+
When implementing in a specific design system, map the following:
|
|
151
|
+
- `variant` column widths → grid column span values
|
|
152
|
+
- Background image hero → `backgroundImage` inline style with `background-size: cover`
|
|
153
|
+
- Column A (card-like) → design system's Card or `bg` prop with border-radius
|
|
154
|
+
- Column B (plain) → plain container with horizontal padding only
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: DSE component skill: CaseSummaryFields
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: CaseSummaryFields
|
|
7
|
+
|
|
8
|
+
Display-only grid of typed field values for a case summary header. Renders a 2-column grid of read-only fields, each formatted according to its type (text, date, currency, phone, email, checkbox, status, operator, etc.).
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a responsive 2-column read-only grid of field values for a case summary header area. Each field in the input array is typed (e.g., `textinput`, `date`, `currency`, `caseoperator`), and the component selects the appropriate display renderer per type. Visibility and a special status field injection are also handled.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `CaseSummaryFields`
|
|
21
|
+
- **Registration key:** `CaseSummaryFields` (in `component-map.ts`)
|
|
22
|
+
- **Does NOT use `getPConnect` directly** — receives pre-processed `theFields` array as a prop
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `theFields` | `Array<{ type: string; config: FieldConfig }>` | Yes | Array of typed field descriptors to render |
|
|
29
|
+
| `status` | `string` | No | The case status value, injected at position 1 if `showStatus` is true |
|
|
30
|
+
| `showStatus` | `boolean` | No | If `true`, splices a status field entry at position 1 in the fields array |
|
|
31
|
+
|
|
32
|
+
### FieldConfig shape (within each item in `theFields`)
|
|
33
|
+
|
|
34
|
+
| Property | Type | Description |
|
|
35
|
+
|----------|------|-------------|
|
|
36
|
+
| `label` | `string` | Field label |
|
|
37
|
+
| `value` | `any` | Field value |
|
|
38
|
+
| `visibility` | `boolean` (optional) | If `false`, the field is hidden |
|
|
39
|
+
| `caption` | `string` (optional) | Alternative label for checkbox fields |
|
|
40
|
+
| `trueLabel` | `string` (optional) | Display text when checkbox value is true |
|
|
41
|
+
| `falseLabel` | `string` (optional) | Display text when checkbox value is false |
|
|
42
|
+
| `currencyISOCode` | `string` (optional) | ISO currency code for currency fields |
|
|
43
|
+
|
|
44
|
+
## Behavioral Contract
|
|
45
|
+
|
|
46
|
+
### 1. Status Field Injection
|
|
47
|
+
|
|
48
|
+
Before rendering, if `showStatus` is `true` AND `theFields[1].type !== 'status'`, inject a status entry at position 1:
|
|
49
|
+
```
|
|
50
|
+
{ type: 'status', config: { value: status, label: 'Status' } }
|
|
51
|
+
```
|
|
52
|
+
If the fields array has fewer than 2 items, append the status entry at the end.
|
|
53
|
+
|
|
54
|
+
### 2. State Management with Deep Equality
|
|
55
|
+
|
|
56
|
+
- Store the final fields array in `theFieldsToRender` state.
|
|
57
|
+
- Only update `theFieldsToRender` if the new value is not deep-equal to the current value (use `fast-deep-equal/react`).
|
|
58
|
+
- When `theFieldsToRender` changes, recompute `theFieldsAsGridItems` (via `useEffect`).
|
|
59
|
+
|
|
60
|
+
### 3. Field Visibility
|
|
61
|
+
|
|
62
|
+
Skip any field where `config.visibility` exists and is `false`.
|
|
63
|
+
|
|
64
|
+
### 4. Type-Based Rendering (`getFieldValue(field)`)
|
|
65
|
+
|
|
66
|
+
When `field.config.value` is `null` or `''` (empty):
|
|
67
|
+
- For `caseoperator`: render `<Operator {...field.config} />`.
|
|
68
|
+
- For all other types: render a read-only TextField with value `'---'` and the field label.
|
|
69
|
+
|
|
70
|
+
When `field.config.value` is non-empty, switch on `field.type.toLowerCase()`:
|
|
71
|
+
|
|
72
|
+
| Type | Rendering |
|
|
73
|
+
|------|-----------|
|
|
74
|
+
| `textinput`, `decimal`, `integer`, `dropdown` | Read-only TextField (standard, no underline) with `value` |
|
|
75
|
+
| `checkbox` | Label: `label \|\| caption`; Value: `value ? trueLabel : falseLabel`; read-only TextField |
|
|
76
|
+
| `status` | Read-only TextField with class `psdk-csf-status-style` (uppercase, small, bold) |
|
|
77
|
+
| `phone` | `<a href={'tel:' + value}>` wrapping a read-only TextField with pointer cursor |
|
|
78
|
+
| `email` | `<a href={'mailto:' + format(value, 'email')}>` wrapping a read-only TextField with pointer cursor |
|
|
79
|
+
| `date` | Read-only TextField with `format(value, 'date', { format: dateFormatStringLong })` |
|
|
80
|
+
| `datetime` | Read-only TextField with `format(value, 'datetime', { format: dateFormatStringLong + ' hh:mm a' })` |
|
|
81
|
+
| `currency` | Read-only TextField with `format(value, 'currency', getCurrencyOptions(currencyISOCode))` |
|
|
82
|
+
| `boolean`, `userreference` | Read-only TextField with `format(value, type)` |
|
|
83
|
+
| `caseoperator` | `<Operator {...field.config} />` |
|
|
84
|
+
| default (unknown) | `<span>{type} {value}</span>` |
|
|
85
|
+
|
|
86
|
+
All TextFields use: `variant='standard'`, `slotProps.input.readOnly = true`, `slotProps.input.disableUnderline = true`.
|
|
87
|
+
|
|
88
|
+
### 5. Grid Layout
|
|
89
|
+
|
|
90
|
+
Render each visible field in `Grid size={{ xs: 6 }}` (2-column layout) inside a container `Grid` with class `psdk-case-summary-fields`.
|
|
91
|
+
|
|
92
|
+
## Visual Specifications
|
|
93
|
+
|
|
94
|
+
Derived from `CaseSummaryFields.css`:
|
|
95
|
+
|
|
96
|
+
### Status Field
|
|
97
|
+
|
|
98
|
+
| Property | Value |
|
|
99
|
+
|----------|-------|
|
|
100
|
+
| Display | inline-block |
|
|
101
|
+
| Font size | 0.75rem |
|
|
102
|
+
| Font weight | bold |
|
|
103
|
+
| Line height | `calc(0.5rem * 2.5)` (≈ 1.25rem) |
|
|
104
|
+
| Height | `calc(0.5rem * 2.5)` (≈ 1.25rem) |
|
|
105
|
+
| Text transform | uppercase |
|
|
106
|
+
|
|
107
|
+
### Summary Grid Container
|
|
108
|
+
|
|
109
|
+
| Property | Value |
|
|
110
|
+
|----------|-------|
|
|
111
|
+
| Padding | `calc(2 * 0.5rem)` (≈ 1rem) |
|
|
112
|
+
| Row gap | `calc(2 * 0.5rem)` (≈ 1rem) |
|
|
113
|
+
|
|
114
|
+
**CSS-only implementation notes:**
|
|
115
|
+
- Summary grid: `display: grid; grid-template-columns: 1fr 1fr; padding: 1rem; row-gap: 1rem`.
|
|
116
|
+
- Each field cell: standard read-only text display with label above value.
|
|
117
|
+
- Status text: `font-size: 0.75rem; font-weight: bold; text-transform: uppercase; line-height: 1.25rem`.
|
|
118
|
+
- Phone/email links: `text-decoration: none; color: inherit` on the `<a>` wrapper; use `cursor: pointer` on the inner input.
|
|
119
|
+
- Read-only field pair: label in secondary text color (`font-weight: 400; color: var(--text-secondary); font-size: 0.75rem`), value in primary text color below.
|
|
120
|
+
|
|
121
|
+
## Edge Cases & Special Logic
|
|
122
|
+
|
|
123
|
+
- Use `fast-deep-equal/react` deep equality before updating `theFieldsToRender` to prevent infinite re-render loops.
|
|
124
|
+
- Status splicing mutates `theFields` directly — ensure the original array reference is used (not a copy) when checking `theFields[1].type`.
|
|
125
|
+
- Date format comes from `getDateFormatInfo().dateFormatStringLong` — defaults to locale format.
|
|
126
|
+
- Currency options come from `getCurrencyOptions(field.config?.currencyISOCode)`.
|
|
127
|
+
- The `Operator` component is retrieved via `getComponentFromRegistry('Operator')` — not imported directly. This allows runtime component override.
|
|
128
|
+
- If `theFields` is null or undefined, initialize to empty to avoid crashes.
|
|
129
|
+
|
|
130
|
+
## Dependencies
|
|
131
|
+
|
|
132
|
+
- `getComponentFromRegistry` from `@pega/sdk-react` — to retrieve the `Operator` component at runtime
|
|
133
|
+
- `isDeepEqual` from `fast-deep-equal/react` — for state change detection
|
|
134
|
+
- `getDateFormatInfo` from `../../helpers/date-format-utils` — for locale date format string
|
|
135
|
+
- `getCurrencyOptions` from `../../field/Currency/currency-utils` — for currency formatting options
|
|
136
|
+
- `format` from `../../helpers/formatters` — for formatting phone, email, date, datetime, currency, boolean, userreference values
|
|
137
|
+
- `Operator` component (resolved via registry) — for `caseoperator` type rendering
|
|
138
|
+
|
|
139
|
+
## Design System Mapping
|
|
140
|
+
|
|
141
|
+
**UI control type:** 2-column grid of read-only labeled field values.
|
|
142
|
+
|
|
143
|
+
Listed design systems are examples only.
|
|
144
|
+
|
|
145
|
+
| Design System | Recommended Component |
|
|
146
|
+
|---|---|
|
|
147
|
+
| Default (CSS only) | CSS Grid 2-column layout with label/value pairs |
|
|
148
|
+
| MUI | `<Grid container>` with `<Grid size={{ xs: 6 }}>` cells; `<TextField variant='standard' readOnly>` per field |
|
|
149
|
+
| Ant Design | `<Descriptions layout='vertical' column={2}>` with typed item renderers |
|
|
150
|
+
| Chakra UI | `<SimpleGrid columns={2}>` with `<FormControl>` label/value pairs |
|
|
151
|
+
| Shadcn/ui | 2-column grid with `<Label>` / `<p>` pairs |
|
|
152
|
+
|
|
153
|
+
When implementing in a specific design system, map the following:
|
|
154
|
+
- Read-only TextField (standard, no underline) → design system's read-only text display
|
|
155
|
+
- Phone field → `<a href='tel:...'>` wrapper around the display
|
|
156
|
+
- Email field → `<a href='mailto:...'>` wrapper around the display
|
|
157
|
+
- Status field → uppercase badge/chip or styled text
|
|
158
|
+
- `caseoperator` type → delegate to the `Operator` component
|
|
159
|
+
- Missing/empty value → always display `'---'`
|