@pega/sdk 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +2 -19
- package/package.json +4 -1
- package/templates/react-sdk-reference/.claude/instructions/component-map.md +38 -0
- package/templates/react-sdk-reference/.claude/instructions/dse-component.md +75 -0
- package/templates/react-sdk-reference/.claude/instructions/field-component.md +71 -0
- package/templates/react-sdk-reference/.claude/instructions/template-component.md +92 -0
- package/templates/react-sdk-reference/.claude/instructions/widget-component.md +87 -0
- package/templates/react-sdk-reference/.claude/prompts/add-component.md +144 -0
- package/templates/react-sdk-reference/.claude/prompts/component-manifest.json +111 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-all-components.md +149 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-dse-components.md +126 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-field-components.md +139 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-template-components.md +151 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-widget-components.md +124 -0
- package/templates/react-sdk-reference/.claude/prompts/identify-components.md +105 -0
- package/templates/react-sdk-reference/.claude/prompts/replace-design-system.md +519 -0
- package/templates/react-sdk-reference/.claude/skills/component-contracts.md +140 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/AlertBanner.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Banner.md +149 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/CaseSummaryFields.md +154 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/DetailsFields.md +144 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroup.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroupList.md +111 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldValueList.md +115 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Operator.md +149 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Pulse.md +83 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/RichTextEditor.md +206 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/WssQuickCreate.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension.md +289 -0
- package/templates/react-sdk-reference/.claude/skills/field-components.md +294 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/AutoComplete.md +112 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/CancelAlert.md +203 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Checkbox.md +158 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Currency.md +106 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Date.md +99 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/DateTime.md +103 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Decimal.md +98 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Dropdown.md +114 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Email.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Group.md +90 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Integer.md +87 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Location.md +136 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Multiselect.md +164 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/ObjectReference.md +164 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Percentage.md +92 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Phone.md +110 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/RadioButtons.md +146 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/RichText.md +138 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/ScalarList.md +124 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/SelectableCard.md +216 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/SemanticLink.md +148 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextArea.md +96 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextContent.md +101 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextInput.md +104 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Time.md +88 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/URL.md +85 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/UserReference.md +180 -0
- package/templates/react-sdk-reference/.claude/skills/run-and-verify.md +68 -0
- package/templates/react-sdk-reference/.claude/skills/template-components.md +322 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/AdvancedSearch.md +144 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/AppShell.md +122 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/BannerPage.md +83 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseSummary.md +100 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseView.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseViewActionsMenu.md +126 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/Confirmation.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DataReference.md +120 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultForm.md +102 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultPage.md +110 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/Details.md +88 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsSubTabs.md +95 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsThreeColumn.md +78 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsTwoColumn.md +78 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DynamicTabs.md +101 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/FieldGroupTemplate.md +109 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/HierarchicalForm.md +113 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboard.md +104 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboardPage.md +85 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/ListPage.md +68 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/ListView.md +139 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/MultiReferenceReadOnly.md +80 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/NarrowWide.md +141 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/OneColumn.md +109 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/PromotedFilters.md +124 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SelfServiceCaseView.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SimpleTable.md +127 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SingleReferenceReadOnly.md +103 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SubTabs.md +79 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/TwoColumn.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/WideNarrow.md +150 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/WssNavBar.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/widget-components.md +271 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/AppAnnouncement.md +82 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/Attachment.md +146 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/CaseHistory.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/FileUtility.md +200 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/Followers.md +99 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/QuickCreate.md +114 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/SummaryItem.md +167 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/ToDo.md +190 -0
- package/templates/react-sdk-reference/.cursor/rules/component-map.mdrules +41 -0
- package/templates/react-sdk-reference/.cursor/rules/dse-component.mdrules +78 -0
- package/templates/react-sdk-reference/.cursor/rules/field-component.mdrules +74 -0
- package/templates/react-sdk-reference/.cursor/rules/pega-sdk.mdrules +247 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/add-component.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/component-manifest.json +111 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-all-components.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-dse-components.mdrules +131 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-field-components.mdrules +144 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-template-components.mdrules +156 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-widget-components.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/identify-components.mdrules +110 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/replace-design-system.mdrules +524 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/component-contracts.mdrules +145 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/AlertBanner.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Banner.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/CaseSummaryFields.mdrules +159 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/DetailsFields.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroup.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroupList.mdrules +116 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldValueList.mdrules +120 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Operator.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Pulse.mdrules +88 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/RichTextEditor.mdrules +211 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/WssQuickCreate.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension.mdrules +294 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-components.mdrules +299 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/AutoComplete.mdrules +117 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/CancelAlert.mdrules +208 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Checkbox.mdrules +163 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Currency.mdrules +111 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Date.mdrules +104 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/DateTime.mdrules +108 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Decimal.mdrules +103 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Dropdown.mdrules +119 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Email.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Group.mdrules +95 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Integer.mdrules +92 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Location.mdrules +141 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Multiselect.mdrules +169 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ObjectReference.mdrules +169 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Percentage.mdrules +97 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Phone.mdrules +115 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RadioButtons.mdrules +151 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RichText.mdrules +143 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ScalarList.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SelectableCard.mdrules +221 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SemanticLink.mdrules +153 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextArea.mdrules +101 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextContent.mdrules +106 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextInput.mdrules +109 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Time.mdrules +93 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/URL.mdrules +90 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/UserReference.mdrules +185 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/run-and-verify.mdrules +73 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-components.mdrules +327 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AdvancedSearch.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AppShell.mdrules +127 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/BannerPage.mdrules +88 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseSummary.mdrules +105 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseView.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseViewActionsMenu.mdrules +131 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Confirmation.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DataReference.mdrules +125 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultForm.mdrules +107 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultPage.mdrules +115 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Details.mdrules +93 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsSubTabs.mdrules +100 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsThreeColumn.mdrules +83 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsTwoColumn.mdrules +83 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DynamicTabs.mdrules +106 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/FieldGroupTemplate.mdrules +114 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/HierarchicalForm.mdrules +118 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboard.mdrules +109 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboardPage.mdrules +90 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListPage.mdrules +73 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListView.mdrules +144 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/MultiReferenceReadOnly.mdrules +85 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/NarrowWide.mdrules +146 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/OneColumn.mdrules +114 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/PromotedFilters.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SelfServiceCaseView.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SimpleTable.mdrules +132 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SingleReferenceReadOnly.mdrules +108 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SubTabs.mdrules +84 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/TwoColumn.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WideNarrow.mdrules +155 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WssNavBar.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-components.mdrules +276 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/AppAnnouncement.mdrules +87 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Attachment.mdrules +151 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/CaseHistory.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/FileUtility.mdrules +205 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Followers.mdrules +104 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/QuickCreate.mdrules +119 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/SummaryItem.mdrules +172 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/ToDo.mdrules +195 -0
- package/templates/react-sdk-reference/.cursor/rules/template-component.mdrules +95 -0
- package/templates/react-sdk-reference/.cursor/rules/widget-component.mdrules +90 -0
- package/templates/react-sdk-reference/.github/copilot-instructions.md +58 -0
- package/templates/react-sdk-reference/.github/prompts/add-component.prompt.md +144 -16
- package/templates/react-sdk-reference/.github/prompts/generate-all-components.prompt.md +154 -0
- package/templates/react-sdk-reference/.github/prompts/generate-dse-components.prompt.md +131 -0
- package/templates/react-sdk-reference/.github/prompts/generate-field-components.prompt.md +144 -0
- package/templates/react-sdk-reference/.github/prompts/generate-template-components.prompt.md +156 -0
- package/templates/react-sdk-reference/.github/prompts/generate-widget-components.prompt.md +129 -0
- package/templates/react-sdk-reference/.github/skills/design-system-extension.md +58 -18
- package/templates/react-sdk-reference/.github/skills/field-components.md +55 -23
- package/templates/react-sdk-reference/.github/skills/template-components.md +48 -11
- package/templates/react-sdk-reference/.github/skills/widget-components.md +49 -12
- package/templates/react-sdk-reference/AGENTS.md +217 -29
- package/templates/react-sdk-reference/package.json +3 -2
- package/templates/react-sdk-reference/pega-auth-0.2.42.tgz +0 -0
- package/templates/react-sdk-reference/pega-constellationjs-0.26.3-local.tgz +0 -0
- package/templates/react-sdk-reference/pega-sdk-react-0.1.0.tgz +0 -0
- package/templates/react-sdk-reference/pega-sdk-types-0.1.0.tgz +0 -0
- package/templates/react-sdk-reference/sdk-config.json +1 -1
- package/templates/react-sdk-reference/vite.config.ts +1 -1
- package/templates/react-sdk-reference/.github/prompts/replace-all-fields.prompt.md +0 -48
- package/templates/react-sdk-reference/.github/prompts/replace-component.prompt.md +0 -81
- package/templates/react-sdk-reference/.github/prompts/replace-field.prompt.md +0 -41
- package/templates/react-sdk-reference/.github/prompts/swap-design-system.prompt.md +0 -49
- package/templates/react-sdk-reference/.github/skills/swap-design-system.md +0 -105
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
# Skill: RichTextEditor
|
|
2
|
+
|
|
3
|
+
WYSIWYG rich text editor field backed by TinyMCE. Supports editable and read-only modes, optional label, helper text, error/required states, and a file picker for image uploads.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a rich text editing area (WYSIWYG) for Pega case properties that store HTML content. In **edit mode**, uses TinyMCE with a bottom toolbar. In **read-only mode**, renders the HTML content as a read-only `<div>`. Wraps the editor in a `FormControl` with an optional floating label and helper text, consistent with other field components.
|
|
12
|
+
|
|
13
|
+
The editor is a `forwardRef` component — the ref is connected to the underlying TinyMCE editor instance.
|
|
14
|
+
|
|
15
|
+
> **Note:** TinyMCE is the reference editor library. In non-MUI or non-TinyMCE implementations, this component can be replaced with an alternative rich text library (Quill, ProseMirror, Slate.js, etc.). The behavioral contract below remains the same regardless of library.
|
|
16
|
+
|
|
17
|
+
## Pega Metadata
|
|
18
|
+
|
|
19
|
+
- **Pega Name:** `RichTextEditor`
|
|
20
|
+
- **Registration key:** `RichTextEditor` (in `component-map.ts`)
|
|
21
|
+
- **Does NOT extend PConnProps** — receives all data as explicit field-like props
|
|
22
|
+
|
|
23
|
+
## Props
|
|
24
|
+
|
|
25
|
+
| Prop | Type | Required | Description |
|
|
26
|
+
|------|------|----------|-------------|
|
|
27
|
+
| `id` | `string` | No | DOM id for the editor element. Defaults to a generated UID |
|
|
28
|
+
| `defaultValue` | `string` | Yes | Initial HTML content of the editor |
|
|
29
|
+
| `label` | `string` | Yes | Field label displayed above the editor |
|
|
30
|
+
| `labelHidden` | `boolean` | Yes | If `true`, hide the label |
|
|
31
|
+
| `info` | `string` | No | Helper text displayed below the editor |
|
|
32
|
+
| `testId` | `string` | No | Value for `data-test-id` attribute on the FormControl wrapper |
|
|
33
|
+
| `placeholder` | `string` | No | Placeholder text shown in empty editor |
|
|
34
|
+
| `disabled` | `boolean` | Yes | If `true`, editor is in read-only/disabled mode with no toolbar |
|
|
35
|
+
| `required` | `boolean` | Yes | If `true`, marks the field as required |
|
|
36
|
+
| `readOnly` | `boolean` | Yes | If `true`, render as static HTML display (not interactive editor) |
|
|
37
|
+
| `error` | `boolean` | Yes | If `true`, applies error styling to the FormControl |
|
|
38
|
+
| `onBlur` | `React.EventHandler<any>` | Yes | Called when the editor loses focus |
|
|
39
|
+
| `onChange` | `React.EventHandler<any>` | Yes | Called when the editor content changes |
|
|
40
|
+
|
|
41
|
+
## Behavioral Contract
|
|
42
|
+
|
|
43
|
+
### 1. Ref Forwarding
|
|
44
|
+
|
|
45
|
+
The component uses `forwardRef`. Internally, use `useConsolidatedRef(ref)` from `@pega/sdk-react` to create `editorRef` — the TinyMCE editor instance is stored here after initialization.
|
|
46
|
+
|
|
47
|
+
### 2. UID for id
|
|
48
|
+
|
|
49
|
+
If `id` is not provided, generate one using `useUID()` from `@pega/sdk-react`.
|
|
50
|
+
|
|
51
|
+
### 3. Read-Only Mode
|
|
52
|
+
|
|
53
|
+
If `readOnly` is `true`, render:
|
|
54
|
+
```
|
|
55
|
+
<div
|
|
56
|
+
key={id}
|
|
57
|
+
id={id}
|
|
58
|
+
className='readonly-richtext-editor'
|
|
59
|
+
dangerouslySetInnerHTML={{ __html: defaultValue || '--' }}
|
|
60
|
+
/>
|
|
61
|
+
```
|
|
62
|
+
Skip the TinyMCE Editor entirely in this case.
|
|
63
|
+
|
|
64
|
+
### 4. Edit Mode (TinyMCE)
|
|
65
|
+
|
|
66
|
+
When `readOnly` is `false`, render `<Editor>` from `@tinymce/tinymce-react` with:
|
|
67
|
+
|
|
68
|
+
| Config | Value |
|
|
69
|
+
|--------|-------|
|
|
70
|
+
| `tinymceScriptSrc` | `'tinymce/tinymce.min.js'` (local script) |
|
|
71
|
+
| `id` | The resolved `id` |
|
|
72
|
+
| `initialValue` | `defaultValue` |
|
|
73
|
+
| `disabled` | `disabled` prop |
|
|
74
|
+
| `onBlur` | `onBlur` prop |
|
|
75
|
+
| `onEditorChange` | `onChange` prop |
|
|
76
|
+
| `onInit` | Store editor in `editorRef.current` |
|
|
77
|
+
|
|
78
|
+
### 5. TinyMCE `init` Configuration
|
|
79
|
+
|
|
80
|
+
| Option | Value |
|
|
81
|
+
|--------|-------|
|
|
82
|
+
| `skin` | `'oxide-dark'` (dark mode) / `'oxide'` (light mode) — detect from theme |
|
|
83
|
+
| `menubar` | `false` |
|
|
84
|
+
| `statusbar` | `false` |
|
|
85
|
+
| `branding` | `false` |
|
|
86
|
+
| `min_height` | `130` |
|
|
87
|
+
| `toolbar_location` | `'bottom'` |
|
|
88
|
+
| `plugins` | `['lists', 'advlist', 'autolink', 'image', 'link', 'autoresize']` |
|
|
89
|
+
| `autoresize_bottom_margin` | `0` |
|
|
90
|
+
| `toolbar` | `'blocks \| bold italic strikethrough \| bullist numlist outdent indent \| link image'` (or `false` when `disabled`) |
|
|
91
|
+
| `paste_data_images` | `true` |
|
|
92
|
+
| `file_picker_types` | `'image'` |
|
|
93
|
+
| `file_picker_callback` | See file picker section below |
|
|
94
|
+
| `content_style` | Theme-aware CSS string (see below) |
|
|
95
|
+
| `placeholder` | `placeholder` prop |
|
|
96
|
+
|
|
97
|
+
### 6. Theme-Aware Content Style
|
|
98
|
+
|
|
99
|
+
Inject a `content_style` string that uses theme values for the editor body:
|
|
100
|
+
```css
|
|
101
|
+
body {
|
|
102
|
+
font-family: <theme.typography.fontFamily>;
|
|
103
|
+
font-size: <theme.typography.fontSize>px;
|
|
104
|
+
color: <theme.palette.text.primary>;
|
|
105
|
+
background: <theme.palette.background.paper>;
|
|
106
|
+
}
|
|
107
|
+
a { color: <theme.palette.primary.main>; }
|
|
108
|
+
h1-h6 { color: <theme.palette.text.primary>; font-family: <theme.typography.fontFamily>; }
|
|
109
|
+
blockquote { color: <theme.palette.text.secondary>; border-left: 4px solid <theme.palette.primary.light>; padding-left: 8px; }
|
|
110
|
+
ul, ol { color: <theme.palette.text.primary>; }
|
|
111
|
+
input, textarea, select {
|
|
112
|
+
background: <theme.palette.background.paper>;
|
|
113
|
+
color: <theme.palette.text.primary>;
|
|
114
|
+
border: 1px solid <theme.palette.divider>;
|
|
115
|
+
border-radius: 4px; padding: 6px 10px; font-size: 1em; font-family: inherit;
|
|
116
|
+
}
|
|
117
|
+
.mce-content-body[data-mce-placeholder]:not(.mce-visualblocks)::before {
|
|
118
|
+
color: <theme.palette.text.secondary>; opacity: 0.7;
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### 7. File Picker Callback
|
|
123
|
+
|
|
124
|
+
When a user clicks the image upload in the toolbar:
|
|
125
|
+
1. Create a hidden `<input type='file' accept='image/*'>`.
|
|
126
|
+
2. On file selected: read as DataURL using `FileReader`.
|
|
127
|
+
3. On `FileReader.load`: create a blob in TinyMCE's blob cache (`editorRef.current.editorUpload.blobCache`), then call `cb(blobInfo.blobUri(), { title: file.name })`.
|
|
128
|
+
4. Programmatically click the input to open the file dialog.
|
|
129
|
+
|
|
130
|
+
### 8. readOnly/disabled Transition (after initial mount)
|
|
131
|
+
|
|
132
|
+
Use `useAfterInitialEffect([readOnly, disabled])` from `@pega/sdk-react`:
|
|
133
|
+
```
|
|
134
|
+
editorRef?.current.mode.set(readOnly || disabled ? 'readonly' : 'design')
|
|
135
|
+
```
|
|
136
|
+
This switches the TinyMCE mode without re-mounting the editor.
|
|
137
|
+
|
|
138
|
+
### 9. Wrapper Structure
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
<FormControl variant='standard' data-test-id={testId} error={error} required={required}>
|
|
142
|
+
{!labelHidden && <InputLabel className='fieldLabel'>{label}</InputLabel>}
|
|
143
|
+
{richTextComponent} ← either readOnly div or <Editor>
|
|
144
|
+
{info && <FormHelperText>{info}</FormHelperText>}
|
|
145
|
+
</FormControl>
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Visual Specifications
|
|
149
|
+
|
|
150
|
+
Derived from `RichTextEditor.tsx` makeStyles:
|
|
151
|
+
|
|
152
|
+
### Label
|
|
153
|
+
|
|
154
|
+
| Property | Value |
|
|
155
|
+
|----------|-------|
|
|
156
|
+
| Position | relative |
|
|
157
|
+
| Transform | `translate(0, 0px) scale(1)` (non-floating — stays at top) |
|
|
158
|
+
| Margin bottom | 5px |
|
|
159
|
+
| Color | `theme.palette.text.secondary` |
|
|
160
|
+
|
|
161
|
+
**CSS-only implementation notes:**
|
|
162
|
+
- Label: `display: block; font-size: 0.875rem; color: var(--text-secondary); margin-bottom: 5px`.
|
|
163
|
+
- Editor container: `min-height: 130px; border: 1px solid var(--divider); border-radius: 4px`.
|
|
164
|
+
- Toolbar (if CSS-only): render buttons at bottom of the editor area.
|
|
165
|
+
- Read-only display: `div.readonly-richtext-editor { padding: 8px; min-height: 130px; background: var(--bg-paper); color: var(--text-primary) }`.
|
|
166
|
+
- Error state: `border-color: var(--error-color)`.
|
|
167
|
+
- Helper text: `font-size: 0.75rem; color: var(--text-secondary); margin-top: 4px`.
|
|
168
|
+
- Error helper text: `color: var(--error-color)`.
|
|
169
|
+
|
|
170
|
+
## Edge Cases & Special Logic
|
|
171
|
+
|
|
172
|
+
- `defaultValue` in read-only mode falls back to `'--'` if empty.
|
|
173
|
+
- `readOnly` and `disabled` are both handled — `readOnly` suppresses the editor entirely; `disabled` keeps the editor mounted but in TinyMCE's `readonly` mode with no toolbar.
|
|
174
|
+
- Mode transitions (readOnly/disabled changing after mount) use `useAfterInitialEffect` — this hook fires on updates but NOT on the initial render, preventing a double-set on mount.
|
|
175
|
+
- The file picker creates a transient `<input type='file'>` element that is never appended to the DOM — it is clicked programmatically.
|
|
176
|
+
- `id` must be stable across renders — use `useUID()` only as a fallback when `id` prop is absent.
|
|
177
|
+
|
|
178
|
+
## Dependencies
|
|
179
|
+
|
|
180
|
+
- `Editor` from `@tinymce/tinymce-react` — TinyMCE React wrapper (can be swapped for Quill, ProseMirror, Slate.js, etc.)
|
|
181
|
+
- `useAfterInitialEffect`, `useConsolidatedRef`, `useUID` from `@pega/sdk-react` — SDK hooks
|
|
182
|
+
- `useTheme` from `@mui/material` — for theme-aware content styles
|
|
183
|
+
- `FormControl`, `FormHelperText`, `InputLabel` from `@mui/material` — wrapper structure
|
|
184
|
+
|
|
185
|
+
## Design System Mapping
|
|
186
|
+
|
|
187
|
+
**UI control type:** Rich text / WYSIWYG editor field with label, helper text, and error state.
|
|
188
|
+
|
|
189
|
+
Listed design systems are examples only.
|
|
190
|
+
|
|
191
|
+
| Design System | Rich Text Library |
|
|
192
|
+
|---|---|
|
|
193
|
+
| Default (CSS only) | `contenteditable` div with custom toolbar, or `<textarea>` |
|
|
194
|
+
| MUI | TinyMCE (`@tinymce/tinymce-react`) wrapped in `<FormControl>` |
|
|
195
|
+
| Ant Design | Quill (`react-quill`) or TinyMCE inside an `<AntForm.Item>` |
|
|
196
|
+
| Chakra UI | Quill or Slate.js inside a `<FormControl>` |
|
|
197
|
+
| Shadcn/ui | Tiptap (`@tiptap/react`) inside a field wrapper |
|
|
198
|
+
|
|
199
|
+
When implementing in a specific design system, map the following:
|
|
200
|
+
- `defaultValue` → initial HTML content
|
|
201
|
+
- `readOnly={true}` → always render as static HTML `<div>` (no editor instance)
|
|
202
|
+
- `disabled={true}` → editor mounted but read-only (toolbar hidden)
|
|
203
|
+
- `onBlur` / `onChange` → editor's blur and content-change callbacks
|
|
204
|
+
- `error` + `info` → FormControl error state + helper/description text below
|
|
205
|
+
- `labelHidden` → conditionally render the label element
|
|
206
|
+
- File picker → `<input type='file' accept='image/*'>` triggered programmatically
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# Skill: WssQuickCreate
|
|
2
|
+
|
|
3
|
+
Quick-launch action grid that displays a heading and a set of labeled buttons, each optionally with an icon, for creating WSS cases.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite skill:** [`design-system-extension.md`](../design-system-extension.md) — covers architecture, props interface, styling patterns, and registration patterns common to ALL DSE components.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Component Purpose
|
|
10
|
+
|
|
11
|
+
Renders a titled section of clickable action cards arranged in a responsive CSS grid. Each card contains an optional icon image and a label. Used in workspace/portal contexts to provide quick access to case creation actions.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `WssQuickCreate`
|
|
16
|
+
- **Registration key:** `WssQuickCreate` (in `component-map.ts`)
|
|
17
|
+
- **Does NOT use `getPConnect`** — receives all data as direct props
|
|
18
|
+
|
|
19
|
+
## Props
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Required | Description |
|
|
22
|
+
|------|------|----------|-------------|
|
|
23
|
+
| `heading` | `string` | Yes | Section title rendered as an `<h1>` |
|
|
24
|
+
| `actions` | `Array<{ label: string; onClick: () => void; icon?: string }>` | No | List of action items; each has a label, click handler, and optional icon URL |
|
|
25
|
+
|
|
26
|
+
## Behavioral Contract
|
|
27
|
+
|
|
28
|
+
1. Render the `heading` in an `<h1>` element with `id='quick-links-heading'` and class `quick-links-heading`.
|
|
29
|
+
2. Render a `<ul>` with `id='quick-links'` and class `quick-link-ul-list`.
|
|
30
|
+
3. If `actions` is provided, iterate and render one `<li>` per action.
|
|
31
|
+
4. Each `<li>` has the `quickLinkList` style class (styled card with border, rounded corners, and background color).
|
|
32
|
+
5. Inside each `<li>`, render a `<button>` with class `quick-link-button` and the action's `onClick` handler.
|
|
33
|
+
6. Button content is a `<span class='quick-link-button-span'>` (column flex layout) containing:
|
|
34
|
+
- If `action.icon` is provided: `<img class='quick-link-icon' src={action.icon} />`
|
|
35
|
+
- `<span>{action.label}</span>`
|
|
36
|
+
7. If `actions` is not provided or is empty, render only the heading with an empty list.
|
|
37
|
+
|
|
38
|
+
## Visual Specifications
|
|
39
|
+
|
|
40
|
+
Derived from `WssQuickCreate.css` and component makeStyles:
|
|
41
|
+
|
|
42
|
+
### Section Heading
|
|
43
|
+
|
|
44
|
+
| Property | Value |
|
|
45
|
+
|----------|-------|
|
|
46
|
+
| Tag | `<h1>` |
|
|
47
|
+
| Margin top | 8px |
|
|
48
|
+
|
|
49
|
+
### Action List
|
|
50
|
+
|
|
51
|
+
| Property | Value |
|
|
52
|
+
|----------|-------|
|
|
53
|
+
| List style | none |
|
|
54
|
+
| Padding | 0 |
|
|
55
|
+
| Display | grid |
|
|
56
|
+
| Grid template columns | `repeat(auto-fit, minmax(min(20ch, 100%), 1fr))` (responsive columns) |
|
|
57
|
+
| Gap | 1rem |
|
|
58
|
+
|
|
59
|
+
### Action Card (`<li>`)
|
|
60
|
+
|
|
61
|
+
| Property | Value |
|
|
62
|
+
|----------|-------|
|
|
63
|
+
| Background (light mode) | `var(--link-button-color)` |
|
|
64
|
+
| Background (dark mode) | `var(--app-background-color)` |
|
|
65
|
+
| Text color | `var(--app-text-color)` |
|
|
66
|
+
| Border radius | 16px |
|
|
67
|
+
| Border | `1px solid var(--app-primary-color)` |
|
|
68
|
+
|
|
69
|
+
### Action Button
|
|
70
|
+
|
|
71
|
+
| Property | Value |
|
|
72
|
+
|----------|-------|
|
|
73
|
+
| Text transform | capitalize |
|
|
74
|
+
| Font size | 16px |
|
|
75
|
+
| Color | `var(--app-text-color)` |
|
|
76
|
+
| Height | 10rem |
|
|
77
|
+
| Width | 100% |
|
|
78
|
+
| Background | transparent (inherits card) |
|
|
79
|
+
|
|
80
|
+
### Button Inner Span
|
|
81
|
+
|
|
82
|
+
| Property | Value |
|
|
83
|
+
|----------|-------|
|
|
84
|
+
| Display | flex |
|
|
85
|
+
| Flex direction | column |
|
|
86
|
+
| Align items | center |
|
|
87
|
+
| Gap | 0.5rem |
|
|
88
|
+
|
|
89
|
+
### Icon
|
|
90
|
+
|
|
91
|
+
| Property | Value |
|
|
92
|
+
|----------|-------|
|
|
93
|
+
| Flex shrink | 0 |
|
|
94
|
+
| Object fit | contain |
|
|
95
|
+
| Width | 3rem |
|
|
96
|
+
| Height | 3rem |
|
|
97
|
+
|
|
98
|
+
**CSS-only implementation notes:**
|
|
99
|
+
- Action list: `list-style: none; padding: 0; display: grid; grid-template-columns: repeat(auto-fit, minmax(min(20ch, 100%), 1fr)); gap: 1rem`.
|
|
100
|
+
- Action card: `background: var(--link-button-color); border-radius: 16px; border: 1px solid var(--app-primary-color); color: var(--app-text-color)`.
|
|
101
|
+
- Button: `width: 100%; height: 10rem; background: transparent; border: none; cursor: pointer; text-transform: capitalize; font-size: 16px; color: inherit`.
|
|
102
|
+
- Button content: `display: flex; flex-direction: column; align-items: center; gap: 0.5rem`.
|
|
103
|
+
- Icon: `width: 3rem; height: 3rem; object-fit: contain; flex-shrink: 0`.
|
|
104
|
+
|
|
105
|
+
## Edge Cases & Special Logic
|
|
106
|
+
|
|
107
|
+
- If `actions` is `undefined` or empty, render the heading and empty `<ul>` without errors.
|
|
108
|
+
- If `action.icon` is `undefined` or an empty string, render only the label span (no `<img>` element).
|
|
109
|
+
- Labels are displayed as-is (no truncation); the grid layout handles responsive sizing naturally.
|
|
110
|
+
|
|
111
|
+
## Dependencies
|
|
112
|
+
|
|
113
|
+
- No Pega SDK imports required (no `getPConnect`)
|
|
114
|
+
- No helper utilities required
|
|
115
|
+
- Icon images are passed as URLs (strings) via `action.icon` — no internal icon system used
|
|
116
|
+
|
|
117
|
+
## Design System Mapping
|
|
118
|
+
|
|
119
|
+
**UI control type:** Responsive grid of action cards / quick-launch buttons.
|
|
120
|
+
|
|
121
|
+
Listed design systems are examples only.
|
|
122
|
+
|
|
123
|
+
| Design System | Recommended Component |
|
|
124
|
+
|---|---|
|
|
125
|
+
| Default (CSS only) | CSS grid `<ul>` + `<button>` cards with flex icon/label layout |
|
|
126
|
+
| MUI | `<Button>` inside Grid items; use `makeStyles` or `sx` for card styling |
|
|
127
|
+
| Ant Design | `<List>` with `<Card>` items or `<Button>` blocks inside a CSS grid |
|
|
128
|
+
| Chakra UI | `<SimpleGrid>` with `<Button>` children; `flexDir='column'` |
|
|
129
|
+
| Shadcn/ui | Grid of custom `<Button variant='outline'>` cards |
|
|
130
|
+
|
|
131
|
+
When implementing in a specific design system, map the following:
|
|
132
|
+
- Card border/background → design system's card or outlined button variant
|
|
133
|
+
- Button `onClick` → standard click handler prop
|
|
134
|
+
- Icon + label stacked layout → `flexDirection: 'column'` button content
|
|
135
|
+
- Responsive grid → design system's grid or `SimpleGrid` equivalent
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
# Skill: Design System Extension (DSE) Components
|
|
2
|
+
|
|
3
|
+
Create or replace Design System Extension components in the react-sdk-reference application. DSE components are display-focused presentational components that render structured data without direct PConnect binding. Some receive `getPConnect`, others receive only display props.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Architecture Overview
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
src/components/designSystemExtension/<ComponentName>/
|
|
11
|
+
├── <ComponentName>.tsx # Component implementation
|
|
12
|
+
├── index.tsx # Re-export (if present)
|
|
13
|
+
├── <ComponentName>.css # Styles (optional)
|
|
14
|
+
└── config-ext.json # Metadata (optional)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Props Interface
|
|
20
|
+
|
|
21
|
+
DSE components have varying prop patterns:
|
|
22
|
+
|
|
23
|
+
### Pattern A: With PConnect (data-aware display)
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import type { PConnProps } from '../../../types/PConnProps';
|
|
27
|
+
|
|
28
|
+
interface FieldValueListProps extends PConnProps {
|
|
29
|
+
name?: string;
|
|
30
|
+
value?: string;
|
|
31
|
+
variant?: 'stacked' | 'inline';
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Pattern B: Without PConnect (pure presentation)
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
interface AlertBannerProps {
|
|
39
|
+
variant: 'urgent' | 'warning' | 'info' | 'success';
|
|
40
|
+
heading?: string;
|
|
41
|
+
messages: Array<string | { label?: string; description?: string }>;
|
|
42
|
+
onClose?: () => void;
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Pattern C: Extended field props (display-only fields)
|
|
47
|
+
|
|
48
|
+
```typescript
|
|
49
|
+
import type { PConnFieldProps } from '../../../types/PConnProps';
|
|
50
|
+
|
|
51
|
+
interface RichTextEditorProps extends PConnFieldProps {
|
|
52
|
+
content?: string;
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Implementation Patterns
|
|
59
|
+
|
|
60
|
+
### Pure Display Component (no PConnect)
|
|
61
|
+
|
|
62
|
+
Used for: AlertBanner, Banner, Operator
|
|
63
|
+
|
|
64
|
+
This pattern is design-system agnostic. The variant-mapping logic and message normalisation are always the same. The `// [DS RENDER]` section must be replaced with your design system's alert/notification primitive — see "Design System Adaptation" below.
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
// Import your design system alert/notification component:
|
|
68
|
+
// e.g. import { Alert } from 'antd';
|
|
69
|
+
// e.g. import { Alert } from '@chakra-ui/react';
|
|
70
|
+
|
|
71
|
+
interface AlertBannerProps {
|
|
72
|
+
variant: 'urgent' | 'warning' | 'info' | 'success';
|
|
73
|
+
heading?: string;
|
|
74
|
+
messages: Array<string | { label?: string; description?: string }>;
|
|
75
|
+
onClose?: () => void;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export default function AlertBanner(props: AlertBannerProps) {
|
|
79
|
+
const { variant, heading, messages = [], onClose } = props;
|
|
80
|
+
|
|
81
|
+
// Map Pega variant names to your DS equivalent
|
|
82
|
+
// e.g. MUI: urgent → 'error' | Ant Design: urgent → 'error' | Chakra: urgent → 'error'
|
|
83
|
+
const variantMap: Record<string, string> = {
|
|
84
|
+
urgent: 'error',
|
|
85
|
+
warning: 'warning',
|
|
86
|
+
info: 'info',
|
|
87
|
+
success: 'success'
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
// Normalise messages — Pega may send a plain string or an object
|
|
91
|
+
function renderMessage(msg: string | { label?: string; description?: string }) {
|
|
92
|
+
if (typeof msg === 'string') return msg;
|
|
93
|
+
return `${msg.label ?? ''} ${msg.description ?? ''}`.trim();
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
// [DS RENDER] — replace with your design system's alert/notification primitive
|
|
97
|
+
// The variantMap value above should be passed as the DS severity/type/status prop
|
|
98
|
+
return (
|
|
99
|
+
<YourDesignSystemAlert
|
|
100
|
+
type={variantMap[variant] ?? 'info'}
|
|
101
|
+
message={heading}
|
|
102
|
+
description={messages.map(renderMessage).join(' ')}
|
|
103
|
+
closable={!!onClose}
|
|
104
|
+
onClose={onClose}
|
|
105
|
+
/>
|
|
106
|
+
);
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Field Value Display Component
|
|
111
|
+
|
|
112
|
+
Used for: FieldValueList, CaseSummaryFields, DetailsFields
|
|
113
|
+
|
|
114
|
+
```typescript
|
|
115
|
+
import type { PConnProps } from '../../../types/PConnProps';
|
|
116
|
+
|
|
117
|
+
interface FieldValueListProps extends PConnProps {
|
|
118
|
+
name?: string;
|
|
119
|
+
value?: string;
|
|
120
|
+
variant?: 'stacked' | 'inline';
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
export default function FieldValueList(props: FieldValueListProps) {
|
|
124
|
+
const { name, value, variant = 'inline' } = props;
|
|
125
|
+
|
|
126
|
+
if (variant === 'stacked') {
|
|
127
|
+
return (
|
|
128
|
+
<div className='field-value-stacked'>
|
|
129
|
+
<span className='field-label'>{name}</span>
|
|
130
|
+
<span className='field-value-large'>{value}</span>
|
|
131
|
+
</div>
|
|
132
|
+
);
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
return (
|
|
136
|
+
<div className='field-value-inline'>
|
|
137
|
+
{name && <span className='field-label'>{name}: </span>}
|
|
138
|
+
<span className='field-value'>{value}</span>
|
|
139
|
+
</div>
|
|
140
|
+
);
|
|
141
|
+
}
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Complex Display Component (with PConnect for data)
|
|
145
|
+
|
|
146
|
+
Used for: FieldGroup, FieldGroupList, Pulse
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
import { createElement } from 'react';
|
|
150
|
+
import createPConnectComponent from '../../helpers/react_pconnect';
|
|
151
|
+
import type { PConnProps } from '../../../types/PConnProps';
|
|
152
|
+
|
|
153
|
+
interface FieldGroupProps extends PConnProps {
|
|
154
|
+
label?: string;
|
|
155
|
+
showLabel?: boolean;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export default function FieldGroup(props: FieldGroupProps) {
|
|
159
|
+
const { getPConnect, label, showLabel = true } = props;
|
|
160
|
+
const pConn = getPConnect();
|
|
161
|
+
const children = pConn.getChildren();
|
|
162
|
+
|
|
163
|
+
return (
|
|
164
|
+
<fieldset>
|
|
165
|
+
{showLabel && label && <legend>{label}</legend>}
|
|
166
|
+
{children.map((child, i) =>
|
|
167
|
+
createElement(createPConnectComponent(), { ...child, key: `fg-${i}` })
|
|
168
|
+
)}
|
|
169
|
+
</fieldset>
|
|
170
|
+
);
|
|
171
|
+
}
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## Styling Patterns
|
|
177
|
+
|
|
178
|
+
DSE components use one of three approaches depending on the component and design system:
|
|
179
|
+
|
|
180
|
+
### CSS File Pattern (DS-agnostic, preferred for Field Value components)
|
|
181
|
+
|
|
182
|
+
```css
|
|
183
|
+
/* FieldValueList.css */
|
|
184
|
+
.field-value-inline {
|
|
185
|
+
display: flex;
|
|
186
|
+
gap: 0.5rem;
|
|
187
|
+
align-items: baseline;
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
.field-label {
|
|
191
|
+
font-weight: 600;
|
|
192
|
+
color: var(--text-secondary);
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
.field-value-large {
|
|
196
|
+
font-size: 1.25rem;
|
|
197
|
+
font-weight: 500;
|
|
198
|
+
}
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### Design System Style Props (use if your DS provides them)
|
|
202
|
+
|
|
203
|
+
If the chosen design system provides built-in spacing, typography, or layout props, prefer them over plain CSS:
|
|
204
|
+
- Use the DS's layout wrapper (e.g., `<Stack>`, `<Flex>`, `<HStack>`) instead of manual flex CSS
|
|
205
|
+
- Use DS typography components (e.g., `<Text>`, `<Heading>`) instead of raw `<span>`/`<div>`
|
|
206
|
+
- Use DS CSS custom properties or tokens for spacing — never hardcode `px` values
|
|
207
|
+
- Discover which style props are available from the installed `.d.ts` files before using them
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## Design System Adaptation
|
|
212
|
+
|
|
213
|
+
DSE components fall into three patterns with different DS dependencies:
|
|
214
|
+
|
|
215
|
+
| Pattern | Examples | DS needed? |
|
|
216
|
+
|---|---|---|
|
|
217
|
+
| **B — Pure display** (no PConnect) | AlertBanner, Banner, Operator, WssQuickCreate | Yes — DS provides alert/card/avatar primitives |
|
|
218
|
+
| **A — PConnect display** | CaseSummaryFields, DetailsFields, FieldValueList | Minimal — CSS-based layout; DS typography optional |
|
|
219
|
+
| **C — Complex display** (PConnect bridge) | FieldGroup, FieldGroupList, Pulse | No — PConnect bridge is DS-agnostic; semantic HTML |
|
|
220
|
+
|
|
221
|
+
The component-specific skill file specifies which pattern applies.
|
|
222
|
+
|
|
223
|
+
**1. Check the component-specific skill file** — `.claude/skills/design-system-extension-skills/<ComponentName>.md` contains a **Design System Mapping** table where available.
|
|
224
|
+
|
|
225
|
+
**2. If the chosen design system is not listed** — use the component purpose and pattern category above to pick the closest DS primitive.
|
|
226
|
+
|
|
227
|
+
**3. Discover the API from installed packages** — confirm component names and props from `.d.ts` before writing JSX:
|
|
228
|
+
```bash
|
|
229
|
+
find node_modules/<ds-package> -name "*.d.ts" | xargs grep -l "Alert\|Badge\|Avatar" | head -5
|
|
230
|
+
grep -A 30 "interface.*Props" <path-to-file>
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
**4. Variant mapping** — always map Pega's variant names to your DS equivalent before passing to DS components:
|
|
234
|
+
|
|
235
|
+
| Pega variant | Meaning | Typical DS equivalent |
|
|
236
|
+
|---|---|---|
|
|
237
|
+
| `urgent` | Critical / error | `error`, `danger`, `critical` |
|
|
238
|
+
| `warning` | Warning | `warning` |
|
|
239
|
+
| `info` | Informational | `info` |
|
|
240
|
+
| `success` | Success | `success` |
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## Registration
|
|
245
|
+
|
|
246
|
+
Register DSE components in `src/components/component-map.ts`:
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
import AlertBanner from './designSystemExtension/AlertBanner';
|
|
250
|
+
import FieldValueList from './designSystemExtension/FieldValueList';
|
|
251
|
+
|
|
252
|
+
// In getSampleComponentMap():
|
|
253
|
+
{
|
|
254
|
+
...sdkComponents,
|
|
255
|
+
AlertBanner,
|
|
256
|
+
FieldValueList,
|
|
257
|
+
}
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
## Existing DSE Components
|
|
263
|
+
|
|
264
|
+
| Component | PConnect? | Description |
|
|
265
|
+
| ----------------- | --------- | --------------------------------------- |
|
|
266
|
+
| AlertBanner | No | Alert/notification banner with variants |
|
|
267
|
+
| Banner | No | Promotional/informational banner |
|
|
268
|
+
| CaseSummaryFields | Yes | Summary fields for case header |
|
|
269
|
+
| DetailsFields | Yes | Key-value fields in a details region |
|
|
270
|
+
| FieldGroup | Yes | Grouped fields with label/legend |
|
|
271
|
+
| FieldGroupList | Yes | List of field groups (repeating) |
|
|
272
|
+
| FieldValueList | Yes | Single field-value pair display |
|
|
273
|
+
| Operator | No | Operator avatar + name display |
|
|
274
|
+
| Pulse | Yes | Activity feed/comments stream |
|
|
275
|
+
| RichTextEditor | Yes | Rich text editor (TinyMCE-based) |
|
|
276
|
+
| WssQuickCreate | No | WSS quick case creation component |
|
|
277
|
+
|
|
278
|
+
---
|
|
279
|
+
|
|
280
|
+
## Key Conventions
|
|
281
|
+
|
|
282
|
+
1. **Default export** — `export default function ComponentName`.
|
|
283
|
+
2. **Flexible messages** — Always handle both `string` and `object` formats for text props (Pega may send either).
|
|
284
|
+
3. **No side effects** — DSE components should be pure renderers. No data fetching or mutations.
|
|
285
|
+
4. **Variant mapping** — Map Pega variant names (urgent, warning, etc.) to your design system's equivalents.
|
|
286
|
+
5. **Display modes** — If a DSE component is also used as a display mode by field components (e.g., FieldValueList), it should be simple and fast to render.
|
|
287
|
+
6. **Graceful fallbacks** — Handle missing/undefined props gracefully with defaults.
|
|
288
|
+
7. **CSS over styled-components** — DSE components in react-sample typically use plain CSS files or MUI `sx` prop, not styled-components.
|
|
289
|
+
8. **Accessible markup** — Use semantic HTML (fieldset/legend for groups, proper heading levels, ARIA labels).
|