@pega/sdk 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +2 -2
- package/package.json +1 -1
- package/templates/react-sdk-reference/.claude/instructions/component-map.md +38 -0
- package/templates/react-sdk-reference/.claude/instructions/dse-component.md +75 -0
- package/templates/react-sdk-reference/.claude/instructions/field-component.md +71 -0
- package/templates/react-sdk-reference/.claude/instructions/template-component.md +92 -0
- package/templates/react-sdk-reference/.claude/instructions/widget-component.md +87 -0
- package/templates/react-sdk-reference/.claude/prompts/add-component.md +144 -0
- package/templates/react-sdk-reference/.claude/prompts/component-manifest.json +111 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-all-components.md +149 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-dse-components.md +126 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-field-components.md +139 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-template-components.md +151 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-widget-components.md +124 -0
- package/templates/react-sdk-reference/.claude/prompts/identify-components.md +105 -0
- package/templates/react-sdk-reference/.claude/prompts/replace-design-system.md +519 -0
- package/templates/react-sdk-reference/.claude/skills/component-contracts.md +140 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/AlertBanner.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Banner.md +149 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/CaseSummaryFields.md +154 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/DetailsFields.md +144 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroup.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroupList.md +111 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldValueList.md +115 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Operator.md +149 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Pulse.md +83 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/RichTextEditor.md +206 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/WssQuickCreate.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension.md +289 -0
- package/templates/react-sdk-reference/.claude/skills/field-components.md +294 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/AutoComplete.md +112 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/CancelAlert.md +203 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Checkbox.md +158 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Currency.md +106 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Date.md +99 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/DateTime.md +103 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Decimal.md +98 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Dropdown.md +114 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Email.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Group.md +90 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Integer.md +87 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Location.md +136 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Multiselect.md +164 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/ObjectReference.md +164 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Percentage.md +92 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Phone.md +110 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/RadioButtons.md +146 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/RichText.md +138 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/ScalarList.md +124 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/SelectableCard.md +216 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/SemanticLink.md +148 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextArea.md +96 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextContent.md +101 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextInput.md +104 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Time.md +88 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/URL.md +85 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/UserReference.md +180 -0
- package/templates/react-sdk-reference/.claude/skills/run-and-verify.md +68 -0
- package/templates/react-sdk-reference/.claude/skills/template-components.md +322 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/AdvancedSearch.md +144 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/AppShell.md +122 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/BannerPage.md +83 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseSummary.md +100 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseView.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseViewActionsMenu.md +126 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/Confirmation.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DataReference.md +120 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultForm.md +102 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultPage.md +110 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/Details.md +88 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsSubTabs.md +95 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsThreeColumn.md +78 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsTwoColumn.md +78 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DynamicTabs.md +101 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/FieldGroupTemplate.md +109 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/HierarchicalForm.md +113 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboard.md +104 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboardPage.md +85 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/ListPage.md +68 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/ListView.md +139 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/MultiReferenceReadOnly.md +80 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/NarrowWide.md +141 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/OneColumn.md +109 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/PromotedFilters.md +124 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SelfServiceCaseView.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SimpleTable.md +127 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SingleReferenceReadOnly.md +103 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SubTabs.md +79 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/TwoColumn.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/WideNarrow.md +150 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/WssNavBar.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/widget-components.md +271 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/AppAnnouncement.md +82 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/Attachment.md +146 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/CaseHistory.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/FileUtility.md +200 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/Followers.md +99 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/QuickCreate.md +114 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/SummaryItem.md +167 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/ToDo.md +190 -0
- package/templates/react-sdk-reference/.cursor/rules/component-map.mdrules +41 -0
- package/templates/react-sdk-reference/.cursor/rules/dse-component.mdrules +78 -0
- package/templates/react-sdk-reference/.cursor/rules/field-component.mdrules +74 -0
- package/templates/react-sdk-reference/.cursor/rules/pega-sdk.mdrules +247 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/add-component.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/component-manifest.json +111 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-all-components.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-dse-components.mdrules +131 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-field-components.mdrules +144 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-template-components.mdrules +156 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-widget-components.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/identify-components.mdrules +110 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/replace-design-system.mdrules +524 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/component-contracts.mdrules +145 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/AlertBanner.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Banner.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/CaseSummaryFields.mdrules +159 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/DetailsFields.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroup.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroupList.mdrules +116 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldValueList.mdrules +120 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Operator.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Pulse.mdrules +88 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/RichTextEditor.mdrules +211 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/WssQuickCreate.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension.mdrules +294 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-components.mdrules +299 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/AutoComplete.mdrules +117 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/CancelAlert.mdrules +208 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Checkbox.mdrules +163 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Currency.mdrules +111 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Date.mdrules +104 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/DateTime.mdrules +108 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Decimal.mdrules +103 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Dropdown.mdrules +119 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Email.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Group.mdrules +95 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Integer.mdrules +92 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Location.mdrules +141 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Multiselect.mdrules +169 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ObjectReference.mdrules +169 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Percentage.mdrules +97 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Phone.mdrules +115 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RadioButtons.mdrules +151 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RichText.mdrules +143 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ScalarList.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SelectableCard.mdrules +221 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SemanticLink.mdrules +153 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextArea.mdrules +101 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextContent.mdrules +106 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextInput.mdrules +109 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Time.mdrules +93 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/URL.mdrules +90 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/UserReference.mdrules +185 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/run-and-verify.mdrules +73 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-components.mdrules +327 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AdvancedSearch.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AppShell.mdrules +127 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/BannerPage.mdrules +88 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseSummary.mdrules +105 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseView.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseViewActionsMenu.mdrules +131 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Confirmation.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DataReference.mdrules +125 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultForm.mdrules +107 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultPage.mdrules +115 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Details.mdrules +93 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsSubTabs.mdrules +100 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsThreeColumn.mdrules +83 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsTwoColumn.mdrules +83 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DynamicTabs.mdrules +106 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/FieldGroupTemplate.mdrules +114 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/HierarchicalForm.mdrules +118 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboard.mdrules +109 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboardPage.mdrules +90 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListPage.mdrules +73 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListView.mdrules +144 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/MultiReferenceReadOnly.mdrules +85 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/NarrowWide.mdrules +146 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/OneColumn.mdrules +114 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/PromotedFilters.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SelfServiceCaseView.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SimpleTable.mdrules +132 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SingleReferenceReadOnly.mdrules +108 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SubTabs.mdrules +84 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/TwoColumn.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WideNarrow.mdrules +155 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WssNavBar.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-components.mdrules +276 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/AppAnnouncement.mdrules +87 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Attachment.mdrules +151 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/CaseHistory.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/FileUtility.mdrules +205 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Followers.mdrules +104 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/QuickCreate.mdrules +119 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/SummaryItem.mdrules +172 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/ToDo.mdrules +195 -0
- package/templates/react-sdk-reference/.cursor/rules/template-component.mdrules +95 -0
- package/templates/react-sdk-reference/.cursor/rules/widget-component.mdrules +90 -0
- package/templates/react-sdk-reference/.github/copilot-instructions.md +58 -0
- package/templates/react-sdk-reference/.github/prompts/add-component.prompt.md +144 -16
- package/templates/react-sdk-reference/.github/prompts/generate-all-components.prompt.md +154 -0
- package/templates/react-sdk-reference/.github/prompts/generate-dse-components.prompt.md +131 -0
- package/templates/react-sdk-reference/.github/prompts/generate-field-components.prompt.md +144 -0
- package/templates/react-sdk-reference/.github/prompts/generate-template-components.prompt.md +156 -0
- package/templates/react-sdk-reference/.github/prompts/generate-widget-components.prompt.md +129 -0
- package/templates/react-sdk-reference/.github/skills/design-system-extension.md +58 -18
- package/templates/react-sdk-reference/.github/skills/field-components.md +55 -23
- package/templates/react-sdk-reference/.github/skills/template-components.md +48 -11
- package/templates/react-sdk-reference/.github/skills/widget-components.md +49 -12
- package/templates/react-sdk-reference/AGENTS.md +217 -29
- package/templates/react-sdk-reference/package.json +1 -1
- package/templates/react-sdk-reference/pega-constellationjs-0.26.3-local.tgz +0 -0
- package/templates/react-sdk-reference/pega-sdk-react-0.1.0.tgz +0 -0
- package/templates/react-sdk-reference/sdk-config.json +1 -1
- package/templates/react-sdk-reference/vite.config.ts +1 -1
- package/templates/react-sdk-reference/.github/prompts/replace-all-fields.prompt.md +0 -48
- package/templates/react-sdk-reference/.github/prompts/replace-component.prompt.md +0 -81
- package/templates/react-sdk-reference/.github/prompts/replace-field.prompt.md +0 -41
- package/templates/react-sdk-reference/.github/prompts/swap-design-system.prompt.md +0 -49
- package/templates/react-sdk-reference/.github/skills/swap-design-system.md +0 -105
- package/templates/react-sdk-reference/pega-constellationjs-0.26.2.tgz +0 -0
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# Skill: RichText
|
|
2
|
+
|
|
3
|
+
Rich text editor field with HTML content support, binds to a Pega case property.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a rich text (WYSIWYG) editor for HTML content. Uses a registry-resolved `RichTextEditor` component. Handles both read-only and editable states. Commits HTML content on blur by reading from the editor's internal ref.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `RichText`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Text-RichText`
|
|
17
|
+
- **Registration key:** `RichText` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Description |
|
|
22
|
+
|------|------|-------------|
|
|
23
|
+
| `additionalProps` | `object` (optional) | Extra props forwarded to the `RichTextEditor` |
|
|
24
|
+
|
|
25
|
+
## Behavioral Contract
|
|
26
|
+
|
|
27
|
+
1. **Editor ref:** Maintain an `editorRef` (via `useRef`) — the editor exposes its content via `editorRef.current.getContent({ format: 'html' })`.
|
|
28
|
+
2. **No local state** — unlike text inputs, value is NOT tracked in local state. The editor manages its own internal content via `defaultValue`.
|
|
29
|
+
3. **Props coercion:** `readOnly`, `required`, `disabled` must be coerced to booleans:
|
|
30
|
+
```typescript
|
|
31
|
+
[readOnly, required, disabled] = [readOnly, required, disabled].map(
|
|
32
|
+
prop => prop === true || (typeof prop === 'string' && prop === 'true')
|
|
33
|
+
)
|
|
34
|
+
```
|
|
35
|
+
4. **Editable mode:**
|
|
36
|
+
- Track `status` for error state.
|
|
37
|
+
- **On change:** If `status === 'error'`, clear error messages via:
|
|
38
|
+
```
|
|
39
|
+
pConn.clearErrorMessages({ property, category: '', context: '' })
|
|
40
|
+
```
|
|
41
|
+
- **On blur:** Read HTML from editor ref and commit:
|
|
42
|
+
```
|
|
43
|
+
const editorValue = editorRef.current.getContent({ format: 'html' })
|
|
44
|
+
handleEvent(actionsApi, 'changeNblur', property, editorValue)
|
|
45
|
+
```
|
|
46
|
+
5. **Read-only mode:** Render `RichTextEditor` with `readOnly` prop only — no `onChange`/`onBlur`.
|
|
47
|
+
6. **`RichTextEditor` component:** Resolved via `getComponentFromRegistry('RichTextEditor')`. This is a design-system extension component that wraps the actual WYSIWYG library (e.g., TinyMCE).
|
|
48
|
+
|
|
49
|
+
### Editable RichTextEditor props
|
|
50
|
+
```
|
|
51
|
+
label, labelHidden={hideLabel}, info={helperTextToDisplay}, defaultValue={value},
|
|
52
|
+
placeholder, disabled, required, testId, ref={editorRef},
|
|
53
|
+
error={status === 'error'}, onBlur={handleBlur}, onChange={handleChange}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Read-only RichTextEditor props
|
|
57
|
+
```
|
|
58
|
+
label, labelHidden={hideLabel}, defaultValue={value}, testId, info={helperTextToDisplay},
|
|
59
|
+
ref={editorRef}, readOnly
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Display Mode Rendering
|
|
63
|
+
|
|
64
|
+
Display modes pass `isHtml={true}` to render HTML content safely:
|
|
65
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={value} isHtml />`
|
|
66
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={value} isHtml variant='stacked' />`
|
|
67
|
+
|
|
68
|
+
## Read-Only Rendering
|
|
69
|
+
|
|
70
|
+
Render `RichTextEditor` with `readOnly` prop. Uses same `editorRef`.
|
|
71
|
+
|
|
72
|
+
## Visual Specifications
|
|
73
|
+
|
|
74
|
+
The visual appearance of the rich text editor depends on the underlying `RichTextEditor` implementation. The reference implementation uses TinyMCE theming via CSS variables:
|
|
75
|
+
|
|
76
|
+
```css
|
|
77
|
+
/* RichText.css — must be imported */
|
|
78
|
+
.tox .tox-toolbar { background-color: var(--app-background-color) !important; }
|
|
79
|
+
.tox .tox-toolbar__primary { background-color: var(--app-background-color) !important; }
|
|
80
|
+
.tox .tox-toolbar__button { color: var(--app-text-color) !important; }
|
|
81
|
+
.tox .tox-toolbar__button--enabled {
|
|
82
|
+
background: var(--app-primary-color) !important;
|
|
83
|
+
color: #fff !important;
|
|
84
|
+
}
|
|
85
|
+
.tox .tox-dialog {
|
|
86
|
+
background-color: var(--modal-top-color) !important;
|
|
87
|
+
color: var(--app-text-color) !important;
|
|
88
|
+
border: 1px solid var(--modal-border-color) !important;
|
|
89
|
+
padding: 20px !important;
|
|
90
|
+
box-shadow: 0 0 10px 3px var(--modal-box-shadow-color) !important;
|
|
91
|
+
}
|
|
92
|
+
.tox .tox-dialog__header {
|
|
93
|
+
background-color: var(--modal-top-color) !important;
|
|
94
|
+
color: var(--app-text-color) !important;
|
|
95
|
+
font-weight: 500;
|
|
96
|
+
border-bottom: 1px solid var(--modal-border-color);
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Note:** Import `./RichText.css` in the component file. The CSS variables (`--app-background-color`, `--app-text-color`, etc.) are set by the application theme.
|
|
101
|
+
|
|
102
|
+
When implementing with a different design system:
|
|
103
|
+
- Custom CSS for toolbar theming may be needed
|
|
104
|
+
- The editor container should be full-width
|
|
105
|
+
- Minimum height: ~200px for a usable editing area
|
|
106
|
+
|
|
107
|
+
## Edge Cases & Special Logic
|
|
108
|
+
|
|
109
|
+
- **Props coercion to boolean:** Pega may pass these props as strings (`'true'`/`'false'`) — always coerce.
|
|
110
|
+
- **On blur, NOT on change:** Content is committed to the store only on blur (when user leaves the editor), not on every keystroke.
|
|
111
|
+
- **Error clearing:** When `status === 'error'`, the `onChange` handler clears the error message from Pega so it doesn't persist after the user starts editing.
|
|
112
|
+
- **`editorRef.current.getContent`:** This is specific to the TinyMCE API. For other rich text libraries, use the equivalent method to get HTML content.
|
|
113
|
+
- **`FieldValueList` with `isHtml`:** The display mode renders HTML — ensure XSS protection in the `FieldValueList` component (use `dangerouslySetInnerHTML` only with sanitization, or a trusted HTML renderer).
|
|
114
|
+
|
|
115
|
+
## Dependencies
|
|
116
|
+
|
|
117
|
+
- `getComponentFromRegistry('RichTextEditor')` — the actual editor widget (e.g., TinyMCE wrapper).
|
|
118
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
119
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
120
|
+
- `./RichText.css` — must be imported for TinyMCE toolbar theming.
|
|
121
|
+
- `useRef` from React.
|
|
122
|
+
|
|
123
|
+
**For other rich text editors:**
|
|
124
|
+
- Any WYSIWYG editor that exposes `ref.current.getContent()` or equivalent.
|
|
125
|
+
- Examples: Quill, Draft.js, Slate.js, CKEditor.
|
|
126
|
+
|
|
127
|
+
## Design System Mapping
|
|
128
|
+
|
|
129
|
+
**UI control type:** WYSIWYG rich text editor (HTML content).
|
|
130
|
+
|
|
131
|
+
Listed design systems are examples only.
|
|
132
|
+
|
|
133
|
+
| Design System | Recommended Component |
|
|
134
|
+
|---|---|
|
|
135
|
+
| Default (CSS only) | `contenteditable` div + custom toolbar OR TinyMCE |
|
|
136
|
+
| MUI | `RichTextEditor` custom extension (TinyMCE) |
|
|
137
|
+
| Ant Design | Quill or TinyMCE with Ant styling |
|
|
138
|
+
| Chakra UI | Quill or TipTap with Chakra styling |
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# Skill: ScalarList
|
|
2
|
+
|
|
3
|
+
Read-only display component that renders a list of scalar values by creating a child component for each item.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a list of scalar (primitive) values by dynamically creating a child component of a specified type for each item. Used for read-only display of list-type properties. Not an editable input.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `ScalarList`
|
|
16
|
+
- **Type / Subtype:** `Field` / `ScalarList`
|
|
17
|
+
- **Registration key:** `ScalarList` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
> ScalarList uses `PConnProps` (NOT `PConnFieldProps`) because its `value` is an array, not a string:
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import type { PConnProps } from '@pega/sdk-react';
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
| Prop | Type | Description |
|
|
28
|
+
|------|------|-------------|
|
|
29
|
+
| `value` | `any[]` | Array of scalar values to display |
|
|
30
|
+
| `componentType` | `string` | The Pega component type to use for each item (e.g., `'TextInput'`, `'Date'`) |
|
|
31
|
+
| `label` | `string` | Field label |
|
|
32
|
+
| `displayMode` | `string` | Display mode |
|
|
33
|
+
| `hideLabel` | `boolean` | Whether to hide the label |
|
|
34
|
+
| `displayInModal` | `boolean` | Whether this is displayed in a modal context |
|
|
35
|
+
|
|
36
|
+
All remaining props (`...restProps`) are forwarded to each child component.
|
|
37
|
+
|
|
38
|
+
## Behavioral Contract
|
|
39
|
+
|
|
40
|
+
1. **No state, no event handling** — purely display/read-only.
|
|
41
|
+
2. **Item rendering:** Map each value in `scalarValues` to a component via `getPConnect().createComponent(...)`:
|
|
42
|
+
```typescript
|
|
43
|
+
const items = scalarValues?.map(scalarValue =>
|
|
44
|
+
getPConnect().createComponent(
|
|
45
|
+
{
|
|
46
|
+
type: componentType,
|
|
47
|
+
config: {
|
|
48
|
+
value: scalarValue,
|
|
49
|
+
displayMode: 'DISPLAY_ONLY',
|
|
50
|
+
label,
|
|
51
|
+
...restProps,
|
|
52
|
+
readOnly: 'true'
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
'', // 2nd arg: empty string
|
|
56
|
+
'', // 3rd arg: empty string
|
|
57
|
+
{} // 4th arg: empty object
|
|
58
|
+
)
|
|
59
|
+
)
|
|
60
|
+
```
|
|
61
|
+
3. **`CommaSeparatedList` sub-component:** A local component that renders items as `<span>` elements inside a `<ul>` with no list styling:
|
|
62
|
+
```html
|
|
63
|
+
<ul style="padding: 0; margin: 0;">
|
|
64
|
+
<span>item1</span>
|
|
65
|
+
<span>item2</span>
|
|
66
|
+
...
|
|
67
|
+
</ul>
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Display Mode Rendering
|
|
71
|
+
|
|
72
|
+
**`STACKED_LARGE_VAL` or `DISPLAY_ONLY`:**
|
|
73
|
+
```html
|
|
74
|
+
<div>
|
|
75
|
+
<CommaSeparatedList items={items} />
|
|
76
|
+
</div>
|
|
77
|
+
```
|
|
78
|
+
No `FieldValueList` wrapper in these modes — the items are rendered directly.
|
|
79
|
+
|
|
80
|
+
**Default (no display mode):**
|
|
81
|
+
```
|
|
82
|
+
<FieldValueList name={hideLabel ? '' : label} value={<CommaSeparatedList items={items} />} variant='stacked' />
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Visual Specifications
|
|
86
|
+
|
|
87
|
+
| Property | Value |
|
|
88
|
+
|----------|-------|
|
|
89
|
+
| List style | No bullets, no padding, no margin on `<ul>` |
|
|
90
|
+
| Item display | Each item rendered as `<span>` (inline) |
|
|
91
|
+
| Separator | Items are adjacent spans (no comma separator despite the name) |
|
|
92
|
+
| Layout | Vertical stack when wrapped in `FieldValueList variant='stacked'` |
|
|
93
|
+
|
|
94
|
+
**CSS-only notes:**
|
|
95
|
+
```css
|
|
96
|
+
.scalar-list { list-style: none; padding: 0; margin: 0; }
|
|
97
|
+
.scalar-list-item { display: inline; }
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Edge Cases & Special Logic
|
|
101
|
+
|
|
102
|
+
- `scalarValues` may be `undefined` — the `?.map()` safely returns `undefined`; ensure null-check before rendering.
|
|
103
|
+
- Each child component is created with `displayMode: 'DISPLAY_ONLY'` and `readOnly: 'true'` (as string) — the read-only is passed as a string, not boolean.
|
|
104
|
+
- `restProps` includes all remaining props from the parent beyond the destructured ones — these are forwarded to each child component config.
|
|
105
|
+
- `createComponent` takes 4 args — 2nd, 3rd, 4th are empty string/object as the typedef marks them optional.
|
|
106
|
+
|
|
107
|
+
## Dependencies
|
|
108
|
+
|
|
109
|
+
- `getComponentFromRegistry('FieldValueList')` for default display.
|
|
110
|
+
- `getPConnect().createComponent()` — for creating each child component.
|
|
111
|
+
- No `handleEvent` — read-only component.
|
|
112
|
+
|
|
113
|
+
## Design System Mapping
|
|
114
|
+
|
|
115
|
+
**UI control type:** Read-only list of scalar values.
|
|
116
|
+
|
|
117
|
+
Listed design systems are examples only.
|
|
118
|
+
|
|
119
|
+
| Design System | Recommended Component |
|
|
120
|
+
|---|---|
|
|
121
|
+
| Default (CSS only) | `<ul>` with `<span>` items |
|
|
122
|
+
| MUI | `<List>` with `<ListItem>` or just `<Typography>` per item |
|
|
123
|
+
| Ant Design | `<List>` items or `<Space>` with `<Tag>` |
|
|
124
|
+
| Chakra UI | `<List>` or `<HStack>` with `<Tag>` |
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
# Skill: SelectableCard
|
|
2
|
+
|
|
3
|
+
Card-style radio or checkbox selection grid with optional image support.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
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').
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `SelectableCard`
|
|
16
|
+
- **Type / Subtype:** Internal design system extension
|
|
17
|
+
- **Registration key:** `SelectableCard` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
> 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`.
|
|
20
|
+
|
|
21
|
+
## Props
|
|
22
|
+
|
|
23
|
+
| Prop | Type | Default | Description |
|
|
24
|
+
|------|------|---------|-------------|
|
|
25
|
+
| `getPConnect` | `function` | — | PConnect accessor |
|
|
26
|
+
| `type` | `'radio' \| 'checkbox'` | — | Selection type |
|
|
27
|
+
| `image` | `object` | — | `{ imagePosition, imageSize, showImageDescription, imageField, imageDescription }` |
|
|
28
|
+
| `dataSource` | `any` | — | Source of card data (in editable mode) |
|
|
29
|
+
| `recordKey` | `string` | `''` | The key field name in each record (e.g., `'pyID'`) |
|
|
30
|
+
| `className` | `string` | — | CSS class for the card |
|
|
31
|
+
| `cardLabel` | `string` | — | The field name to use as card title |
|
|
32
|
+
| `hideFieldLabels` | `boolean` | `false` | Hide field labels inside cards |
|
|
33
|
+
| `readOnly` | `boolean` | — | Read-only mode |
|
|
34
|
+
| `disabled` | `boolean` | — | Disabled state |
|
|
35
|
+
| `readOnlyList` | `any[]` | `[]` | Selected items for read-only display |
|
|
36
|
+
| `displayMode` | `string` | — | Display mode string |
|
|
37
|
+
| `radioBtnValue` | `any` | — | Currently selected value (radio mode) |
|
|
38
|
+
| `onChange` | `function` | — | Change handler |
|
|
39
|
+
| `onBlur` | `function` | — | Blur handler |
|
|
40
|
+
| `onClick` | `function` | — | Click handler |
|
|
41
|
+
| `onKeyDown` | `function` | — | KeyDown handler |
|
|
42
|
+
| `additionalProps` | `any` | — | Spread onto the radio/checkbox input |
|
|
43
|
+
| `testId` | `string` | — | Test identifier |
|
|
44
|
+
| `setIsRadioCardSelected` | `function` | — | Callback to inform parent whether radio selection matched |
|
|
45
|
+
| `showNoValue` | `boolean` | `false` | When true (read-only + no selected items), render "No Value" text |
|
|
46
|
+
|
|
47
|
+
## Behavioral Contract
|
|
48
|
+
|
|
49
|
+
### Data source selection
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
cardDataSource = (readOnly || displayMode === 'DISPLAY_ONLY')
|
|
53
|
+
? readOnlyList || []
|
|
54
|
+
: dataSource?.source
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### "No Value" guard
|
|
58
|
+
|
|
59
|
+
If `showNoValue`: render a plain text element showing `'No Value'` and return early.
|
|
60
|
+
|
|
61
|
+
### Card click handler
|
|
62
|
+
|
|
63
|
+
Cards should be clickable anywhere (not just on the checkbox/radio):
|
|
64
|
+
```typescript
|
|
65
|
+
const handleCardClick = (event) => {
|
|
66
|
+
if (disabled || readOnly) return
|
|
67
|
+
if (event.target.closest('label, input')) return // native click already handled
|
|
68
|
+
const input = event.currentTarget.querySelector('input[type="radio"], input[type="checkbox"]')
|
|
69
|
+
if (input) input.click()
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Subsection: Display mode (`displayMode === 'DISPLAY_ONLY'`)
|
|
74
|
+
|
|
75
|
+
Render a **simple read-only card** (no radio/checkbox) with:
|
|
76
|
+
- Optional image (`<img>`)
|
|
77
|
+
- Card title: `item[cardLabel]`
|
|
78
|
+
- Additional resolved fields (from `resolveReferenceFields`)
|
|
79
|
+
- `style: { display: 'flex' }`
|
|
80
|
+
|
|
81
|
+
```html
|
|
82
|
+
<Card style="display: flex">
|
|
83
|
+
{image && <img src="..." alt="..." style="width: 100px">}
|
|
84
|
+
<CardContent>
|
|
85
|
+
<body1>{item[cardLabel]}</body1>
|
|
86
|
+
{fields.map(field => <body2>{field.value}</body2>)}
|
|
87
|
+
</CardContent>
|
|
88
|
+
</Card>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Subsection: Editable mode (radio or checkbox)
|
|
92
|
+
|
|
93
|
+
Render a **selectable card** with click handler, containing the appropriate input:
|
|
94
|
+
|
|
95
|
+
```html
|
|
96
|
+
<div style="paddingTop: 15px">
|
|
97
|
+
<Card style="cursor: pointer, height: 100%, flexDirection: column"
|
|
98
|
+
onClick={handleCardClick}>
|
|
99
|
+
<CardContent style={imageLayoutStyle}>
|
|
100
|
+
<!-- Image section (40% width for inline positions) -->
|
|
101
|
+
{image && <img full-width, aspect-ratio 16/9, contain>}
|
|
102
|
+
<!-- Content section (60% width for inline positions) -->
|
|
103
|
+
{type === 'radio'
|
|
104
|
+
? <FormControlLabel control={<Radio value={item[recordKey]} checked={radioBtnValue === item[recordKey]} onChange={onChange} ... />} label={item[cardLabel]}>
|
|
105
|
+
: <FormControlLabel control={<Checkbox id={item[recordKey]} checked={readOnlyList.some(d => d[recordKey] === item[recordKey])} onChange={onChange} ... />} label={item[cardLabel]}>
|
|
106
|
+
}
|
|
107
|
+
{fields.map(field => <div style={fieldLayoutStyle}>{field.name && <div>{field.name}</div>}<div>{field.value}</div></div>)}
|
|
108
|
+
</CardContent>
|
|
109
|
+
</Card>
|
|
110
|
+
</div>
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Image layout (inline positions)
|
|
114
|
+
|
|
115
|
+
| `imagePosition` | CardContent style | Image section width | Content section width |
|
|
116
|
+
|-----------------|-------------------|--------------------|----------------------|
|
|
117
|
+
| `'inline-start'` | `display: flex` | 40% | 60% |
|
|
118
|
+
| `'inline-end'` | `display: flex, flexDirection: row-reverse` | 40% | 60% |
|
|
119
|
+
| block (default) | default | full width | full width |
|
|
120
|
+
|
|
121
|
+
### Image element
|
|
122
|
+
|
|
123
|
+
```css
|
|
124
|
+
img {
|
|
125
|
+
width: 100%;
|
|
126
|
+
background-color: transparent;
|
|
127
|
+
aspect-ratio: 16 / 9;
|
|
128
|
+
max-height: 100%;
|
|
129
|
+
height: 100%;
|
|
130
|
+
object-fit: contain;
|
|
131
|
+
max-width: 100%;
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Field display layout
|
|
136
|
+
|
|
137
|
+
Each additional field in editable mode:
|
|
138
|
+
```css
|
|
139
|
+
.card-field {
|
|
140
|
+
font-size: 0.875rem;
|
|
141
|
+
display: grid; /* only if type !== 'TextArea' */
|
|
142
|
+
grid-template-columns: 1fr 1fr;
|
|
143
|
+
margin: 5px;
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Radio tracking
|
|
148
|
+
|
|
149
|
+
After iterating cards, if `type === 'radio'` and `setIsRadioCardSelected`:
|
|
150
|
+
```
|
|
151
|
+
if (radioBtnValue === item[recordKey]) radioItemSelected = true
|
|
152
|
+
// After loop:
|
|
153
|
+
setIsRadioCardSelected(radioItemSelected)
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Display Mode Rendering
|
|
157
|
+
|
|
158
|
+
`displayMode === 'DISPLAY_ONLY'`: renders simple read-only cards (no radio/checkbox inputs). Uses `readOnlyList` as the data source.
|
|
159
|
+
|
|
160
|
+
## Visual Specifications
|
|
161
|
+
|
|
162
|
+
| Property | Editable card | Display-only card |
|
|
163
|
+
|----------|--------------|-------------------|
|
|
164
|
+
| Cursor | `pointer` (unless disabled/readOnly → `default`) | Default |
|
|
165
|
+
| Height | `100%` (fills grid row) | Auto |
|
|
166
|
+
| Layout | Column flex | Row flex |
|
|
167
|
+
| Padding top | 15px wrapper | — |
|
|
168
|
+
| Image (display-only) | 100px fixed width | 100px fixed width |
|
|
169
|
+
| Card border | Default (design-system card elevation) | Default |
|
|
170
|
+
| Disabled | `cursor: default` | — |
|
|
171
|
+
|
|
172
|
+
**CSS-only card implementation:**
|
|
173
|
+
```css
|
|
174
|
+
.selectable-card {
|
|
175
|
+
border: 1px solid rgba(0,0,0,0.12);
|
|
176
|
+
border-radius: 4px;
|
|
177
|
+
padding: 16px;
|
|
178
|
+
cursor: pointer;
|
|
179
|
+
display: flex;
|
|
180
|
+
flex-direction: column;
|
|
181
|
+
height: 100%;
|
|
182
|
+
margin-top: 15px;
|
|
183
|
+
transition: border-color 0.2s;
|
|
184
|
+
}
|
|
185
|
+
.selectable-card:hover { border-color: #1976d2; }
|
|
186
|
+
.selectable-card.disabled { cursor: default; opacity: 0.7; }
|
|
187
|
+
.selectable-card.readonly { cursor: default; }
|
|
188
|
+
.selectable-card-label { font-size: 1rem; font-weight: 400; }
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Edge Cases & Special Logic
|
|
192
|
+
|
|
193
|
+
- **`resolveReferenceFields(item, hideFieldLabels, recordKey, pConn)`** — local utility that resolves additional display fields from an item record.
|
|
194
|
+
- Checkbox `id={item[recordKey]}` — required for the card click handler to find and click the input by ID.
|
|
195
|
+
- `getPConnect` prop on Checkbox (MUI): passed through to support `@pega/sdk-react` checkbox augmentation (non-standard MUI prop).
|
|
196
|
+
- `imageDescriptionKey = showImageDescription ? imageDescription : undefined` — only show alt text when `showImageDescription` is true.
|
|
197
|
+
|
|
198
|
+
## Dependencies
|
|
199
|
+
|
|
200
|
+
- `resolveReferenceFields` from `./utils` (local utility).
|
|
201
|
+
- Radio/Checkbox + FormControlLabel components.
|
|
202
|
+
- Card/CardContent components.
|
|
203
|
+
- Typography/text component.
|
|
204
|
+
|
|
205
|
+
## Design System Mapping
|
|
206
|
+
|
|
207
|
+
**UI control type:** Selectable card grid (radio or multi-select).
|
|
208
|
+
|
|
209
|
+
Listed design systems are examples only.
|
|
210
|
+
|
|
211
|
+
| Design System | Recommended Component |
|
|
212
|
+
|---|---|
|
|
213
|
+
| Default (CSS only) | Custom `<div>` cards with `<input type="radio/checkbox">` inside |
|
|
214
|
+
| MUI | `<Card>` + `<CardContent>` + `<FormControlLabel>` + `<Radio>`/`<Checkbox>` |
|
|
215
|
+
| Ant Design | Custom cards with `<Radio>`/`<Checkbox>` |
|
|
216
|
+
| Chakra UI | `<Box>` as card + `<Radio>`/`<Checkbox>` |
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# Skill: SemanticLink
|
|
2
|
+
|
|
3
|
+
Clickable hyperlink that navigates to a referenced Pega case or data object using semantic URL resolution.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
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.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `SemanticLink`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Link-SemanticLink`
|
|
17
|
+
- **Registration key:** `SemanticLink` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Default | Description |
|
|
22
|
+
|------|------|---------|-------------|
|
|
23
|
+
| `text` | `string` | — | The visible link text; renders `'--'` if empty |
|
|
24
|
+
| `resourcePayload` | `any` | `{}` | Resource payload containing `caseClassName`, `resourceType`, etc. |
|
|
25
|
+
| `resourceParams` | `any` | `{}` | Resource parameters containing `workID` for case navigation |
|
|
26
|
+
| `previewKey` | `string \| null` | — | Case preview key for opening work item by handle |
|
|
27
|
+
| `onClick` | `(event) => void` | — | External click handler (received but not directly used — link has its own handler) |
|
|
28
|
+
| `testId` | `string` | `''` | Test identifier |
|
|
29
|
+
| `referenceType` | `string \| null` | — | `'DATA'` or case reference type |
|
|
30
|
+
| `dataRelationshipContext` | `string \| null` | `null` | Context for data relationship resolution |
|
|
31
|
+
| `contextPage` | `any` | — | Context page with `classID` |
|
|
32
|
+
|
|
33
|
+
## Behavioral Contract
|
|
34
|
+
|
|
35
|
+
### URL Resolution
|
|
36
|
+
|
|
37
|
+
**Step 1: Determine if this is a data reference:**
|
|
38
|
+
- `isData = false`
|
|
39
|
+
- `shouldTreatAsDataReference = !previewKey && resourcePayload.caseClassName` (non-preview, has class)
|
|
40
|
+
- If `contextPage?.classID`: override `resourcePayload.caseClassName = contextPage.classID`
|
|
41
|
+
- If `resourcePayload.caseClassName === WORKCLASS`: override with actual case class from `pConnect.getValue(CASE_INFO_CLASSID)`
|
|
42
|
+
|
|
43
|
+
**Step 2a: Data reference (`referenceType === 'DATA'` or `shouldTreatAsDataReference`):**
|
|
44
|
+
```
|
|
45
|
+
const dataRefContext = semanticUtils.getDataReferenceInfo(pConnect, dataRelationshipContext, contextPage)
|
|
46
|
+
dataViewName = dataRefContext.dataContext
|
|
47
|
+
payload = dataRefContext.dataContextParameters
|
|
48
|
+
isData = true
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**Step 2b: Resource type DATA (`resourcePayload.resourceType === 'DATA'`):**
|
|
52
|
+
- Look up data page: `dataViewName = PCore.getDataTypeUtils().getLookUpDataPage(resourcePayload.className)`
|
|
53
|
+
- Look up page info and parameters
|
|
54
|
+
- Build `payload` from parameters by resolving property annotations
|
|
55
|
+
- `isData = true`
|
|
56
|
+
|
|
57
|
+
**Step 3: Build `linkURL`:**
|
|
58
|
+
- If `isData && dataViewName && payload`: `linkURL = PCore.getSemanticUrlUtils().getResolvedSemanticURL(ACTION_SHOWDATA, { pageName: 'pyDetails', dataViewName }, payload)`
|
|
59
|
+
- Else (case): fix `resourceParams.objectID` for empty workID edge case, then `linkURL = PCore.getSemanticUrlUtils().getResolvedSemanticURL(ACTION_OPENWORKBYHANDLE, resourcePayload, resourceParams)`
|
|
60
|
+
|
|
61
|
+
### Click Handler (`openLinkClick`)
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
function openLinkClick(e) {
|
|
65
|
+
if (!e.metaKey && !e.ctrlKey) {
|
|
66
|
+
e.preventDefault()
|
|
67
|
+
if (isData or shouldTreatAsDataReference) {
|
|
68
|
+
showDataAction()
|
|
69
|
+
} else if (previewKey) {
|
|
70
|
+
getPConnect().getActionsApi().openWorkByHandle(previewKey, resourcePayload.caseClassName)
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
// If metaKey/ctrlKey: allow default browser behavior (open in new tab)
|
|
74
|
+
}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### `showDataAction()`
|
|
78
|
+
|
|
79
|
+
- If `dataResourcePayLoad.resourceType === 'DATA'`: call `getPConnect().getActionsApi().showData('pyDetails', lookUpDataPage, payload)`
|
|
80
|
+
- If `referenceType === DATA` or `shouldTreatAsDataReference`: call `showData('pyDetails', dataViewName, payload)`
|
|
81
|
+
|
|
82
|
+
## Display Mode Rendering
|
|
83
|
+
|
|
84
|
+
No explicit `displayMode` handling — `SemanticLink` is always rendered as a link. The parent (`ObjectReference`) controls whether to show it in display mode.
|
|
85
|
+
|
|
86
|
+
## Visual Specifications
|
|
87
|
+
|
|
88
|
+
Derived from `makeStyles` and MUI `Link` props:
|
|
89
|
+
|
|
90
|
+
| Property | Value |
|
|
91
|
+
|----------|-------|
|
|
92
|
+
| Display | Inline link (button role) |
|
|
93
|
+
| Padding | `8px` all sides |
|
|
94
|
+
| Margin | `8px` all sides |
|
|
95
|
+
| Color | Primary link color (blue, default theme) |
|
|
96
|
+
| Font weight | 400 |
|
|
97
|
+
| Underline | Default link underline on hover |
|
|
98
|
+
| Cursor | Pointer |
|
|
99
|
+
| Text | `text` prop value, or `'--'` if empty |
|
|
100
|
+
|
|
101
|
+
**CSS-only implementation:**
|
|
102
|
+
```css
|
|
103
|
+
.semantic-link {
|
|
104
|
+
display: inline-block;
|
|
105
|
+
padding: 8px;
|
|
106
|
+
margin: 8px;
|
|
107
|
+
color: #1976d2;
|
|
108
|
+
text-decoration: none;
|
|
109
|
+
cursor: pointer;
|
|
110
|
+
font-weight: 400;
|
|
111
|
+
background: none;
|
|
112
|
+
border: none;
|
|
113
|
+
font-size: inherit;
|
|
114
|
+
}
|
|
115
|
+
.semantic-link:hover { text-decoration: underline; }
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Edge Cases & Special Logic
|
|
119
|
+
|
|
120
|
+
- **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.
|
|
121
|
+
- If `previewKey` is set: also set `resourceParams.id = previewKey`.
|
|
122
|
+
- `linkURL` is computed synchronously at render — if an error occurs in data reference resolution, it is silently caught (`try/catch`) and `linkURL` remains `''`.
|
|
123
|
+
- `onClick` prop from parent is received but NOT used directly — the component has its own `openLinkClick`. Do not call the parent's `onClick` directly.
|
|
124
|
+
- **Ctrl/Meta+click**: `e.metaKey || e.ctrlKey` → don't `preventDefault()`, let the browser open the href in a new tab.
|
|
125
|
+
- `text || '--'` is always rendered — never renders empty.
|
|
126
|
+
|
|
127
|
+
## Dependencies
|
|
128
|
+
|
|
129
|
+
- `semanticUtils.getDataReferenceInfo(pConnect, dataRelationshipContext, contextPage)` from `./utils` (local).
|
|
130
|
+
- `PCore.getSemanticUrlUtils().getResolvedSemanticURL()` — URL resolution.
|
|
131
|
+
- `PCore.getSemanticUrlUtils().getActions()` — `ACTION_OPENWORKBYHANDLE`, `ACTION_SHOWDATA`.
|
|
132
|
+
- `PCore.getDataTypeUtils().getLookUpDataPage()`, `getLookUpDataPageInfo()`, `getDataPageKeys()`.
|
|
133
|
+
- `PCore.getAnnotationUtils().isProperty()`, `getPropertyName()`.
|
|
134
|
+
- `PCore.getConstants()` — `RESOURCE_TYPES.DATA`, `WORKCLASS`, `CASE_INFO.CASE_INFO_CLASSID`.
|
|
135
|
+
- A link/anchor component (e.g., MUI `<Link component='button'>`, or native `<a>`/`<button>`).
|
|
136
|
+
|
|
137
|
+
## Design System Mapping
|
|
138
|
+
|
|
139
|
+
**UI control type:** Clickable hyperlink (button or anchor with navigation behavior).
|
|
140
|
+
|
|
141
|
+
Listed design systems are examples only.
|
|
142
|
+
|
|
143
|
+
| Design System | Recommended Component |
|
|
144
|
+
|---|---|
|
|
145
|
+
| Default (CSS only) | `<button class="semantic-link">` with anchor styling |
|
|
146
|
+
| MUI | `<Link component='button'>` |
|
|
147
|
+
| Ant Design | `<Typography.Link>` or `<Button type="link">` |
|
|
148
|
+
| Chakra UI | `<Link as="button">` |
|