@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/.cursor/rules/skills/field-skills/SelectableCard.mdrules
ADDED
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: SelectableCard
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: SelectableCard
|
|
7
|
+
|
|
8
|
+
Card-style radio or checkbox selection grid with optional image support.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a grid of selectable cards. Each card contains a radio button or checkbox (depending on `type`), a label, optional image, and optional additional fields. Cards are clickable — clicking anywhere on the card triggers the input. Used by `RadioButtons` (variant='card') and `Checkbox` (variant='card').
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `SelectableCard`
|
|
21
|
+
- **Type / Subtype:** Internal design system extension
|
|
22
|
+
- **Registration key:** `SelectableCard` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
> This component does NOT have a `config-ext.json` and does NOT extend `PConnFieldProps` — it's a design system component used internally by `RadioButtons` and `Checkbox`.
|
|
25
|
+
|
|
26
|
+
## Props
|
|
27
|
+
|
|
28
|
+
| Prop | Type | Default | Description |
|
|
29
|
+
|------|------|---------|-------------|
|
|
30
|
+
| `getPConnect` | `function` | — | PConnect accessor |
|
|
31
|
+
| `type` | `'radio' \| 'checkbox'` | — | Selection type |
|
|
32
|
+
| `image` | `object` | — | `{ imagePosition, imageSize, showImageDescription, imageField, imageDescription }` |
|
|
33
|
+
| `dataSource` | `any` | — | Source of card data (in editable mode) |
|
|
34
|
+
| `recordKey` | `string` | `''` | The key field name in each record (e.g., `'pyID'`) |
|
|
35
|
+
| `className` | `string` | — | CSS class for the card |
|
|
36
|
+
| `cardLabel` | `string` | — | The field name to use as card title |
|
|
37
|
+
| `hideFieldLabels` | `boolean` | `false` | Hide field labels inside cards |
|
|
38
|
+
| `readOnly` | `boolean` | — | Read-only mode |
|
|
39
|
+
| `disabled` | `boolean` | — | Disabled state |
|
|
40
|
+
| `readOnlyList` | `any[]` | `[]` | Selected items for read-only display |
|
|
41
|
+
| `displayMode` | `string` | — | Display mode string |
|
|
42
|
+
| `radioBtnValue` | `any` | — | Currently selected value (radio mode) |
|
|
43
|
+
| `onChange` | `function` | — | Change handler |
|
|
44
|
+
| `onBlur` | `function` | — | Blur handler |
|
|
45
|
+
| `onClick` | `function` | — | Click handler |
|
|
46
|
+
| `onKeyDown` | `function` | — | KeyDown handler |
|
|
47
|
+
| `additionalProps` | `any` | — | Spread onto the radio/checkbox input |
|
|
48
|
+
| `testId` | `string` | — | Test identifier |
|
|
49
|
+
| `setIsRadioCardSelected` | `function` | — | Callback to inform parent whether radio selection matched |
|
|
50
|
+
| `showNoValue` | `boolean` | `false` | When true (read-only + no selected items), render "No Value" text |
|
|
51
|
+
|
|
52
|
+
## Behavioral Contract
|
|
53
|
+
|
|
54
|
+
### Data source selection
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
cardDataSource = (readOnly || displayMode === 'DISPLAY_ONLY')
|
|
58
|
+
? readOnlyList || []
|
|
59
|
+
: dataSource?.source
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### "No Value" guard
|
|
63
|
+
|
|
64
|
+
If `showNoValue`: render a plain text element showing `'No Value'` and return early.
|
|
65
|
+
|
|
66
|
+
### Card click handler
|
|
67
|
+
|
|
68
|
+
Cards should be clickable anywhere (not just on the checkbox/radio):
|
|
69
|
+
```typescript
|
|
70
|
+
const handleCardClick = (event) => {
|
|
71
|
+
if (disabled || readOnly) return
|
|
72
|
+
if (event.target.closest('label, input')) return // native click already handled
|
|
73
|
+
const input = event.currentTarget.querySelector('input[type="radio"], input[type="checkbox"]')
|
|
74
|
+
if (input) input.click()
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Subsection: Display mode (`displayMode === 'DISPLAY_ONLY'`)
|
|
79
|
+
|
|
80
|
+
Render a **simple read-only card** (no radio/checkbox) with:
|
|
81
|
+
- Optional image (`<img>`)
|
|
82
|
+
- Card title: `item[cardLabel]`
|
|
83
|
+
- Additional resolved fields (from `resolveReferenceFields`)
|
|
84
|
+
- `style: { display: 'flex' }`
|
|
85
|
+
|
|
86
|
+
```html
|
|
87
|
+
<Card style="display: flex">
|
|
88
|
+
{image && <img src="..." alt="..." style="width: 100px">}
|
|
89
|
+
<CardContent>
|
|
90
|
+
<body1>{item[cardLabel]}</body1>
|
|
91
|
+
{fields.map(field => <body2>{field.value}</body2>)}
|
|
92
|
+
</CardContent>
|
|
93
|
+
</Card>
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Subsection: Editable mode (radio or checkbox)
|
|
97
|
+
|
|
98
|
+
Render a **selectable card** with click handler, containing the appropriate input:
|
|
99
|
+
|
|
100
|
+
```html
|
|
101
|
+
<div style="paddingTop: 15px">
|
|
102
|
+
<Card style="cursor: pointer, height: 100%, flexDirection: column"
|
|
103
|
+
onClick={handleCardClick}>
|
|
104
|
+
<CardContent style={imageLayoutStyle}>
|
|
105
|
+
<!-- Image section (40% width for inline positions) -->
|
|
106
|
+
{image && <img full-width, aspect-ratio 16/9, contain>}
|
|
107
|
+
<!-- Content section (60% width for inline positions) -->
|
|
108
|
+
{type === 'radio'
|
|
109
|
+
? <FormControlLabel control={<Radio value={item[recordKey]} checked={radioBtnValue === item[recordKey]} onChange={onChange} ... />} label={item[cardLabel]}>
|
|
110
|
+
: <FormControlLabel control={<Checkbox id={item[recordKey]} checked={readOnlyList.some(d => d[recordKey] === item[recordKey])} onChange={onChange} ... />} label={item[cardLabel]}>
|
|
111
|
+
}
|
|
112
|
+
{fields.map(field => <div style={fieldLayoutStyle}>{field.name && <div>{field.name}</div>}<div>{field.value}</div></div>)}
|
|
113
|
+
</CardContent>
|
|
114
|
+
</Card>
|
|
115
|
+
</div>
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Image layout (inline positions)
|
|
119
|
+
|
|
120
|
+
| `imagePosition` | CardContent style | Image section width | Content section width |
|
|
121
|
+
|-----------------|-------------------|--------------------|----------------------|
|
|
122
|
+
| `'inline-start'` | `display: flex` | 40% | 60% |
|
|
123
|
+
| `'inline-end'` | `display: flex, flexDirection: row-reverse` | 40% | 60% |
|
|
124
|
+
| block (default) | default | full width | full width |
|
|
125
|
+
|
|
126
|
+
### Image element
|
|
127
|
+
|
|
128
|
+
```css
|
|
129
|
+
img {
|
|
130
|
+
width: 100%;
|
|
131
|
+
background-color: transparent;
|
|
132
|
+
aspect-ratio: 16 / 9;
|
|
133
|
+
max-height: 100%;
|
|
134
|
+
height: 100%;
|
|
135
|
+
object-fit: contain;
|
|
136
|
+
max-width: 100%;
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Field display layout
|
|
141
|
+
|
|
142
|
+
Each additional field in editable mode:
|
|
143
|
+
```css
|
|
144
|
+
.card-field {
|
|
145
|
+
font-size: 0.875rem;
|
|
146
|
+
display: grid; /* only if type !== 'TextArea' */
|
|
147
|
+
grid-template-columns: 1fr 1fr;
|
|
148
|
+
margin: 5px;
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Radio tracking
|
|
153
|
+
|
|
154
|
+
After iterating cards, if `type === 'radio'` and `setIsRadioCardSelected`:
|
|
155
|
+
```
|
|
156
|
+
if (radioBtnValue === item[recordKey]) radioItemSelected = true
|
|
157
|
+
// After loop:
|
|
158
|
+
setIsRadioCardSelected(radioItemSelected)
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## Display Mode Rendering
|
|
162
|
+
|
|
163
|
+
`displayMode === 'DISPLAY_ONLY'`: renders simple read-only cards (no radio/checkbox inputs). Uses `readOnlyList` as the data source.
|
|
164
|
+
|
|
165
|
+
## Visual Specifications
|
|
166
|
+
|
|
167
|
+
| Property | Editable card | Display-only card |
|
|
168
|
+
|----------|--------------|-------------------|
|
|
169
|
+
| Cursor | `pointer` (unless disabled/readOnly → `default`) | Default |
|
|
170
|
+
| Height | `100%` (fills grid row) | Auto |
|
|
171
|
+
| Layout | Column flex | Row flex |
|
|
172
|
+
| Padding top | 15px wrapper | — |
|
|
173
|
+
| Image (display-only) | 100px fixed width | 100px fixed width |
|
|
174
|
+
| Card border | Default (design-system card elevation) | Default |
|
|
175
|
+
| Disabled | `cursor: default` | — |
|
|
176
|
+
|
|
177
|
+
**CSS-only card implementation:**
|
|
178
|
+
```css
|
|
179
|
+
.selectable-card {
|
|
180
|
+
border: 1px solid rgba(0,0,0,0.12);
|
|
181
|
+
border-radius: 4px;
|
|
182
|
+
padding: 16px;
|
|
183
|
+
cursor: pointer;
|
|
184
|
+
display: flex;
|
|
185
|
+
flex-direction: column;
|
|
186
|
+
height: 100%;
|
|
187
|
+
margin-top: 15px;
|
|
188
|
+
transition: border-color 0.2s;
|
|
189
|
+
}
|
|
190
|
+
.selectable-card:hover { border-color: #1976d2; }
|
|
191
|
+
.selectable-card.disabled { cursor: default; opacity: 0.7; }
|
|
192
|
+
.selectable-card.readonly { cursor: default; }
|
|
193
|
+
.selectable-card-label { font-size: 1rem; font-weight: 400; }
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
## Edge Cases & Special Logic
|
|
197
|
+
|
|
198
|
+
- **`resolveReferenceFields(item, hideFieldLabels, recordKey, pConn)`** — local utility that resolves additional display fields from an item record.
|
|
199
|
+
- Checkbox `id={item[recordKey]}` — required for the card click handler to find and click the input by ID.
|
|
200
|
+
- `getPConnect` prop on Checkbox (MUI): passed through to support `@pega/sdk-react` checkbox augmentation (non-standard MUI prop).
|
|
201
|
+
- `imageDescriptionKey = showImageDescription ? imageDescription : undefined` — only show alt text when `showImageDescription` is true.
|
|
202
|
+
|
|
203
|
+
## Dependencies
|
|
204
|
+
|
|
205
|
+
- `resolveReferenceFields` from `./utils` (local utility).
|
|
206
|
+
- Radio/Checkbox + FormControlLabel components.
|
|
207
|
+
- Card/CardContent components.
|
|
208
|
+
- Typography/text component.
|
|
209
|
+
|
|
210
|
+
## Design System Mapping
|
|
211
|
+
|
|
212
|
+
**UI control type:** Selectable card grid (radio or multi-select).
|
|
213
|
+
|
|
214
|
+
Listed design systems are examples only.
|
|
215
|
+
|
|
216
|
+
| Design System | Recommended Component |
|
|
217
|
+
|---|---|
|
|
218
|
+
| Default (CSS only) | Custom `<div>` cards with `<input type="radio/checkbox">` inside |
|
|
219
|
+
| MUI | `<Card>` + `<CardContent>` + `<FormControlLabel>` + `<Radio>`/`<Checkbox>` |
|
|
220
|
+
| Ant Design | Custom cards with `<Radio>`/`<Checkbox>` |
|
|
221
|
+
| Chakra UI | `<Box>` as card + `<Radio>`/`<Checkbox>` |
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: SemanticLink
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: SemanticLink
|
|
7
|
+
|
|
8
|
+
Clickable hyperlink that navigates to a referenced Pega case or data object using semantic URL resolution.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a clickable link (`<a>` or button-style link) that navigates to a Pega case or data object. Resolves the correct semantic URL based on whether the reference is a Case or Data type. Handles Ctrl/Meta+click for opening in a new tab. Shows `'--'` when no text is provided.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `SemanticLink`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Link-SemanticLink`
|
|
22
|
+
- **Registration key:** `SemanticLink` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Default | Description |
|
|
27
|
+
|------|------|---------|-------------|
|
|
28
|
+
| `text` | `string` | — | The visible link text; renders `'--'` if empty |
|
|
29
|
+
| `resourcePayload` | `any` | `{}` | Resource payload containing `caseClassName`, `resourceType`, etc. |
|
|
30
|
+
| `resourceParams` | `any` | `{}` | Resource parameters containing `workID` for case navigation |
|
|
31
|
+
| `previewKey` | `string \| null` | — | Case preview key for opening work item by handle |
|
|
32
|
+
| `onClick` | `(event) => void` | — | External click handler (received but not directly used — link has its own handler) |
|
|
33
|
+
| `testId` | `string` | `''` | Test identifier |
|
|
34
|
+
| `referenceType` | `string \| null` | — | `'DATA'` or case reference type |
|
|
35
|
+
| `dataRelationshipContext` | `string \| null` | `null` | Context for data relationship resolution |
|
|
36
|
+
| `contextPage` | `any` | — | Context page with `classID` |
|
|
37
|
+
|
|
38
|
+
## Behavioral Contract
|
|
39
|
+
|
|
40
|
+
### URL Resolution
|
|
41
|
+
|
|
42
|
+
**Step 1: Determine if this is a data reference:**
|
|
43
|
+
- `isData = false`
|
|
44
|
+
- `shouldTreatAsDataReference = !previewKey && resourcePayload.caseClassName` (non-preview, has class)
|
|
45
|
+
- If `contextPage?.classID`: override `resourcePayload.caseClassName = contextPage.classID`
|
|
46
|
+
- If `resourcePayload.caseClassName === WORKCLASS`: override with actual case class from `pConnect.getValue(CASE_INFO_CLASSID)`
|
|
47
|
+
|
|
48
|
+
**Step 2a: Data reference (`referenceType === 'DATA'` or `shouldTreatAsDataReference`):**
|
|
49
|
+
```
|
|
50
|
+
const dataRefContext = semanticUtils.getDataReferenceInfo(pConnect, dataRelationshipContext, contextPage)
|
|
51
|
+
dataViewName = dataRefContext.dataContext
|
|
52
|
+
payload = dataRefContext.dataContextParameters
|
|
53
|
+
isData = true
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Step 2b: Resource type DATA (`resourcePayload.resourceType === 'DATA'`):**
|
|
57
|
+
- Look up data page: `dataViewName = PCore.getDataTypeUtils().getLookUpDataPage(resourcePayload.className)`
|
|
58
|
+
- Look up page info and parameters
|
|
59
|
+
- Build `payload` from parameters by resolving property annotations
|
|
60
|
+
- `isData = true`
|
|
61
|
+
|
|
62
|
+
**Step 3: Build `linkURL`:**
|
|
63
|
+
- If `isData && dataViewName && payload`: `linkURL = PCore.getSemanticUrlUtils().getResolvedSemanticURL(ACTION_SHOWDATA, { pageName: 'pyDetails', dataViewName }, payload)`
|
|
64
|
+
- Else (case): fix `resourceParams.objectID` for empty workID edge case, then `linkURL = PCore.getSemanticUrlUtils().getResolvedSemanticURL(ACTION_OPENWORKBYHANDLE, resourcePayload, resourceParams)`
|
|
65
|
+
|
|
66
|
+
### Click Handler (`openLinkClick`)
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
function openLinkClick(e) {
|
|
70
|
+
if (!e.metaKey && !e.ctrlKey) {
|
|
71
|
+
e.preventDefault()
|
|
72
|
+
if (isData or shouldTreatAsDataReference) {
|
|
73
|
+
showDataAction()
|
|
74
|
+
} else if (previewKey) {
|
|
75
|
+
getPConnect().getActionsApi().openWorkByHandle(previewKey, resourcePayload.caseClassName)
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
// If metaKey/ctrlKey: allow default browser behavior (open in new tab)
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### `showDataAction()`
|
|
83
|
+
|
|
84
|
+
- If `dataResourcePayLoad.resourceType === 'DATA'`: call `getPConnect().getActionsApi().showData('pyDetails', lookUpDataPage, payload)`
|
|
85
|
+
- If `referenceType === DATA` or `shouldTreatAsDataReference`: call `showData('pyDetails', dataViewName, payload)`
|
|
86
|
+
|
|
87
|
+
## Display Mode Rendering
|
|
88
|
+
|
|
89
|
+
No explicit `displayMode` handling — `SemanticLink` is always rendered as a link. The parent (`ObjectReference`) controls whether to show it in display mode.
|
|
90
|
+
|
|
91
|
+
## Visual Specifications
|
|
92
|
+
|
|
93
|
+
Derived from `makeStyles` and MUI `Link` props:
|
|
94
|
+
|
|
95
|
+
| Property | Value |
|
|
96
|
+
|----------|-------|
|
|
97
|
+
| Display | Inline link (button role) |
|
|
98
|
+
| Padding | `8px` all sides |
|
|
99
|
+
| Margin | `8px` all sides |
|
|
100
|
+
| Color | Primary link color (blue, default theme) |
|
|
101
|
+
| Font weight | 400 |
|
|
102
|
+
| Underline | Default link underline on hover |
|
|
103
|
+
| Cursor | Pointer |
|
|
104
|
+
| Text | `text` prop value, or `'--'` if empty |
|
|
105
|
+
|
|
106
|
+
**CSS-only implementation:**
|
|
107
|
+
```css
|
|
108
|
+
.semantic-link {
|
|
109
|
+
display: inline-block;
|
|
110
|
+
padding: 8px;
|
|
111
|
+
margin: 8px;
|
|
112
|
+
color: #1976d2;
|
|
113
|
+
text-decoration: none;
|
|
114
|
+
cursor: pointer;
|
|
115
|
+
font-weight: 400;
|
|
116
|
+
background: none;
|
|
117
|
+
border: none;
|
|
118
|
+
font-size: inherit;
|
|
119
|
+
}
|
|
120
|
+
.semantic-link:hover { text-decoration: underline; }
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## Edge Cases & Special Logic
|
|
124
|
+
|
|
125
|
+
- **BUG-678282 fix:** When `resourceParams.workID === ''` and `previewKey` is a string, set `resourceParams.objectID = previewKey.split(' ')[1]` to handle cases where workID was not populated.
|
|
126
|
+
- If `previewKey` is set: also set `resourceParams.id = previewKey`.
|
|
127
|
+
- `linkURL` is computed synchronously at render — if an error occurs in data reference resolution, it is silently caught (`try/catch`) and `linkURL` remains `''`.
|
|
128
|
+
- `onClick` prop from parent is received but NOT used directly — the component has its own `openLinkClick`. Do not call the parent's `onClick` directly.
|
|
129
|
+
- **Ctrl/Meta+click**: `e.metaKey || e.ctrlKey` → don't `preventDefault()`, let the browser open the href in a new tab.
|
|
130
|
+
- `text || '--'` is always rendered — never renders empty.
|
|
131
|
+
|
|
132
|
+
## Dependencies
|
|
133
|
+
|
|
134
|
+
- `semanticUtils.getDataReferenceInfo(pConnect, dataRelationshipContext, contextPage)` from `./utils` (local).
|
|
135
|
+
- `PCore.getSemanticUrlUtils().getResolvedSemanticURL()` — URL resolution.
|
|
136
|
+
- `PCore.getSemanticUrlUtils().getActions()` — `ACTION_OPENWORKBYHANDLE`, `ACTION_SHOWDATA`.
|
|
137
|
+
- `PCore.getDataTypeUtils().getLookUpDataPage()`, `getLookUpDataPageInfo()`, `getDataPageKeys()`.
|
|
138
|
+
- `PCore.getAnnotationUtils().isProperty()`, `getPropertyName()`.
|
|
139
|
+
- `PCore.getConstants()` — `RESOURCE_TYPES.DATA`, `WORKCLASS`, `CASE_INFO.CASE_INFO_CLASSID`.
|
|
140
|
+
- A link/anchor component (e.g., MUI `<Link component='button'>`, or native `<a>`/`<button>`).
|
|
141
|
+
|
|
142
|
+
## Design System Mapping
|
|
143
|
+
|
|
144
|
+
**UI control type:** Clickable hyperlink (button or anchor with navigation behavior).
|
|
145
|
+
|
|
146
|
+
Listed design systems are examples only.
|
|
147
|
+
|
|
148
|
+
| Design System | Recommended Component |
|
|
149
|
+
|---|---|
|
|
150
|
+
| Default (CSS only) | `<button class="semantic-link">` with anchor styling |
|
|
151
|
+
| MUI | `<Link component='button'>` |
|
|
152
|
+
| Ant Design | `<Typography.Link>` or `<Button type="link">` |
|
|
153
|
+
| Chakra UI | `<Link as="button">` |
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: TextArea
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: TextArea
|
|
7
|
+
|
|
8
|
+
Multi-line text input field that binds to a Pega case property.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders an editable multi-line text area. Used for long-form text input such as descriptions, notes, or comments. Similar to `TextInput` but allows multiple lines with configurable min/max rows.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `TextArea`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Text` (multi-line)
|
|
22
|
+
- **Registration key:** `TextArea` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Description |
|
|
27
|
+
|------|------|-------------|
|
|
28
|
+
| `fieldMetadata` | `any` (optional) | Metadata object; used to read `maxLength` for the textarea |
|
|
29
|
+
|
|
30
|
+
All other props come from `PConnFieldProps`. Import type as:
|
|
31
|
+
```typescript
|
|
32
|
+
import type { PConnFieldProps } from '@pega/sdk-react';
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Behavioral Contract
|
|
36
|
+
|
|
37
|
+
1. **Local state:** Maintain `inputValue` in local state (string). Initialize to `''`.
|
|
38
|
+
2. **Sync from store:** `useEffect` watching `value` prop — call `setInputValue(value)` whenever `value` changes.
|
|
39
|
+
3. **On change:** Update local `inputValue` state only (do NOT commit to store on every keystroke).
|
|
40
|
+
4. **On blur:** Commit to store by calling `handleEvent(actions, 'changeNblur', propName, inputValue)`.
|
|
41
|
+
5. **Read-only:** Set `readOnly` attribute on the textarea; use visually borderless ("standard") variant. Omit `onBlur` handler: `onBlur={!readOnly ? handleBlur : undefined}`.
|
|
42
|
+
6. **maxLength:** Read from `fieldMetadata?.maxLength`; pass to the textarea's `maxLength` attribute.
|
|
43
|
+
7. **Row sizing:** Fixed at `minRows={5}` and `maxRows={5}` — the textarea does not auto-expand; it shows a scrollbar if content exceeds 5 rows.
|
|
44
|
+
|
|
45
|
+
## Display Mode Rendering
|
|
46
|
+
|
|
47
|
+
- **`DISPLAY_ONLY`:** Render `<FieldValueList name={hideLabel ? '' : label} value={value} />`.
|
|
48
|
+
- **`STACKED_LARGE_VAL`:** Render `<FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />`.
|
|
49
|
+
- Both modes short-circuit before interactive rendering.
|
|
50
|
+
|
|
51
|
+
## Read-Only Rendering
|
|
52
|
+
|
|
53
|
+
Set `readOnly` on the textarea element (NOT a read-only version via `TextInput` — preserves the multiline appearance). Switch to a flat/borderless visual style. The `minRows`/`maxRows` constraint is still applied in read-only.
|
|
54
|
+
|
|
55
|
+
## Visual Specifications
|
|
56
|
+
|
|
57
|
+
Derived from the reference component's MUI props:
|
|
58
|
+
|
|
59
|
+
| Property | Standard (editable) | Read-only |
|
|
60
|
+
|----------|---------------------|-----------|
|
|
61
|
+
| Width | 100% | 100% |
|
|
62
|
+
| Min rows | 5 | 5 |
|
|
63
|
+
| Max rows | 5 (scrollable beyond) | 5 |
|
|
64
|
+
| Border | 1px solid (outlined) | None (standard/flat) |
|
|
65
|
+
| Border radius | 4px | — |
|
|
66
|
+
| Label | Floating label | Floating label |
|
|
67
|
+
| Helper text | Below textarea | Below textarea |
|
|
68
|
+
| Error state | Red border + red helper text | — |
|
|
69
|
+
| Resize | Vertical resize handle (browser default) | Same |
|
|
70
|
+
| Font size | 0.875rem | 0.875rem |
|
|
71
|
+
| Padding | 8px 14px | — |
|
|
72
|
+
|
|
73
|
+
**CSS-only implementation notes:**
|
|
74
|
+
- `textarea { min-height: calc(5 * 1.4375em + 16px); max-height: calc(5 * 1.4375em + 16px); overflow-y: auto; resize: vertical; }`
|
|
75
|
+
- Error: `border-color: #d32f2f`
|
|
76
|
+
- Read-only: `border: none; background: transparent;`
|
|
77
|
+
|
|
78
|
+
## Edge Cases & Special Logic
|
|
79
|
+
|
|
80
|
+
- Unlike `TextInput`, do NOT delegate to `TextInput` in read-only mode — render the textarea directly with `readOnly` set, so the multi-line appearance is preserved.
|
|
81
|
+
- `maxLength` is optional; only apply the attribute if `fieldMetadata?.maxLength` is defined.
|
|
82
|
+
|
|
83
|
+
## Dependencies
|
|
84
|
+
|
|
85
|
+
- `handleEvent` from `../../helpers/event-utils`
|
|
86
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes
|
|
87
|
+
- No third-party UI libraries required
|
|
88
|
+
|
|
89
|
+
## Design System Mapping
|
|
90
|
+
|
|
91
|
+
**UI control type:** Multi-line text input (`<textarea>`).
|
|
92
|
+
|
|
93
|
+
Listed design systems are examples only.
|
|
94
|
+
|
|
95
|
+
| Design System | Recommended Component |
|
|
96
|
+
|---|---|
|
|
97
|
+
| Default (CSS only) | `<textarea rows="5">` with floating label |
|
|
98
|
+
| MUI | `<TextField multiline minRows={5} maxRows={5} />` |
|
|
99
|
+
| Ant Design | `<Input.TextArea rows={5} />` |
|
|
100
|
+
| Chakra UI | `<Textarea />` |
|
|
101
|
+
| Shadcn/ui | `<Textarea />` |
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: TextContent
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: TextContent
|
|
7
|
+
|
|
8
|
+
Static text display component that renders formatted text content (paragraph or heading). Non-interactive — no form binding.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Displays static, read-only text content. Used to embed headings or descriptive paragraph text within forms or views. Not an input field — does NOT bind to a case property value and does NOT use `PConnFieldProps`. It renders purely based on static configuration props.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `TextContent`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Text`
|
|
22
|
+
- **Registration key:** `TextContent` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
Extends `PConnProps` (NOT `PConnFieldProps` — there is no form value binding):
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import type { PConnProps } from '@pega/sdk-react';
|
|
30
|
+
|
|
31
|
+
interface TextContentProps extends PConnProps {
|
|
32
|
+
content: string;
|
|
33
|
+
displayAs: 'Paragraph' | 'Heading 1' | 'Heading 2' | 'Heading 3' | 'Heading 4';
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
| Prop | Type | Description |
|
|
38
|
+
|------|------|-------------|
|
|
39
|
+
| `content` | `string` | The text string to render |
|
|
40
|
+
| `displayAs` | `'Paragraph' \| 'Heading 1' \| 'Heading 2' \| 'Heading 3' \| 'Heading 4'` | How to render the text — maps to typography level |
|
|
41
|
+
|
|
42
|
+
## Behavioral Contract
|
|
43
|
+
|
|
44
|
+
1. **No state, no effects** — purely presentational. Render `content` using the appropriate typography element for `displayAs`.
|
|
45
|
+
2. **Mapping:**
|
|
46
|
+
- `'Paragraph'` → `<p>` / body text
|
|
47
|
+
- `'Heading 1'` → `<h1>`
|
|
48
|
+
- `'Heading 2'` → `<h2>`
|
|
49
|
+
- `'Heading 3'` → `<h3>`
|
|
50
|
+
- `'Heading 4'` → `<h4>`
|
|
51
|
+
3. **Fallthrough:** Log an error for unrecognized `displayAs` values and render nothing (or a default fallback).
|
|
52
|
+
|
|
53
|
+
## Display Mode Rendering
|
|
54
|
+
|
|
55
|
+
Not applicable — this component is display-only by nature. It does not accept a `displayMode` prop.
|
|
56
|
+
|
|
57
|
+
## Read-Only Rendering
|
|
58
|
+
|
|
59
|
+
Always read-only — there is no editable state.
|
|
60
|
+
|
|
61
|
+
## Visual Specifications
|
|
62
|
+
|
|
63
|
+
Derived from standard HTML typography:
|
|
64
|
+
|
|
65
|
+
| `displayAs` | Element | Font size | Font weight |
|
|
66
|
+
|-------------|---------|-----------|-------------|
|
|
67
|
+
| `Paragraph` | `<p>` / `body1` | 1rem (16px) | 400 |
|
|
68
|
+
| `Heading 1` | `<h1>` | 2.5rem | 300 |
|
|
69
|
+
| `Heading 2` | `<h2>` | 2rem | 300 |
|
|
70
|
+
| `Heading 3` | `<h3>` | 1.75rem | 400 |
|
|
71
|
+
| `Heading 4` | `<h4>` | 1.5rem | 400 |
|
|
72
|
+
|
|
73
|
+
Color inherits from the surrounding text color. No padding, margin, border, or background beyond what the browser/design-system applies to the heading element.
|
|
74
|
+
|
|
75
|
+
**CSS-only implementation notes:**
|
|
76
|
+
```css
|
|
77
|
+
.text-content-h1 { font-size: 2.5rem; font-weight: 300; }
|
|
78
|
+
.text-content-h2 { font-size: 2rem; font-weight: 300; }
|
|
79
|
+
.text-content-h3 { font-size: 1.75rem; font-weight: 400; }
|
|
80
|
+
.text-content-h4 { font-size: 1.5rem; font-weight: 400; }
|
|
81
|
+
.text-content-body { font-size: 1rem; font-weight: 400; }
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Edge Cases & Special Logic
|
|
85
|
+
|
|
86
|
+
- Unrecognized `displayAs` values should trigger a `console.error` and fall back to body text.
|
|
87
|
+
- No `handleEvent`, no store interaction, no `useEffect`.
|
|
88
|
+
|
|
89
|
+
## Dependencies
|
|
90
|
+
|
|
91
|
+
- No event utilities needed
|
|
92
|
+
- No `FieldValueList` needed
|
|
93
|
+
- Only a typography rendering element
|
|
94
|
+
|
|
95
|
+
## Design System Mapping
|
|
96
|
+
|
|
97
|
+
**UI control type:** Static typography / text block.
|
|
98
|
+
|
|
99
|
+
Listed design systems are examples only.
|
|
100
|
+
|
|
101
|
+
| Design System | Recommended Component |
|
|
102
|
+
|---|---|
|
|
103
|
+
| Default (CSS only) | Native `<h1>`–`<h4>` or `<p>` |
|
|
104
|
+
| MUI | `<Typography variant='h1' \| 'h2' \| 'h3' \| 'h4' \| 'body1'>` |
|
|
105
|
+
| Ant Design | `<Typography.Title level={1-4}>` or `<Typography.Text>` |
|
|
106
|
+
| Chakra UI | `<Heading as='h1'-'h4'>` or `<Text>` |
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: TextInput
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: TextInput
|
|
7
|
+
|
|
8
|
+
Single-line text input field that binds to a Pega case property.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a single-line editable text field. It is the simplest and most foundational field component — used directly for free-text string properties and also delegated to by other components (e.g., `Email`, `URL`, `Date` in read-only mode).
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `TextInput`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Text`
|
|
22
|
+
- **Registration key:** `TextInput` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Description |
|
|
27
|
+
|------|------|-------------|
|
|
28
|
+
| `fieldMetadata` | `any` (optional) | Metadata object; used to read `maxLength` for the input |
|
|
29
|
+
|
|
30
|
+
All other props come from `PConnFieldProps`. Import type as:
|
|
31
|
+
```typescript
|
|
32
|
+
import type { PConnFieldProps } from '@pega/sdk-react';
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Behavioral Contract
|
|
36
|
+
|
|
37
|
+
1. **Local state:** Maintain `inputValue` in local state (string). Initialize to `value` prop (`''` default).
|
|
38
|
+
2. **Sync from store:** `useEffect` watching `value` prop — call `setInputValue(value)` whenever `value` changes.
|
|
39
|
+
3. **On change:** Update local `inputValue` state only (do NOT commit to store on every keystroke).
|
|
40
|
+
4. **On blur:** Commit to store by calling `handleEvent(actions, 'changeNblur', propName, inputValue)`.
|
|
41
|
+
5. **Read-only:** Render input with `readOnly` attribute set; use a visually borderless ("standard") variant. Do NOT skip the blur handler when readOnly — simply omit it (`onBlur={!readOnly ? handleBlur : undefined}`).
|
|
42
|
+
6. **maxLength:** Read from `fieldMetadata?.maxLength`; pass to the underlying input's `maxLength` attribute.
|
|
43
|
+
7. **testId:** Pass as `data-test-id` attribute on the underlying `<input>` element.
|
|
44
|
+
|
|
45
|
+
## Display Mode Rendering
|
|
46
|
+
|
|
47
|
+
- **`DISPLAY_ONLY`:** Render `<FieldValueList name={hideLabel ? '' : label} value={value} />` — display raw string value, no formatting.
|
|
48
|
+
- **`STACKED_LARGE_VAL`:** Render `<FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />`.
|
|
49
|
+
- Both modes use `value` prop directly (not local state).
|
|
50
|
+
- Both modes short-circuit before any interactive rendering.
|
|
51
|
+
|
|
52
|
+
## Read-Only Rendering
|
|
53
|
+
|
|
54
|
+
Set the `readOnly` attribute on the underlying input element. Use a visually flat/borderless style (no border box). The editable `outlined` variant switches to a `standard` (no outline) variant when read-only.
|
|
55
|
+
|
|
56
|
+
## Visual Specifications
|
|
57
|
+
|
|
58
|
+
Derived from the reference component's MUI props and styles:
|
|
59
|
+
|
|
60
|
+
| Property | Standard (editable) | Read-only |
|
|
61
|
+
|----------|---------------------|-----------|
|
|
62
|
+
| Width | 100% of container | 100% of container |
|
|
63
|
+
| Height / size | Small (`height ~40px`) | Small |
|
|
64
|
+
| Border | 1px solid (outlined) | None (standard variant) |
|
|
65
|
+
| Border radius | 4px | — |
|
|
66
|
+
| Label | Floating label (above input when focused/filled) | Floating label |
|
|
67
|
+
| Helper text | Shown below input | Shown below input |
|
|
68
|
+
| Error state | Red border + red helper text | — |
|
|
69
|
+
| Disabled | Reduced opacity (~0.38), not-allowed cursor | — |
|
|
70
|
+
| Padding (input) | 8px 14px | — |
|
|
71
|
+
| Font size | 0.875rem (14px) | 0.875rem |
|
|
72
|
+
|
|
73
|
+
**CSS-only implementation notes:**
|
|
74
|
+
- Floating label: use `<label>` positioned absolutely, translate upward on `:focus-within` or when input has value.
|
|
75
|
+
- Error state: add `.error` class → border-color: `#d32f2f`; helper text color: `#d32f2f`.
|
|
76
|
+
- Outlined box shadow on focus: `0 0 0 2px rgba(25, 118, 210, 0.2)`.
|
|
77
|
+
|
|
78
|
+
## Edge Cases & Special Logic
|
|
79
|
+
|
|
80
|
+
- If `value` prop is `undefined`, default to `''` to keep the input controlled.
|
|
81
|
+
- If `readOnly` is true, the `onBlur` handler must be omitted — do not commit on blur for read-only.
|
|
82
|
+
- `maxLength` is optional; only apply the attribute if `fieldMetadata?.maxLength` is defined.
|
|
83
|
+
|
|
84
|
+
## Dependencies
|
|
85
|
+
|
|
86
|
+
- `handleEvent` from `../../helpers/event-utils` — for committing value to store.
|
|
87
|
+
- `getComponentFromRegistry('FieldValueList')` — for display modes.
|
|
88
|
+
- No third-party UI libraries required beyond a basic text input element.
|
|
89
|
+
|
|
90
|
+
## Design System Mapping
|
|
91
|
+
|
|
92
|
+
**UI control type:** Single-line text input (`<input type="text">`).
|
|
93
|
+
|
|
94
|
+
Listed design systems are examples only.
|
|
95
|
+
|
|
96
|
+
| Design System | Recommended Component |
|
|
97
|
+
|---|---|
|
|
98
|
+
| Default (CSS only) | `<input type="text">` with floating label pattern |
|
|
99
|
+
| MUI | `<TextField variant='outlined' size='small' fullWidth />` |
|
|
100
|
+
| Ant Design | `<Input />` |
|
|
101
|
+
| Chakra UI | `<Input />` |
|
|
102
|
+
| Shadcn/ui | `<Input />` |
|
|
103
|
+
|
|
104
|
+
When implementing in a specific design system, map the following behaviors:
|
|
105
|
+
- `error={status === 'error'}` → error/danger variant
|
|
106
|
+
- `helperText` → helper/description slot below the input
|
|
107
|
+
- `label` → field label (floating or static depending on design system)
|
|
108
|
+
- `disabled` → disabled prop
|
|
109
|
+
- `required` → required/asterisk indicator
|