@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
package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroup.md
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# Skill: FieldGroup
|
|
2
|
+
|
|
3
|
+
Collapsible or static container that groups related fields under an optional section header and instructions text.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a labeled section that wraps one or more field components. Supports optional:
|
|
12
|
+
- **Section name** — rendered as a bold header above the fields.
|
|
13
|
+
- **Collapsible behavior** — the name header becomes a toggle that shows/hides the fields.
|
|
14
|
+
- **Instructions text** — rendered as HTML below the header and above the fields.
|
|
15
|
+
|
|
16
|
+
Children are rendered inside a full-width inner container.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `FieldGroup`
|
|
21
|
+
- **Registration key:** `FieldGroup` (in `component-map.ts`)
|
|
22
|
+
- **Does NOT use `getPConnect`** — receives children via `PropsWithChildren`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `children` | `ReactNode` | No | Field components to render inside the group |
|
|
29
|
+
| `name` | `string` | No | Section heading displayed above the fields |
|
|
30
|
+
| `collapsible` | `boolean` | No | If `true`, the header acts as a collapse/expand toggle. Default `false` |
|
|
31
|
+
| `instructions` | `string` | No | HTML string of instruction text shown between header and fields |
|
|
32
|
+
|
|
33
|
+
## Behavioral Contract
|
|
34
|
+
|
|
35
|
+
1. **State:** Maintain a `collapsed` boolean in local state, initialized to `false` (expanded).
|
|
36
|
+
2. **Name rendering:**
|
|
37
|
+
- If `name` is not provided, render no header.
|
|
38
|
+
- If `name` is provided and `collapsible` is `false`, render `<b>{name}</b>`.
|
|
39
|
+
- If `name` is provided and `collapsible` is `true`, wrap in a clickable `<span>` with:
|
|
40
|
+
- `id='field-group-header'`
|
|
41
|
+
- A directional arrow icon: **right arrow** when `collapsed === true`, **down arrow** when `collapsed === false`.
|
|
42
|
+
- The bold name text beside the arrow.
|
|
43
|
+
- Clicking the span toggles `collapsed`.
|
|
44
|
+
3. **Instructions:** If `instructions` is provided AND is not the string `'none'`, render it with `dangerouslySetInnerHTML={{ __html: instructions }}`.
|
|
45
|
+
4. **Children:** Render children inside a full-width div. If `collapsed` is `true`, do NOT render children (or instructions).
|
|
46
|
+
5. **Header cursor:** When `collapsible` is `true`, the header span uses `cursor: pointer`. When `collapsible` is `false`, cursor is `auto`.
|
|
47
|
+
6. **Layout:** All content is wrapped in a `Grid container` with `spacing={4}` and `justifyContent='space-between'`. The name row and children are inside a single inner `Grid` at full width.
|
|
48
|
+
|
|
49
|
+
## Visual Specifications
|
|
50
|
+
|
|
51
|
+
Derived from `FieldGroup.tsx` makeStyles:
|
|
52
|
+
|
|
53
|
+
### Outer Container
|
|
54
|
+
|
|
55
|
+
| Property | Value |
|
|
56
|
+
|----------|-------|
|
|
57
|
+
| Spacing | 4 units (≈ 32px in MUI default) |
|
|
58
|
+
|
|
59
|
+
### Component Root Margins
|
|
60
|
+
|
|
61
|
+
| Property | Value |
|
|
62
|
+
|----------|-------|
|
|
63
|
+
| Margin right | `theme.spacing(1)` (≈ 8px) |
|
|
64
|
+
| Margin left | `theme.spacing(1)` |
|
|
65
|
+
| Margin top | `theme.spacing(1)` |
|
|
66
|
+
| Margin bottom | `theme.spacing(1)` |
|
|
67
|
+
|
|
68
|
+
### Field Margin (name row)
|
|
69
|
+
|
|
70
|
+
| Property | Value |
|
|
71
|
+
|----------|-------|
|
|
72
|
+
| Padding top | `theme.spacing(1)` |
|
|
73
|
+
| Padding bottom | `theme.spacing(1)` |
|
|
74
|
+
| Margin top | `theme.spacing(1)` |
|
|
75
|
+
|
|
76
|
+
### Header Row (collapsible)
|
|
77
|
+
|
|
78
|
+
| Property | Value |
|
|
79
|
+
|----------|-------|
|
|
80
|
+
| Display | flex |
|
|
81
|
+
| Align items | center |
|
|
82
|
+
| Gap | 5px |
|
|
83
|
+
| Cursor | `pointer` (collapsible) or `auto` (non-collapsible) |
|
|
84
|
+
|
|
85
|
+
### Instructions
|
|
86
|
+
|
|
87
|
+
| Property | Value |
|
|
88
|
+
|----------|-------|
|
|
89
|
+
| Padding | `5px 0` |
|
|
90
|
+
|
|
91
|
+
**CSS-only implementation notes:**
|
|
92
|
+
- Outer wrapper: `margin: 8px`.
|
|
93
|
+
- Name row: `padding: 8px 0; margin-top: 8px`.
|
|
94
|
+
- Collapsible header: `display: flex; align-items: center; gap: 5px; cursor: pointer; user-select: none`.
|
|
95
|
+
- Non-collapsible name: plain `<b>` with no wrapper.
|
|
96
|
+
- Instructions: `padding: 5px 0`.
|
|
97
|
+
- Arrow icons: use Unicode or inline SVG — collapsed → `▶` / `›`, expanded → `▼` / `⌄`.
|
|
98
|
+
- Children wrapper: `width: 100%`.
|
|
99
|
+
- When collapsed, use `display: none` or conditional rendering to hide children.
|
|
100
|
+
|
|
101
|
+
## Edge Cases & Special Logic
|
|
102
|
+
|
|
103
|
+
- If `collapsible` is `false` (default), the `collapsed` state is never changed — clicking the name does nothing.
|
|
104
|
+
- `instructions` equal to the string `'none'` must NOT be rendered (skip entirely).
|
|
105
|
+
- `instructions` is rendered as raw HTML — ensure the content is trusted (server-side).
|
|
106
|
+
- If `name` is absent, render no header row, but still render instructions (if any) and children.
|
|
107
|
+
|
|
108
|
+
## Dependencies
|
|
109
|
+
|
|
110
|
+
- No Pega SDK imports required (no `getPConnect`)
|
|
111
|
+
- Arrow icons: `KeyboardArrowRightIcon` / `KeyboardArrowDownIcon` from `@mui/icons-material` (MUI only) — use equivalent icons or Unicode characters in non-MUI implementations
|
|
112
|
+
|
|
113
|
+
## Design System Mapping
|
|
114
|
+
|
|
115
|
+
**UI control type:** Collapsible section container with label, instructions, and children.
|
|
116
|
+
|
|
117
|
+
Listed design systems are examples only.
|
|
118
|
+
|
|
119
|
+
| Design System | Recommended Component |
|
|
120
|
+
|---|---|
|
|
121
|
+
| Default (CSS only) | `<div>` with toggled `display: none` on children, `<b>` header |
|
|
122
|
+
| MUI | Grid container with `KeyboardArrowRight/Down` icons for collapse toggle |
|
|
123
|
+
| Ant Design | `<Collapse>` or `<Card>` with collapsible panels |
|
|
124
|
+
| Chakra UI | `<Accordion>` or manual `<Box>` with toggle state |
|
|
125
|
+
| Shadcn/ui | `<Collapsible>` + `<CollapsibleTrigger>` + `<CollapsibleContent>` |
|
|
126
|
+
|
|
127
|
+
When implementing in a specific design system, map the following:
|
|
128
|
+
- `collapsed` toggle → design system's collapse/expand state or controlled component
|
|
129
|
+
- Arrow direction → visual indicator of expand/collapse state (chevron or arrow icon)
|
|
130
|
+
- `instructions` HTML → design system's `dangerouslySetInnerHTML` or rich content slot
|
|
131
|
+
- Full-width children → ensure children container spans the full group width
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# Skill: FieldGroupList
|
|
2
|
+
|
|
3
|
+
Repeating list of named field groups, each with its own children. Supports per-item delete and a global "+Add" link at the bottom.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a vertical list of field group items. Each item has a bold name header, optional delete button (top-right), and rendered children (the group's fields). An optional "+Add" link appears at the bottom when adding is allowed. A horizontal divider separates items when `onAdd` is provided.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `FieldGroupList`
|
|
16
|
+
- **Registration key:** `FieldGroupList` (in `component-map.ts`)
|
|
17
|
+
- **Does NOT use `getPConnect`** — receives all data as direct props
|
|
18
|
+
|
|
19
|
+
## Props
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Required | Description |
|
|
22
|
+
|------|------|----------|-------------|
|
|
23
|
+
| `items` | `Array<{ name: string; id: string; children: ReactNode }>` | Yes | List of field group items to render |
|
|
24
|
+
| `onDelete` | `(id: string) => void` | No | Called with the item's `id` when the delete button is clicked. If not provided, no delete button is shown |
|
|
25
|
+
| `onAdd` | `() => void` | No | Called when the "+Add" link is clicked. If not provided, no add link or dividers are shown |
|
|
26
|
+
|
|
27
|
+
## Behavioral Contract
|
|
28
|
+
|
|
29
|
+
1. Render a `Grid container` with `spacing={4}` and `justifyContent='space-between'` as the outer wrapper.
|
|
30
|
+
2. Inside, render a full-width inner Grid with `spacing={1}`.
|
|
31
|
+
3. For **each item** in `props.items`:
|
|
32
|
+
- Render a full-width `Grid` keyed by `item.name`.
|
|
33
|
+
- Render `<b>{item.name}</b>` as the item header.
|
|
34
|
+
- If `onDelete` is provided, render a delete button:
|
|
35
|
+
- Floated right.
|
|
36
|
+
- `type='button'`, `id={'delete-row-' + item.id}`, `aria-label='Delete Row'`.
|
|
37
|
+
- Button class: `psdk-utility-button`.
|
|
38
|
+
- On click: call `onDelete(item.id)`.
|
|
39
|
+
- Button contains an `<img>` with the trash icon loaded via `Utils.getImageSrc('trash', Utils.getSDKStaticConentUrl())`.
|
|
40
|
+
- Image class: `psdk-utility-card-action-svg-icon`.
|
|
41
|
+
- Render `{item.children}`.
|
|
42
|
+
- Render `<br />`.
|
|
43
|
+
- If `onAdd` is provided: render `<Divider />`, then `<br />`.
|
|
44
|
+
4. After all items, if `onAdd` is provided, render a `<Link>` (or `<a>`) with text `'+Add'`, `cursor: pointer`, and `onClick={onAdd}`.
|
|
45
|
+
|
|
46
|
+
## Visual Specifications
|
|
47
|
+
|
|
48
|
+
Derived from `FieldGroupList.tsx`:
|
|
49
|
+
|
|
50
|
+
### Outer Layout
|
|
51
|
+
|
|
52
|
+
| Property | Value |
|
|
53
|
+
|----------|-------|
|
|
54
|
+
| Grid container spacing | 4 (≈ 32px) |
|
|
55
|
+
|
|
56
|
+
### Delete Button
|
|
57
|
+
|
|
58
|
+
| Property | Value |
|
|
59
|
+
|----------|-------|
|
|
60
|
+
| Float | right |
|
|
61
|
+
| Style class | `psdk-utility-button` |
|
|
62
|
+
| Icon source | `Utils.getImageSrc('trash', Utils.getSDKStaticConentUrl())` |
|
|
63
|
+
|
|
64
|
+
### "+Add" Link
|
|
65
|
+
|
|
66
|
+
| Property | Value |
|
|
67
|
+
|----------|-------|
|
|
68
|
+
| Cursor | pointer |
|
|
69
|
+
| Underline | hover |
|
|
70
|
+
| Text | `'+Add'` |
|
|
71
|
+
|
|
72
|
+
**CSS-only implementation notes:**
|
|
73
|
+
- Outer wrapper: `display: flex; flex-direction: column; gap: 32px`.
|
|
74
|
+
- Item wrapper: `display: flex; flex-direction: column; gap: 8px; width: 100%`.
|
|
75
|
+
- Item header row: `display: flex; justify-content: space-between; align-items: center`.
|
|
76
|
+
- Delete button: `float: right` (or use flexbox `justify-content: space-between` on the header row instead).
|
|
77
|
+
- Delete icon: `width: 20px; height: 20px` SVG image of a trash/delete icon.
|
|
78
|
+
- Divider: `border-top: 1px solid var(--divider-color); margin: 8px 0`.
|
|
79
|
+
- "+Add" link: `cursor: pointer; text-decoration: underline; color: var(--app-primary-color)`.
|
|
80
|
+
|
|
81
|
+
## Edge Cases & Special Logic
|
|
82
|
+
|
|
83
|
+
- If `items` is empty, render only the "+Add" link (if `onAdd` is provided).
|
|
84
|
+
- If neither `onDelete` nor `onAdd` is provided, the list is read-only (no interactive elements).
|
|
85
|
+
- The trash icon is loaded dynamically via `Utils.getImageSrc` — if this utility is unavailable, fall back to a standard `🗑` character or an SVG trash icon.
|
|
86
|
+
- The delete button must use `type='button'` to prevent form submission.
|
|
87
|
+
|
|
88
|
+
## Dependencies
|
|
89
|
+
|
|
90
|
+
- `Utils` from `../../helpers/utils` — for `getImageSrc` and `getSDKStaticConentUrl` (used only for the trash icon)
|
|
91
|
+
- No Pega SDK `getPConnect` imports required
|
|
92
|
+
|
|
93
|
+
## Design System Mapping
|
|
94
|
+
|
|
95
|
+
**UI control type:** Repeating list of named groups with optional delete and add actions.
|
|
96
|
+
|
|
97
|
+
Listed design systems are examples only.
|
|
98
|
+
|
|
99
|
+
| Design System | Recommended Component |
|
|
100
|
+
|---|---|
|
|
101
|
+
| Default (CSS only) | Flex column layout with `<hr>` divider and `<button>` delete |
|
|
102
|
+
| MUI | `<Grid container>` items with `<Divider>` and `<Link>` for "+Add" |
|
|
103
|
+
| Ant Design | `<List>` items with `<Divider>` and `<Button type='link'>` for "+Add" |
|
|
104
|
+
| Chakra UI | `<VStack>` with `<Divider>` and `<Button variant='link'>` |
|
|
105
|
+
| Shadcn/ui | `<div>` flex column with `<Separator>` and a link button |
|
|
106
|
+
|
|
107
|
+
When implementing in a specific design system, map the following:
|
|
108
|
+
- Delete button → icon button or `danger` variant button placed at the item top-right
|
|
109
|
+
- Divider between items → `<Divider>` / `<hr>` (only when `onAdd` is present)
|
|
110
|
+
- "+Add" link → a text link / `Button variant='link'` that calls `onAdd`
|
|
111
|
+
- Trash icon → design system's delete icon or an SVG
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Skill: FieldValueList
|
|
2
|
+
|
|
3
|
+
Single field-value pair display component. Renders a label and value in either an inline (side-by-side) or stacked layout. Also used as a display mode renderer by field components (e.g., `TextInput`, `Dropdown`, etc.).
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a single name/value pair in a compact read-only layout. Supports two layout variants:
|
|
12
|
+
- **Inline:** Label and value are side by side (label 4/12 cols, value 8/12 cols).
|
|
13
|
+
- **Stacked:** Label is on top, value is larger below (both 12/12 cols).
|
|
14
|
+
|
|
15
|
+
When no name is provided, only the value is rendered at full width. Used directly as a display widget and delegated to by field components for their `DISPLAY_ONLY` and `STACKED_LARGE_VAL` display modes.
|
|
16
|
+
|
|
17
|
+
## Pega Metadata
|
|
18
|
+
|
|
19
|
+
- **Pega Name:** `FieldValueList`
|
|
20
|
+
- **Registration key:** `FieldValueList` (in `component-map.ts`)
|
|
21
|
+
- **Does NOT use `getPConnect`** — receives all data as direct props
|
|
22
|
+
|
|
23
|
+
## Props
|
|
24
|
+
|
|
25
|
+
| Prop | Type | Required | Description |
|
|
26
|
+
|------|------|----------|-------------|
|
|
27
|
+
| `name` | `string` | No | Field label. If omitted, only the value is rendered |
|
|
28
|
+
| `value` | `any` | Yes | Field value to display |
|
|
29
|
+
| `variant` | `string` | No | Layout: `'inline'` (default) or `'stacked'` |
|
|
30
|
+
| `isHtml` | `boolean` | No | If `true`, render value as raw HTML (default `false`) |
|
|
31
|
+
|
|
32
|
+
## Behavioral Contract
|
|
33
|
+
|
|
34
|
+
1. **Empty value fallback:** If `value` is `undefined` or an empty string (`''`), display `'---'` instead.
|
|
35
|
+
2. **No-name case:** If `name` is not provided, render only the value at full width (12 columns) regardless of `variant`.
|
|
36
|
+
3. **Inline variant** (default — `variant !== 'stacked'`):
|
|
37
|
+
- Label column: 4 of 12 columns.
|
|
38
|
+
- Value column: 8 of 12 columns (or 12 if no name).
|
|
39
|
+
- Label: secondary text color, `body2` typography, `fontWeight: 400`.
|
|
40
|
+
- Value: primary text color, `body2` typography.
|
|
41
|
+
4. **Stacked variant** (`variant === 'stacked'`):
|
|
42
|
+
- Label column: 12 of 12, `paddingBottom: 0` (label sits tight above value).
|
|
43
|
+
- Value column: 12 of 12, `paddingTop: 0` (value sits tight below label).
|
|
44
|
+
- Label: secondary text color, `body2` typography, `fontWeight: 400`.
|
|
45
|
+
- Value: primary text color, **`h6` typography** (larger / more prominent than inline).
|
|
46
|
+
5. **HTML rendering:** If `isHtml` is `true`, wrap value in a `<div dangerouslySetInnerHTML={{ __html: formattedValue }}>`. The formatted value (with `'---'` fallback) is passed to `__html`.
|
|
47
|
+
6. **Layout wrapper:** Render everything inside a container row with space-between justification and consistent spacing.
|
|
48
|
+
|
|
49
|
+
## Visual Specifications
|
|
50
|
+
|
|
51
|
+
Derived from `FieldValueList.tsx` makeStyles:
|
|
52
|
+
|
|
53
|
+
### Label
|
|
54
|
+
|
|
55
|
+
| Property | Value |
|
|
56
|
+
|----------|-------|
|
|
57
|
+
| Font weight | 400 |
|
|
58
|
+
| Color | `theme.palette.text.secondary` (muted/secondary text) |
|
|
59
|
+
| Typography | `body2` (≈ 0.875rem / 14px) |
|
|
60
|
+
|
|
61
|
+
### Value
|
|
62
|
+
|
|
63
|
+
| Property | Value |
|
|
64
|
+
|----------|-------|
|
|
65
|
+
| Color | `theme.palette.text.primary` (default text) |
|
|
66
|
+
| Typography (inline) | `body2` (≈ 0.875rem / 14px) |
|
|
67
|
+
| Typography (stacked) | `h6` (≈ 1.25rem / 20px, weight 500) |
|
|
68
|
+
|
|
69
|
+
### Padding Adjustments (stacked only)
|
|
70
|
+
|
|
71
|
+
| Property | Value |
|
|
72
|
+
|----------|-------|
|
|
73
|
+
| Label bottom padding | `0 !important` |
|
|
74
|
+
| Value top padding | `0 !important` |
|
|
75
|
+
|
|
76
|
+
**CSS-only implementation notes:**
|
|
77
|
+
- Root row: `display: flex; justify-content: space-between; align-items: baseline; gap: 1rem`.
|
|
78
|
+
- **Inline label:** `flex: 0 0 33%; font-weight: 400; font-size: 0.875rem; color: var(--text-secondary)`.
|
|
79
|
+
- **Inline value:** `flex: 1; font-size: 0.875rem; color: var(--text-primary)`.
|
|
80
|
+
- **Stacked:** `display: flex; flex-direction: column; gap: 0`.
|
|
81
|
+
- **Stacked label:** `font-weight: 400; font-size: 0.875rem; color: var(--text-secondary); margin-bottom: 0`.
|
|
82
|
+
- **Stacked value:** `font-size: 1.25rem; font-weight: 500; color: var(--text-primary); margin-top: 0`.
|
|
83
|
+
|
|
84
|
+
## Edge Cases & Special Logic
|
|
85
|
+
|
|
86
|
+
- `value` can be any type (string, number, boolean, React element). Render it as-is unless it's empty/undefined.
|
|
87
|
+
- When `isHtml` is `true`, set the raw HTML from the formatted value — do NOT sanitize (the caller is responsible). Ensure value is a string before passing to `dangerouslySetInnerHTML`.
|
|
88
|
+
- When `variant` is `'stacked'` and `name` is absent, render value at 12 cols with `h6` typography.
|
|
89
|
+
- When `variant` is `'inline'` and `name` is absent, render value at 12 cols with `body2` typography.
|
|
90
|
+
|
|
91
|
+
## Dependencies
|
|
92
|
+
|
|
93
|
+
- No Pega SDK imports required (no `getPConnect`)
|
|
94
|
+
- No helper utilities required
|
|
95
|
+
|
|
96
|
+
## Design System Mapping
|
|
97
|
+
|
|
98
|
+
**UI control type:** Read-only field label/value display pair.
|
|
99
|
+
|
|
100
|
+
Listed design systems are examples only.
|
|
101
|
+
|
|
102
|
+
| Design System | Recommended Component |
|
|
103
|
+
|---|---|
|
|
104
|
+
| Default (CSS only) | `<div class='field-value-inline'>` or `<div class='field-value-stacked'>` with CSS |
|
|
105
|
+
| MUI | `<Grid container>` with `<Typography>` for label and value |
|
|
106
|
+
| Ant Design | `<Descriptions>` item, or `<Typography.Text type='secondary'>` + `<Typography.Text>` |
|
|
107
|
+
| Chakra UI | `<Stack direction='row'>` (inline) or `<Stack spacing={0}>` (stacked) |
|
|
108
|
+
| Shadcn/ui | Custom label/value pair with Tailwind flex utilities |
|
|
109
|
+
|
|
110
|
+
When implementing in a specific design system, map the following:
|
|
111
|
+
- Label → secondary/muted text style
|
|
112
|
+
- Value inline → same size as label
|
|
113
|
+
- Value stacked → larger typography (h6 equivalent)
|
|
114
|
+
- Empty value → always display `'---'` (never show blank)
|
|
115
|
+
- `isHtml={true}` → design system's `dangerouslySetInnerHTML` or `innerHTML` equivalent
|
package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Operator.md
ADDED
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
# Skill: Operator
|
|
2
|
+
|
|
3
|
+
Read-only display of a Pega case operator (creator or updater). Shows the operator's name and relative timestamp. On click, fetches full operator details from Pega and displays them in a popover.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a clickable read-only field displaying a case operator's name and the relative time of their action (created/updated). Clicking the field triggers an async fetch of the operator's profile details (position, organization, reports-to, telephone, email) and shows them in a popover panel.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Operator`
|
|
16
|
+
- **Registration key:** `Operator` (in `component-map.ts`)
|
|
17
|
+
- **Extends `PConnProps`** — but does NOT call `getPConnect()`. Props are all passed directly.
|
|
18
|
+
|
|
19
|
+
## Props
|
|
20
|
+
|
|
21
|
+
The component interface extends `PConnProps` but all rendering data is passed as explicit props:
|
|
22
|
+
|
|
23
|
+
| Prop | Type | Required | Description |
|
|
24
|
+
|------|------|----------|-------------|
|
|
25
|
+
| `label` | `string` | Yes | The field label used to identify which operator to display. Must be `'create operator'` or `'update operator'` (case-insensitive). |
|
|
26
|
+
| `displayLabel` | `any` | No | Alternative label (used if `label` doesn't match). Also compared case-insensitively. |
|
|
27
|
+
| `createDateTime` | `string` | Yes | ISO datetime string of when the case was created |
|
|
28
|
+
| `createLabel` | `string` | Yes | Display label for the create operator field |
|
|
29
|
+
| `createOperator` | `{ userName: string; userId: string }` | Yes | Creator's name and ID |
|
|
30
|
+
| `updateDateTime` | `string` | Yes | ISO datetime string of last update |
|
|
31
|
+
| `updateLabel` | `string` | Yes | Display label for the update operator field |
|
|
32
|
+
| `updateOperator` | `{ userName: string; userId: string }` | Yes | Updater's name and ID |
|
|
33
|
+
|
|
34
|
+
## Behavioral Contract
|
|
35
|
+
|
|
36
|
+
### 1. Operator Selection
|
|
37
|
+
|
|
38
|
+
Determine which operator to display based on `label.toLowerCase()` or `displayLabel?.toLowerCase()`:
|
|
39
|
+
- If either is `'create operator'`:
|
|
40
|
+
- `caseOpLabel = createLabel`
|
|
41
|
+
- `caseOpName = createOperator.userName`
|
|
42
|
+
- `caseOpId = createOperator.userId`
|
|
43
|
+
- `caseTime = createDateTime`
|
|
44
|
+
- If either is `'update operator'`:
|
|
45
|
+
- `caseOpLabel = updateLabel`
|
|
46
|
+
- `caseOpName = updateOperator.userName`
|
|
47
|
+
- `caseOpId = updateOperator.userId`
|
|
48
|
+
- `caseTime = updateDateTime`
|
|
49
|
+
- Otherwise: `caseOpLabel = '---'`, `caseOpName = '---'`, `caseOpId = ''`, `caseTime = ''`.
|
|
50
|
+
|
|
51
|
+
### 2. Main Display
|
|
52
|
+
|
|
53
|
+
Render a read-only TextField (standard variant, no underline, pointer cursor) with:
|
|
54
|
+
- `defaultValue={caseOpName}`
|
|
55
|
+
- `label={caseOpLabel}`
|
|
56
|
+
- `onClick={showOperatorDetails}`
|
|
57
|
+
- `readOnly: true`, `disableUnderline: true`, `cursor: 'pointer'`
|
|
58
|
+
|
|
59
|
+
Below the TextField, render the relative time: `Utils.generateDateTime(caseTime, 'DateTime-Since')`.
|
|
60
|
+
|
|
61
|
+
### 3. Popover on Click (`showOperatorDetails`)
|
|
62
|
+
|
|
63
|
+
When the TextField is clicked:
|
|
64
|
+
1. Call `PCore.getUserApi().getOperatorDetails(caseOpId)` — returns a Promise.
|
|
65
|
+
2. Use `PCore.getLocaleUtils().getLocaleValue(key, 'Operator')` to localize field labels.
|
|
66
|
+
3. On resolution, build a fields array with these entries (using `'---'` as fallback for missing values):
|
|
67
|
+
- Position (`pyPosition`)
|
|
68
|
+
- Organization (`pyOrganization`)
|
|
69
|
+
- Reports to (`pyReportToUserName`)
|
|
70
|
+
- Telephone (`pyTelephone`) — rendered as `<a href={'tel:' + value}>{value}</a>`
|
|
71
|
+
- Email address (`pyEmailAddress`) — rendered as `<a href={'mailto:' + value}>{value}</a>`
|
|
72
|
+
4. If `res.data.pyOperatorInfo.pyUserName` is empty, use all `'---'` fallbacks.
|
|
73
|
+
5. Set `popoverFields` state with the resolved fields.
|
|
74
|
+
6. Set `popoverAnchorEl` to the clicked element to open the popover.
|
|
75
|
+
|
|
76
|
+
### 4. Popover Layout
|
|
77
|
+
|
|
78
|
+
The popover renders when `popoverAnchorEl` is set:
|
|
79
|
+
- Anchor origin: `{ vertical: 'bottom', horizontal: 'center' }`
|
|
80
|
+
- Transform origin: `{ vertical: 'top', horizontal: 'center' }`
|
|
81
|
+
- Max width: `45ch`
|
|
82
|
+
- Content: A `Grid container` with:
|
|
83
|
+
- `Typography h6` showing `caseOpName` at full width.
|
|
84
|
+
- One row per field: 6-col `Typography caption` (label) + 6-col `Typography subtitle2` (value).
|
|
85
|
+
|
|
86
|
+
Closing the popover sets `popoverAnchorEl` to `null`.
|
|
87
|
+
|
|
88
|
+
## Visual Specifications
|
|
89
|
+
|
|
90
|
+
Derived from `Operator.tsx` makeStyles:
|
|
91
|
+
|
|
92
|
+
### Root Container
|
|
93
|
+
|
|
94
|
+
| Property | Value |
|
|
95
|
+
|----------|-------|
|
|
96
|
+
| Padding | `theme.spacing(1)` (≈ 8px) |
|
|
97
|
+
| Margin | `theme.spacing(1)` |
|
|
98
|
+
|
|
99
|
+
### Popover Container
|
|
100
|
+
|
|
101
|
+
| Property | Value |
|
|
102
|
+
|----------|-------|
|
|
103
|
+
| Padding | `theme.spacing(1)` |
|
|
104
|
+
| Margin | `theme.spacing(1)` |
|
|
105
|
+
| Max width | 45ch |
|
|
106
|
+
|
|
107
|
+
**CSS-only implementation notes:**
|
|
108
|
+
- Main display: read-only text field with label above, value below, pointer cursor on the value element.
|
|
109
|
+
- Time display: secondary muted text below the operator name (e.g., `font-size: 0.75rem; color: var(--text-secondary)`).
|
|
110
|
+
- Popover: `position: absolute; background: var(--bg-paper); border: 1px solid var(--divider); border-radius: 4px; padding: 8px; max-width: 45ch; box-shadow: 0 4px 12px rgba(0,0,0,0.15)`.
|
|
111
|
+
- Operator name in popover: `font-size: 1.25rem; font-weight: 500; margin-bottom: 8px`.
|
|
112
|
+
- Detail rows: `display: grid; grid-template-columns: 1fr 1fr; gap: 4px; align-items: baseline`.
|
|
113
|
+
- Detail label: `font-size: 0.75rem; color: var(--text-secondary)`.
|
|
114
|
+
- Detail value: `font-size: 0.875rem; font-weight: 500`.
|
|
115
|
+
- Close popover on outside click (use `onClose` / blur handler).
|
|
116
|
+
|
|
117
|
+
## Edge Cases & Special Logic
|
|
118
|
+
|
|
119
|
+
- If `caseOpId` is empty (label not recognized), do NOT call `getOperatorDetails` — the fetch would fail.
|
|
120
|
+
- If the API response has no `pyOperatorInfo.pyUserName`, fall back to all `'---'` for field values (still open the popover).
|
|
121
|
+
- `Utils.generateDateTime(caseTime, 'DateTime-Since')` handles empty `caseTime` gracefully.
|
|
122
|
+
- State: `popoverFields` starts as empty array `[]`. Check `popoverFields.length === 0` and return `undefined` from `getPopoverGrid()` to render nothing before data loads.
|
|
123
|
+
|
|
124
|
+
## Dependencies
|
|
125
|
+
|
|
126
|
+
- `Utils` from `../../helpers/utils` — `Utils.generateDateTime` for relative time display
|
|
127
|
+
- `PCore.getUserApi().getOperatorDetails(userId)` — global Pega runtime API for operator details
|
|
128
|
+
- `PCore.getLocaleUtils().getLocaleValue(key, 'Operator')` — for localized field labels in the popover
|
|
129
|
+
|
|
130
|
+
## Design System Mapping
|
|
131
|
+
|
|
132
|
+
**UI control type:** Clickable read-only field with async popover detail panel.
|
|
133
|
+
|
|
134
|
+
Listed design systems are examples only.
|
|
135
|
+
|
|
136
|
+
| Design System | Recommended Component |
|
|
137
|
+
|---|---|
|
|
138
|
+
| Default (CSS only) | `<div>` with click handler, custom CSS popover/tooltip panel |
|
|
139
|
+
| MUI | Read-only `<TextField>` + `<Popover>` with `<Grid>` detail rows |
|
|
140
|
+
| Ant Design | `<Input readOnly>` + `<Popover>` with `<Descriptions>` |
|
|
141
|
+
| Chakra UI | `<Input isReadOnly>` + `<Popover>` with custom content |
|
|
142
|
+
| Shadcn/ui | `<Input readOnly>` + `<Popover>` + `<PopoverContent>` |
|
|
143
|
+
|
|
144
|
+
When implementing in a specific design system, map the following:
|
|
145
|
+
- `onClick` on read-only input → trigger async fetch + open popover
|
|
146
|
+
- `PCore.getUserApi().getOperatorDetails()` → call this before showing the popover
|
|
147
|
+
- Popover anchor → position relative to the clicked element
|
|
148
|
+
- `Utils.generateDateTime(caseTime, 'DateTime-Since')` → relative time display (e.g., "2 hours ago")
|
|
149
|
+
- Telephone/email in popover → clickable `<a href='tel:...'>` and `<a href='mailto:...'>` links
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Skill: Pulse
|
|
2
|
+
|
|
3
|
+
Placeholder activity feed / comments stream card. Currently a stub implementation that renders a card titled "Pulse".
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a card container intended to display an activity feed or comments stream for a Pega case. The current reference implementation is a **stub** — it renders only a Card with the title "Pulse" and placeholder body text. A production implementation would render a real activity feed stream inside the card using the `children` slot.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Pulse`
|
|
16
|
+
- **Registration key:** `Pulse` (in `component-map.ts`)
|
|
17
|
+
- **Does NOT use `getPConnect`** — receives children via `PropsWithChildren`
|
|
18
|
+
|
|
19
|
+
## Props
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Required | Description |
|
|
22
|
+
|------|------|----------|-------------|
|
|
23
|
+
| `children` | `ReactNode` | No | Child components (activity stream content) — currently unused in the stub |
|
|
24
|
+
|
|
25
|
+
> **Note:** The current reference implementation ignores `children` and renders placeholder content. A full implementation would render `children` inside the card body.
|
|
26
|
+
|
|
27
|
+
## Behavioral Contract
|
|
28
|
+
|
|
29
|
+
1. Render a `Card` (or equivalent container) with a distinct left border accent.
|
|
30
|
+
2. Render a card header with the title text `"Pulse"` using a heading style (e.g., `h6`).
|
|
31
|
+
3. Render card content body with placeholder text `"Pulse"`.
|
|
32
|
+
4. The left border accent uses the **primary light** color from the design system's theme.
|
|
33
|
+
5. The card has top and bottom margin (1 spacing unit each).
|
|
34
|
+
|
|
35
|
+
> **Stub note:** Steps 2–3 are placeholder content. In a real implementation, the card header would show a section label and the card body would render the `children` activity stream.
|
|
36
|
+
|
|
37
|
+
## Visual Specifications
|
|
38
|
+
|
|
39
|
+
Derived from `Pulse.tsx` makeStyles:
|
|
40
|
+
|
|
41
|
+
### Card Container
|
|
42
|
+
|
|
43
|
+
| Property | Value |
|
|
44
|
+
|----------|-------|
|
|
45
|
+
| Margin top | `theme.spacing(1)` (≈ 8px in MUI default) |
|
|
46
|
+
| Margin bottom | `theme.spacing(1)` (≈ 8px) |
|
|
47
|
+
| Border left | `6px solid` |
|
|
48
|
+
| Border left color | `theme.palette.primary.light` (light variant of the primary brand color) |
|
|
49
|
+
|
|
50
|
+
**CSS-only implementation notes:**
|
|
51
|
+
- Card wrapper: `margin-top: 8px; margin-bottom: 8px; border-left: 6px solid var(--app-primary-light-color); border-radius: 4px; box-shadow: 0 1px 3px rgba(0,0,0,0.12)`.
|
|
52
|
+
- Card header: `padding: 16px; font-size: 1.25rem; font-weight: 500`.
|
|
53
|
+
- Card body: `padding: 0 16px 16px`.
|
|
54
|
+
- Use a CSS variable `--app-primary-light-color` for the accent border color.
|
|
55
|
+
|
|
56
|
+
## Edge Cases & Special Logic
|
|
57
|
+
|
|
58
|
+
- The `children` prop is received but not currently rendered — it is intentional in the stub.
|
|
59
|
+
- The component renders unconditionally (no conditional logic based on props).
|
|
60
|
+
|
|
61
|
+
## Dependencies
|
|
62
|
+
|
|
63
|
+
- No Pega SDK imports required (no `getPConnect`)
|
|
64
|
+
- No helper utilities required
|
|
65
|
+
|
|
66
|
+
## Design System Mapping
|
|
67
|
+
|
|
68
|
+
**UI control type:** Card with left accent border and header/body sections.
|
|
69
|
+
|
|
70
|
+
Listed design systems are examples only.
|
|
71
|
+
|
|
72
|
+
| Design System | Recommended Component |
|
|
73
|
+
|---|---|
|
|
74
|
+
| Default (CSS only) | `<div>` with `border-left: 6px solid` + inner header/body divs |
|
|
75
|
+
| MUI | `<Card><CardHeader title={<Typography variant='h6'>Pulse</Typography>} /><CardContent>` |
|
|
76
|
+
| Ant Design | `<Card title='Pulse'>` with left border via `style` prop |
|
|
77
|
+
| Chakra UI | `<Card>` with `borderLeft='6px solid' borderColor='blue.300'` |
|
|
78
|
+
| Shadcn/ui | `<Card><CardHeader><CardTitle>` |
|
|
79
|
+
|
|
80
|
+
When implementing in a specific design system, map the following:
|
|
81
|
+
- Left border accent → `borderLeft` / `border-left` on the card root
|
|
82
|
+
- Left border color → primary light color from the design system's palette
|
|
83
|
+
- Card header title typography → design system's heading variant (h6 or equivalent)
|