@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,164 @@
|
|
|
1
|
+
# Skill: Multiselect
|
|
2
|
+
|
|
3
|
+
Multi-select autocomplete field supporting flat lists, grouped/hierarchical data, reference list binding, and debounced search.
|
|
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 multi-value typeahead input where users can search and select multiple items. Supports flat datasources, grouped/hierarchical data, reference lists (embedded page lists), and debounced async search. Manages selection state and commits changes via reference list instructions.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Multiselect`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Picklist-Multi`
|
|
17
|
+
- **Registration key:** `Multiselect` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
> **Note:** `Multiselect` does NOT extend `PConnFieldProps` — it uses raw `props` (no typed interface in the reference implementation). Define props as needed for your implementation.
|
|
20
|
+
|
|
21
|
+
## Props (component-specific)
|
|
22
|
+
|
|
23
|
+
| Prop | Type | Default | Description |
|
|
24
|
+
|------|------|---------|-------------|
|
|
25
|
+
| `getPConnect` | `function` | — | PConnect accessor |
|
|
26
|
+
| `label` | `string` | — | Field label |
|
|
27
|
+
| `placeholder` | `string` | — | Input placeholder |
|
|
28
|
+
| `referenceList` | `any[]` | — | Currently selected items from embedded page list |
|
|
29
|
+
| `selectionKey` | `string` | — | Property path used as the selection key |
|
|
30
|
+
| `primaryField` | `string` | — | Property path for the primary display field |
|
|
31
|
+
| `initialCaseClass` | `string` | — | Case class for context in search |
|
|
32
|
+
| `selectionList` | `string` | — | Property path of the reference list |
|
|
33
|
+
| `datasource` | `any[]` | `[]` | Flat data source |
|
|
34
|
+
| `columns` | `any[]` | `[{}]` | Column config for key/value extraction |
|
|
35
|
+
| `listType` | `string` | `''` | `'associated'`, `'datapage'`, `'promptList'`, `'localList'` |
|
|
36
|
+
| `isGroupData` | `boolean` | `false` | Whether to use grouped/hierarchical data |
|
|
37
|
+
| `groupDataSource` | `any[]` | `[]` | Data source for grouped display |
|
|
38
|
+
| `groupColumnsConfig` | `any[]` | `[{}]` | Column config for group display |
|
|
39
|
+
| `referenceType` | `string` | — | `'Case'` or `'Data'` |
|
|
40
|
+
| `secondaryFields` | `any` | — | Additional secondary display fields |
|
|
41
|
+
| `showSecondaryInSearchOnly` | `boolean` | `false` | Show secondary fields only during search |
|
|
42
|
+
| `parameters` | `object` | `{}` | Data page query parameters |
|
|
43
|
+
| `matchPosition` | `string` | `'contains'` | Search match position (`'contains'`, `'startsWith'`) |
|
|
44
|
+
| `maxResultsDisplay` | `string` | — | Max results to display (`'100'` default) |
|
|
45
|
+
| `value` | `any` | — | Current value |
|
|
46
|
+
|
|
47
|
+
## Behavioral Contract
|
|
48
|
+
|
|
49
|
+
### Reference List Mode (when `referenceList.length > 0`)
|
|
50
|
+
|
|
51
|
+
When `referenceList` has items, override datasource and columns:
|
|
52
|
+
- `datasource = referenceList`
|
|
53
|
+
- Build `columns`: primary display field, key field, secondary columns (from `secondaryFields` or default to `selectionKey`)
|
|
54
|
+
- If `referenceType === 'Case'`: append secondary columns
|
|
55
|
+
|
|
56
|
+
### Data Config
|
|
57
|
+
|
|
58
|
+
Build a `dataConfig` object (memoized with deep comparison) containing:
|
|
59
|
+
- `dataSource`, `groupDataSource`, `isGroupData`, `showSecondaryInSearchOnly`, `parameters`, `matchPosition`, `listType`, `maxResultsDisplay`
|
|
60
|
+
- `columns`: preprocessed (strip leading `.` from value fields)
|
|
61
|
+
- `groupColumnsConfig`: preprocessed
|
|
62
|
+
|
|
63
|
+
### Items Tree
|
|
64
|
+
|
|
65
|
+
- `displayFieldMeta`: derived from `columns` when `listType !== 'associated'`
|
|
66
|
+
- `groupsDisplayFieldMeta`: derived from `groupColumnsConfig` when `listType !== 'associated'`
|
|
67
|
+
- `itemsTree` state: for `isGroupData` mode, initialized from `getGroupDataForItemsTree(groupDataSource, groupsDisplayFieldMeta, showSecondaryInSearchOnly)`; otherwise `[]`
|
|
68
|
+
|
|
69
|
+
### Data API Initialization
|
|
70
|
+
|
|
71
|
+
In `useEffect` watching `dataConfig` (non-associated lists):
|
|
72
|
+
```
|
|
73
|
+
PCore.getDataApi().init(dataConfig, contextName).then(dataObj => {
|
|
74
|
+
dataApiObj.current = dataObj
|
|
75
|
+
if (!isGroupData) {
|
|
76
|
+
getCaseListBasedOnParamsDebounced.current(inputValue ?? '', '', [...selectedItems], [...itemsTree])
|
|
77
|
+
}
|
|
78
|
+
})
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Search
|
|
82
|
+
|
|
83
|
+
`getCaseListBasedOnParams(searchText, group, selectedRows, currentItemsTree, isTriggeredFromSearch)`:
|
|
84
|
+
1. If `referenceList.length > 0`: get currently selected rows from `listActions.getSelectedRows(true)`, map to `{id, primary}` format, update `selectedItems` state.
|
|
85
|
+
2. Build `initalItemsTree`: use fresh data if `isTriggeredFromSearch || !currentItemsTree`, else current.
|
|
86
|
+
3. Call `doSearch(...)` to get filtered results.
|
|
87
|
+
4. `setItemsTree(results)`.
|
|
88
|
+
|
|
89
|
+
**Debounce:** 500ms debounce on `getCaseListBasedOnParams` via `getCaseListBasedOnParamsDebounced` ref.
|
|
90
|
+
|
|
91
|
+
### Mount Effects
|
|
92
|
+
|
|
93
|
+
- `useEffect([pConn])`: if `referenceList.length > 0`, call `pConn.setReferenceList(selectionList)`.
|
|
94
|
+
- `useEffect([])`: set up debounced search ref.
|
|
95
|
+
|
|
96
|
+
### Selection Changes (`handleChange`)
|
|
97
|
+
|
|
98
|
+
When selection changes (user adds/removes item):
|
|
99
|
+
1. Mark all currently selected items as `selected: true`.
|
|
100
|
+
2. Determine if this was an add or remove.
|
|
101
|
+
3. Update `itemsTree` selections in-place.
|
|
102
|
+
4. `setSelectedItems(updatedItems)`, `setItemsTree(itemsTree)`.
|
|
103
|
+
5. Reset `inputValue` to `''`.
|
|
104
|
+
6. If `referenceList`: call `setSelectedItemsForReferenceList(clickedItem[0])`.
|
|
105
|
+
|
|
106
|
+
`setSelectedItemsForReferenceList`: calls `insertInstruction` (if `selected: true`) or `deleteInstruction` (if `selected: false`) and clears error messages.
|
|
107
|
+
|
|
108
|
+
### Search Input
|
|
109
|
+
|
|
110
|
+
`onSearchHandler`: updates `inputValue` state and calls debounced search with `isTriggeredFromSearch=true`.
|
|
111
|
+
|
|
112
|
+
## Display Mode Rendering
|
|
113
|
+
|
|
114
|
+
No explicit `displayMode` handling in the reference implementation — Multiselect is rendered directly by parent components when display mode is needed. If `displayMode` support is needed, implement similar to Dropdown.
|
|
115
|
+
|
|
116
|
+
## Visual Specifications
|
|
117
|
+
|
|
118
|
+
| Property | Value |
|
|
119
|
+
|----------|-------|
|
|
120
|
+
| Width | 100% |
|
|
121
|
+
| Size | Small |
|
|
122
|
+
| Variant | Outlined |
|
|
123
|
+
| Multiple values | Tags/chips shown inside the input box |
|
|
124
|
+
| Dropdown | Shows filtered options with checkboxes |
|
|
125
|
+
| Close on select | Off (`disableCloseOnSelect`) — user can select multiple before closing |
|
|
126
|
+
| Option label | `option.primary` field |
|
|
127
|
+
| Placeholder | From `placeholder` prop |
|
|
128
|
+
| Error state | Red border + red helper text |
|
|
129
|
+
|
|
130
|
+
**CSS-only notes:**
|
|
131
|
+
```css
|
|
132
|
+
.multiselect-tags { display: flex; flex-wrap: wrap; gap: 4px; padding: 4px; border: 1px solid rgba(0,0,0,0.23); border-radius: 4px; }
|
|
133
|
+
.multiselect-tag { background: rgba(0,0,0,0.08); border-radius: 16px; padding: 2px 8px; font-size: 0.8125rem; display: flex; align-items: center; gap: 4px; }
|
|
134
|
+
.multiselect-tag-delete { cursor: pointer; font-size: 0.75rem; }
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Edge Cases & Special Logic
|
|
138
|
+
|
|
139
|
+
- **`dataConfig` deep memoization:** Use custom deep-equal hook (`useDeepMemo`) to avoid re-initializing data API on every render.
|
|
140
|
+
- `itemsTreeBaseData` is fixed at render time — used as the base for each fresh search.
|
|
141
|
+
- When `isGroupData=false`: debounced search fires after data API init.
|
|
142
|
+
- When `isGroupData=true`: groups are pre-populated from `groupDataSource`.
|
|
143
|
+
- The `selected` flag on items in `itemsTree` tracks selection state in the dropdown.
|
|
144
|
+
|
|
145
|
+
## Dependencies
|
|
146
|
+
|
|
147
|
+
- `doSearch`, `getDisplayFieldsMetaData`, `useDeepMemo`, `preProcessColumns`, `getGroupDataForItemsTree` from `./utils` (local utils file).
|
|
148
|
+
- `insertInstruction`, `deleteInstruction` from `../../helpers/instructions-utils`.
|
|
149
|
+
- `debounce` from `throttle-debounce` library (or any debounce utility).
|
|
150
|
+
- `PCore.getDataApi()` — for data initialization.
|
|
151
|
+
- Multi-select autocomplete UI widget.
|
|
152
|
+
|
|
153
|
+
## Design System Mapping
|
|
154
|
+
|
|
155
|
+
**UI control type:** Multi-select combobox with tags/chips and searchable dropdown.
|
|
156
|
+
|
|
157
|
+
Listed design systems are examples only.
|
|
158
|
+
|
|
159
|
+
| Design System | Recommended Component |
|
|
160
|
+
|---|---|
|
|
161
|
+
| Default (CSS only) | Custom tag input + filterable dropdown list |
|
|
162
|
+
| MUI | `<Autocomplete multiple disableCloseOnSelect>` |
|
|
163
|
+
| Ant Design | `<Select mode="multiple" showSearch>` |
|
|
164
|
+
| Chakra UI | Third-party multi-select (e.g., Chakra React Select) |
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# Skill: ObjectReference
|
|
2
|
+
|
|
3
|
+
Composite field that dynamically renders a child component (Dropdown, AutoComplete, or SemanticLink) for referencing another Pega case or data object. Supports editable-in-review mode with direct case update.
|
|
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
|
+
Does NOT render a UI control directly. Instead, it reads the raw metadata to determine which child component type to render (`Dropdown`, `AutoComplete`, or `SemanticLink`), constructs that child component via `getPConnect().createComponent(...)`, and renders it inside a grid container. Also handles editable-in-review mode where the user can change a reference field while viewing a case.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `ObjectReference`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Reference`
|
|
17
|
+
- **Registration key:** `ObjectReference` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
> Uses `Omit<PConnFieldProps, 'value'>` — no direct `value` prop.
|
|
22
|
+
|
|
23
|
+
| Prop | Type | Default | Description |
|
|
24
|
+
|------|------|---------|-------------|
|
|
25
|
+
| `getPConnect` | `any` | — | PConnect accessor |
|
|
26
|
+
| `displayMode` | `any` | — | Display mode |
|
|
27
|
+
| `allowAndPersistChangesInReviewMode` | `any` | `false` | Whether the reference can be edited while in review/display mode |
|
|
28
|
+
| `targetObjectType` | `any` | — | `'case'` or `'data'` — determines `referenceType` |
|
|
29
|
+
| `mode` | `string` | `''` | `'single'` or `'multi'` (SELECTION_MODE) |
|
|
30
|
+
| `parameters` | `object` | — | Data page query parameters |
|
|
31
|
+
| `hideLabel` | `boolean` | `false` | Whether to hide label |
|
|
32
|
+
| `inline` | `boolean` | `false` | Whether to render inline |
|
|
33
|
+
| `showPromotedFilters` | `boolean` | `false` | Show promoted filters in child |
|
|
34
|
+
| `additionalFields` | `any` | — | Additional fields for read-only display |
|
|
35
|
+
|
|
36
|
+
## Behavioral Contract
|
|
37
|
+
|
|
38
|
+
### Setup
|
|
39
|
+
|
|
40
|
+
1. `referenceType = targetObjectType === 'case' ? 'Case' : 'Data'`
|
|
41
|
+
2. `rawViewMetadata = pConn.getRawMetadata()` — the raw component metadata from Pega config
|
|
42
|
+
3. `refFieldMetadata = pConn.getFieldMetadata(rawViewMetadata?.config?.value?.split('.', 2)[1])`
|
|
43
|
+
4. `propsToUse = { ...pConn.getInheritedProps(), ...props }` — merged inherited + local props
|
|
44
|
+
5. `isDisplayModeEnabled = displayMode === 'DISPLAY_ONLY'`
|
|
45
|
+
6. `canBeChangedInReviewMode = editableInReview && ['Autocomplete', 'Dropdown'].includes(rawViewMetadata.config.componentType)`
|
|
46
|
+
|
|
47
|
+
### Subsection: Read-only variants (display mode, non-editable)
|
|
48
|
+
|
|
49
|
+
**If `componentType === 'SemanticLink'` and `!canBeChangedInReviewMode`:**
|
|
50
|
+
Build a SemanticLink config from rawViewMetadata and call `getPConnect().createComponent({ type: 'SemanticLink', config: {...} })`. Config includes:
|
|
51
|
+
- `displayField` → `primaryField` and `text`
|
|
52
|
+
- `value` → `caseID`
|
|
53
|
+
- `resourceParams: { workID: value }`, `resourcePayload: { caseClassName: caseClass }`
|
|
54
|
+
- `displayMode`, `referenceType`, `hideLabel`, `dataRelationshipContext`
|
|
55
|
+
|
|
56
|
+
**If `isDisplayModeEnabled && !canBeChangedInReviewMode` (other types):**
|
|
57
|
+
Render `<SingleReferenceReadonly>` with config from `rawViewMetadata.config`, passing:
|
|
58
|
+
- `label`, `type`, `displayAs='readonly'`, `displayMode`, `referenceType`, `hideLabel`, `dataRelationshipContext`, `additionalFields`
|
|
59
|
+
|
|
60
|
+
### Subsection: Editable variants (including editable-in-review)
|
|
61
|
+
|
|
62
|
+
**If NOT in a read-only case:**
|
|
63
|
+
|
|
64
|
+
1. **Set datasource:** Call `generateColumns(rawViewMetadata.config, pConn, referenceType)` to populate column config.
|
|
65
|
+
- Set `rawViewMetadata.config.deferDatasource = true`
|
|
66
|
+
- Set `rawViewMetadata.config.listType = 'datapage'`
|
|
67
|
+
- Set default placeholder `'@L Select...'` for Dropdown/AutoComplete if missing
|
|
68
|
+
|
|
69
|
+
2. **Pass-through configs:**
|
|
70
|
+
- `rawViewMetadata.config.showPromotedFilters = showPromotedFilters`
|
|
71
|
+
- If `!canBeChangedInReviewMode`: set `rawViewMetadata.config.displayMode = displayMode`
|
|
72
|
+
|
|
73
|
+
3. **Build fieldMetaData:**
|
|
74
|
+
```
|
|
75
|
+
fieldMetaData = { datasourceMetadata: { datasource: { parameters: {} } } }
|
|
76
|
+
```
|
|
77
|
+
- Set `propertyForDisplayText` from `datasource.fields.text` (strip `@P ` prefix)
|
|
78
|
+
- Set `propertyForValue` from `datasource.fields.value` (strip `@P ` prefix)
|
|
79
|
+
- Set `name` from `referenceList`
|
|
80
|
+
- If `rawViewMetadata.config.parameters`: assign `parameters` prop
|
|
81
|
+
|
|
82
|
+
4. **Create child component:**
|
|
83
|
+
```
|
|
84
|
+
getPConnect().createComponent({
|
|
85
|
+
type, // 'Dropdown' or 'AutoComplete'
|
|
86
|
+
config: {
|
|
87
|
+
...rawViewMetadata.config,
|
|
88
|
+
descriptors: mode === SELECTION_MODE.SINGLE ? refFieldMetadata?.descriptors : null,
|
|
89
|
+
datasourceMetadata: fieldMetaData.datasourceMetadata,
|
|
90
|
+
required, visibility, disabled, label, parameters, readOnly: false,
|
|
91
|
+
localeReference, referenceType (for single mode only),
|
|
92
|
+
contextClass: targetObjectClass,
|
|
93
|
+
primaryField: displayField,
|
|
94
|
+
dataRelationshipContext,
|
|
95
|
+
hideLabel, onRecordChange, inline
|
|
96
|
+
}
|
|
97
|
+
})
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### `onRecordChange` handler
|
|
101
|
+
|
|
102
|
+
Called when user selects a new value in editable/editable-in-review mode:
|
|
103
|
+
1. Build `refreshOptions = { autoDetectRefresh: true, propertyName: rawViewMetadata.config?.value }`
|
|
104
|
+
2. If `!canBeChangedInReviewMode || !pConn.getValue('__currentPageTabViewName')`: call `getPConnect().getActionsApi().refreshCaseView(caseKey, viewName, pgRef, refreshOptions)`.
|
|
105
|
+
3. Extract `propValue = event?.id || event?.target?.value`.
|
|
106
|
+
4. For multi mode (`SimpleTableSelect`): `propName = getPropertyName(rawViewMetadata.config.selectionList)`, else `propName = getPropertyName(rawViewMetadata.config.value)`.
|
|
107
|
+
5. If `propValue && canBeChangedInReviewMode && isDisplayModeEnabled`:
|
|
108
|
+
- Get edit lock via `PCore.getCaseUtils().getCaseEditLock(caseKey, '')`
|
|
109
|
+
- Build commit data from page reference path
|
|
110
|
+
- Call `PCore.getCaseUtils().updateCaseEditFieldsData(...)` to persist the change
|
|
111
|
+
- Update container's last update time and etag
|
|
112
|
+
|
|
113
|
+
### Memoization
|
|
114
|
+
|
|
115
|
+
`recreatedFirstChild` is memoized with `useMemo` — dependencies: `rawViewMetadata.config?.datasource?.source`, `parameters`, `propsToUse.required`, `propsToUse.disabled`, `getPConnect().getPageReference()`.
|
|
116
|
+
|
|
117
|
+
## Display Mode Rendering
|
|
118
|
+
|
|
119
|
+
Display mode is passed through to the child component — the child (Dropdown, AutoComplete, SemanticLink, or SingleReferenceReadonly) handles its own display mode rendering.
|
|
120
|
+
|
|
121
|
+
## Visual Specifications
|
|
122
|
+
|
|
123
|
+
ObjectReference itself renders a minimal grid container:
|
|
124
|
+
```
|
|
125
|
+
<Grid container>
|
|
126
|
+
<Grid>{recreatedFirstChild}</Grid>
|
|
127
|
+
</Grid>
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
The visual appearance is entirely determined by the child component being rendered. No additional styling is applied by `ObjectReference` itself.
|
|
131
|
+
|
|
132
|
+
**CSS-only implementation:**
|
|
133
|
+
```css
|
|
134
|
+
.object-reference-container { display: grid; width: 100%; }
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Edge Cases & Special Logic
|
|
138
|
+
|
|
139
|
+
- **`generateColumns`**: a utility from `./utils` that populates `rawViewMetadata.config` with proper column definitions for the child Dropdown/AutoComplete.
|
|
140
|
+
- **`getDataRelationshipContextFromKey`**: extracts the relationship context from a field key (also from `./utils`).
|
|
141
|
+
- `rawViewMetadata.config` is mutated in place before being passed to `createComponent` — this is intentional but means the component re-creates the child on relevant prop changes.
|
|
142
|
+
- For `SemanticLink` type, the child is created via `createComponent`, not rendered as a direct React element.
|
|
143
|
+
- `SELECTION_MODE.SINGLE` and `SELECTION_MODE.MULTI` constants from `./utils`.
|
|
144
|
+
|
|
145
|
+
## Dependencies
|
|
146
|
+
|
|
147
|
+
- `SELECTION_MODE`, `generateColumns`, `getDataRelationshipContextFromKey` from `./utils` (local).
|
|
148
|
+
- `getComponentFromRegistry('SingleReferenceReadOnly')` — for display-only non-SemanticLink.
|
|
149
|
+
- `PCore.getCaseUtils()`, `PCore.getAnnotationUtils()`, `PCore.getContainerUtils()` — for editable-in-review updates.
|
|
150
|
+
- `useMemo` from React.
|
|
151
|
+
- No `handleEvent` — selection handling is done by the child component via `onRecordChange`.
|
|
152
|
+
|
|
153
|
+
## Design System Mapping
|
|
154
|
+
|
|
155
|
+
**UI control type:** Composite wrapper — renders Dropdown, AutoComplete, SemanticLink, or SingleReferenceReadonly. No dedicated UI control.
|
|
156
|
+
|
|
157
|
+
Listed design systems are examples only.
|
|
158
|
+
|
|
159
|
+
| Scenario | Rendered Child |
|
|
160
|
+
|----------|----------------|
|
|
161
|
+
| `componentType='Dropdown'` (editable) | `Dropdown` component |
|
|
162
|
+
| `componentType='AutoComplete'` (editable) | `AutoComplete` component |
|
|
163
|
+
| `componentType='SemanticLink'` | `SemanticLink` component |
|
|
164
|
+
| `displayMode='DISPLAY_ONLY'` (non-editable-in-review) | `SingleReferenceReadonly` component |
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Skill: Percentage
|
|
2
|
+
|
|
3
|
+
Percentage numeric input with a `%` suffix and locale-aware decimal/thousands separators.
|
|
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 numeric input for percentage values. Always appends a `%` suffix in the input. Supports configurable decimal precision and optional thousands separator. Shows a formatted percentage string in display modes.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Percentage`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Decimal-Percentage`
|
|
17
|
+
- **Registration key:** `Percentage` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Default | Description |
|
|
22
|
+
|------|------|---------|-------------|
|
|
23
|
+
| `currencyISOCode` | `string` (optional) | `'USD'` | ISO code used for locale-aware decimal/thousands separator lookup only (not for currency symbol) |
|
|
24
|
+
| `showGroupSeparators` | `string` (optional) | — | Whether to show thousands separators (passed as string, truthy check applies) |
|
|
25
|
+
| `decimalPrecision` | `number` (optional) | — | Number of decimal places |
|
|
26
|
+
|
|
27
|
+
## Behavioral Contract
|
|
28
|
+
|
|
29
|
+
1. **Local state:** Maintain `values` (string). Initialize from `value.toString()`.
|
|
30
|
+
2. **Sync from store:** `useEffect` watching `value` → `setValues(value.toString())`.
|
|
31
|
+
3. **Separators:** Derive `decimalSeparator` and `thousandSeparator` from locale lookup using `currencyISOCode` (same as Currency/Decimal). Apply `thousandSeparator` only when `showGroupSeparators` is truthy.
|
|
32
|
+
4. **Suffix:** Always append `%` suffix to the numeric input.
|
|
33
|
+
5. **Decimal scale:** Use `decimalPrecision` prop.
|
|
34
|
+
6. **No prefix:** Unlike Currency, no prefix symbol.
|
|
35
|
+
7. **On value change:** Update local `values` state with the raw numeric string.
|
|
36
|
+
8. **On blur:** Commit via `handleEvent(actions, 'changeNblur', propName, values)`.
|
|
37
|
+
9. **Read-only:** Set `readOnly: true` on the input. Flat/borderless style. `onBlur` omitted.
|
|
38
|
+
|
|
39
|
+
## Display Mode Rendering
|
|
40
|
+
|
|
41
|
+
Format the value using the percentage formatter before display:
|
|
42
|
+
- `formattedValue = format(value, pConn.getComponentName()?.toLowerCase(), currencyOptions)`
|
|
43
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={formattedValue} />`.
|
|
44
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={formattedValue} variant='stacked' />`.
|
|
45
|
+
|
|
46
|
+
## Read-Only Rendering
|
|
47
|
+
|
|
48
|
+
Keep numeric format input with `readOnly: true` and `%` suffix still visible. Flat/borderless style.
|
|
49
|
+
|
|
50
|
+
## Visual Specifications
|
|
51
|
+
|
|
52
|
+
| Property | Value |
|
|
53
|
+
|----------|-------|
|
|
54
|
+
| Width | 100% |
|
|
55
|
+
| Size | Small |
|
|
56
|
+
| Variant editable | Outlined |
|
|
57
|
+
| Variant read-only | Standard (flat) |
|
|
58
|
+
| Suffix | `%` (always shown after the value) |
|
|
59
|
+
| Thousands separator | Only when `showGroupSeparators` is truthy |
|
|
60
|
+
| Decimal scale | `decimalPrecision` |
|
|
61
|
+
| Placeholder | From `placeholder` prop |
|
|
62
|
+
| Error state | Red border + red helper text |
|
|
63
|
+
|
|
64
|
+
**CSS-only notes:** Achieve the `%` suffix by wrapping the input in a relative container and absolutely positioning a `%` label at the right side, or using an input with a `::after` pseudo-element technique.
|
|
65
|
+
|
|
66
|
+
## Edge Cases & Special Logic
|
|
67
|
+
|
|
68
|
+
- `showGroupSeparators` is typed as `string` (not `boolean`) in the reference implementation — apply truthy check.
|
|
69
|
+
- `currencyISOCode` is only used for separator lookup (decimal/thousands), NOT for a currency symbol.
|
|
70
|
+
- The stored value is always a raw numeric string (e.g., `'45.5'`), not `'45.5%'`.
|
|
71
|
+
|
|
72
|
+
## Dependencies
|
|
73
|
+
|
|
74
|
+
- Numeric formatting library (e.g., `react-number-format`'s `NumericFormat`).
|
|
75
|
+
- `getCurrencyCharacters(currencyISOCode)` — for `theDecimalIndicator`, `theDigitGroupSeparator`.
|
|
76
|
+
- `getCurrencyOptions(currencyISOCode)` — for `format()` call.
|
|
77
|
+
- `format()` from `../../helpers/formatters`.
|
|
78
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
79
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
80
|
+
|
|
81
|
+
## Design System Mapping
|
|
82
|
+
|
|
83
|
+
**UI control type:** Percentage numeric input with `%` suffix.
|
|
84
|
+
|
|
85
|
+
Listed design systems are examples only.
|
|
86
|
+
|
|
87
|
+
| Design System | Recommended Component |
|
|
88
|
+
|---|---|
|
|
89
|
+
| Default (CSS only) | `<input type="text">` + custom masking + `%` suffix span |
|
|
90
|
+
| MUI | `NumericFormat` with `suffix='%'` and `customInput={TextField}` |
|
|
91
|
+
| Ant Design | `<InputNumber suffix="%" precision={decimalPrecision} />` |
|
|
92
|
+
| Chakra UI | `<NumberInput>` + `<InputRightAddon>%</InputRightAddon>` |
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# Skill: Phone
|
|
2
|
+
|
|
3
|
+
Telephone input field with country code selector, 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 telephone number input with an integrated country code selector (flag + dial code). Stores the phone number in E.164 format (e.g., `+15551234567`). Uses a specialized phone input library for the country picker. Separate handling for read-only mode (keeps country picker but sets input as read-only).
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Phone`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Text-Phone`
|
|
17
|
+
- **Registration key:** `Phone` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
No props beyond `PConnFieldProps`. Import type as:
|
|
22
|
+
```typescript
|
|
23
|
+
import type { PConnFieldProps } from '@pega/sdk-react';
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Behavioral Contract
|
|
27
|
+
|
|
28
|
+
1. **Local state:** Maintain `inputValue` (string). Initialize from `value` prop. `useEffect` watching `value` → `setInputValue(value)`.
|
|
29
|
+
2. **Default country:** `'US'` — the country code selector defaults to United States.
|
|
30
|
+
3. **On change (editable):** Update local `inputValue` state with the formatted phone string from the library callback.
|
|
31
|
+
4. **On blur (editable):** Extract and normalize the phone number to E.164 format:
|
|
32
|
+
```
|
|
33
|
+
const phoneValue = event?.target?.value
|
|
34
|
+
let phoneNumber = phoneValue.split(' ').slice(1).join() // remove country code prefix
|
|
35
|
+
phoneNumber = phoneNumber ? `+${phoneValue.replace(/\D+/g, '')}` : ''
|
|
36
|
+
handleEvent(actions, 'changeNblur', propName, phoneNumber)
|
|
37
|
+
```
|
|
38
|
+
5. **Read-only:** Render the phone input with `readOnly: true` on the input element and `disableDropdown: true` (country picker dropdown disabled). Keep the country flag/code visible but non-interactive. `onBlur` and `onChange` are NOT committed — use the `onChange` prop from the component itself but disable dropdown.
|
|
39
|
+
6. **testId:** Pass as attribute on the input element.
|
|
40
|
+
|
|
41
|
+
## Display Mode Rendering
|
|
42
|
+
|
|
43
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={value} />` — raw phone string.
|
|
44
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />`.
|
|
45
|
+
|
|
46
|
+
## Read-Only Rendering
|
|
47
|
+
|
|
48
|
+
Render phone input with `readOnly: true` and `disableDropdown: true` on the country picker. The `onChange` prop is `onChange` from `PConnFieldProps` (passed through). Wrapped in a `<div>`.
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
<div>
|
|
52
|
+
<PhoneInput
|
|
53
|
+
readOnly: true on input
|
|
54
|
+
disableDropdown={true}
|
|
55
|
+
onChange={onChange} // from props — not local handler
|
|
56
|
+
value={value}
|
|
57
|
+
defaultCountry='US'
|
|
58
|
+
/>
|
|
59
|
+
</div>
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Visual Specifications
|
|
63
|
+
|
|
64
|
+
| Property | Editable | Read-only |
|
|
65
|
+
|----------|----------|-----------|
|
|
66
|
+
| Width | 100% | 100% |
|
|
67
|
+
| Size | Small | Small |
|
|
68
|
+
| Variant | Outlined | Outlined (same, with readOnly input) |
|
|
69
|
+
| Country selector | Dropdown with flag + dial code | Flag + dial code shown, dropdown disabled |
|
|
70
|
+
| Default country | US (`+1`) | US (`+1`) |
|
|
71
|
+
| Error state | Red border + red helper text | — |
|
|
72
|
+
| Helper text | Below input | Below input |
|
|
73
|
+
|
|
74
|
+
**CSS-only notes:**
|
|
75
|
+
For a CSS-only implementation, create a two-part input:
|
|
76
|
+
```css
|
|
77
|
+
.phone-input-wrapper { display: flex; border: 1px solid rgba(0,0,0,0.23); border-radius: 4px; overflow: hidden; }
|
|
78
|
+
.phone-country-select { border: none; border-right: 1px solid rgba(0,0,0,0.23); padding: 0 8px; background: none; }
|
|
79
|
+
.phone-number-input { flex: 1; border: none; padding: 8px 12px; font-size: 0.875rem; outline: none; }
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Edge Cases & Special Logic
|
|
83
|
+
|
|
84
|
+
- **E.164 normalization on blur:** Strip all non-digit chars from the full value (including country code), then prepend `+`. If the result after stripping the country part is empty, store `''`.
|
|
85
|
+
- **Read-only uses `onChange` from props** (not the local `handleChange`) — this is the platform-wired handler, not our local state updater. Do NOT call `handleEvent` in read-only mode.
|
|
86
|
+
- `disableDropdown: true` in read-only — prevents country switching.
|
|
87
|
+
- The library provides the formatted display value (e.g., `+1 (555) 123-4567`) in the callback; we normalize it to E.164 only on blur.
|
|
88
|
+
|
|
89
|
+
## Dependencies
|
|
90
|
+
|
|
91
|
+
- A phone input library with country code selector and E.164 formatting support (e.g., `mui-tel-input`).
|
|
92
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
93
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
94
|
+
|
|
95
|
+
**For CSS-only / non-library implementations:**
|
|
96
|
+
- Use a `<select>` for country code + a text `<input>` for the number.
|
|
97
|
+
- On blur, combine dial code + number and strip non-digits, then format as `+{digits}`.
|
|
98
|
+
|
|
99
|
+
## Design System Mapping
|
|
100
|
+
|
|
101
|
+
**UI control type:** Telephone input with integrated country code selector.
|
|
102
|
+
|
|
103
|
+
Listed design systems are examples only.
|
|
104
|
+
|
|
105
|
+
| Design System | Recommended Component |
|
|
106
|
+
|---|---|
|
|
107
|
+
| Default (CSS only) | `<select>` (country) + `<input type="tel">` |
|
|
108
|
+
| MUI | `<MuiTelInput>` from `mui-tel-input` |
|
|
109
|
+
| Ant Design | `<Input addonBefore={countrySelect}>` |
|
|
110
|
+
| Chakra UI | `<InputGroup>` with `<InputLeftAddon>` for country |
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
# Skill: RadioButtons
|
|
2
|
+
|
|
3
|
+
Radio button group field with optional card-style variant and localized option labels.
|
|
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 group of radio buttons for single-selection from a list of options. Supports standard radio button layout (inline or stacked) and a card-style visual variant. Option labels are localized. Commits value immediately on selection.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `RadioButtons`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Picklist-Radio`
|
|
17
|
+
- **Registration key:** `RadioButtons` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Description |
|
|
22
|
+
|------|------|-------------|
|
|
23
|
+
| `inline` | `boolean` | If `true`, render radio buttons in a horizontal row; if `false`, vertical stack |
|
|
24
|
+
| `fieldMetadata` | `any` (optional) | For localization context (tableType, datasource name, display text property) |
|
|
25
|
+
| `variant` | `string` (optional) | `'card'` — renders options as selectable cards instead of radio buttons |
|
|
26
|
+
| `hideFieldLabels` | `boolean` (optional) | Hide field labels inside card variant |
|
|
27
|
+
| `additionalProps` | `any` (optional) | Extra props passed to `SelectableCard` in card variant |
|
|
28
|
+
| `imagePosition` | `string` (optional) | Card image position: `'inline-start'`, `'inline-end'`, or block |
|
|
29
|
+
| `imageSize` | `string` (optional) | Card image size |
|
|
30
|
+
| `showImageDescription` | `boolean` (optional) | Whether to show image description in cards |
|
|
31
|
+
| `datasource` | `any` (optional) | Datasource for card variant |
|
|
32
|
+
|
|
33
|
+
## Behavioral Contract
|
|
34
|
+
|
|
35
|
+
1. **Local state:** Maintain `theSelectedButton` (string). Initialize from `value` prop. `useEffect` watching `value` → `setSelectedButton(value)`.
|
|
36
|
+
2. **Options:** Load options from `Utils.getOptionList(theConfigProps, pConn.getDataObject(''))` — returns `Array<{key: string, value: string}>`.
|
|
37
|
+
3. **On change:** Commit via `handleEvent(actionsApi, 'changeNblur', propName, event.target.value)`.
|
|
38
|
+
4. **On blur:** Validate via `pConn.getValidationApi().validate(event.target.value, '')`. Second arg is empty string (optional parameter).
|
|
39
|
+
5. **Inline layout:** Use `row={inline}` on the radio group — horizontal when `inline=true`.
|
|
40
|
+
6. **Read-only:** Disable radio inputs (set `disabled` to `readOnly` value) — do NOT use a separate read-only component.
|
|
41
|
+
7. **Localization:** Option labels are localized via `pConn.getLocalizedValue(option.value, localePath, localeRuleName)`.
|
|
42
|
+
8. **Localization keys derivation:**
|
|
43
|
+
- Strip `@P ` prefix and leading `.` from `configProperty` (from `pConn.getRawMetadata()`).
|
|
44
|
+
- `localeContext`: `'datapage'` if `fieldMetadata.datasource.tableType === 'DataPage'`, else `'associated'`.
|
|
45
|
+
- `localeClass`: `'@baseclass'` for datapage, else `className`.
|
|
46
|
+
- `localeName`: datapage name or property name.
|
|
47
|
+
- `localePath`: display text property or localeName.
|
|
48
|
+
|
|
49
|
+
### Variant: Standard (default)
|
|
50
|
+
|
|
51
|
+
Render a radio group with `FormControl > FormLabel > RadioGroup > FormControlLabel (Radio)` pattern:
|
|
52
|
+
- `FormLabel`: the `label` prop
|
|
53
|
+
- `RadioGroup`: `value={theSelectedButton}`, `onChange={handleChange}`, `onBlur`, `row={inline}`
|
|
54
|
+
- Each `FormControlLabel`: `value={option.key}`, `label={localizedLabel}`, `control={<Radio color='primary' disabled={readOnly} />}`
|
|
55
|
+
- Wrap in `FormHelperText` for `helperTextToDisplay`
|
|
56
|
+
- `error={status === 'error'}` on `FormControl`
|
|
57
|
+
|
|
58
|
+
### Variant: Card (`variant === 'card'`)
|
|
59
|
+
|
|
60
|
+
Render a heading (`<h4>`) with the `label`, then delegate to `SelectableCard` component:
|
|
61
|
+
```
|
|
62
|
+
<div>
|
|
63
|
+
<h4 style={{ marginTop: 0, marginBottom: 0 }}>{label}</h4>
|
|
64
|
+
<div style={{ display: 'grid', gridTemplateColumns: 'repeat(auto-fit, minmax(min(200px, 100%), 1fr))', gap: '1rem' }}>
|
|
65
|
+
<SelectableCard
|
|
66
|
+
type='radio'
|
|
67
|
+
dataSource={datasource}
|
|
68
|
+
recordKey={stateProps.value?.split('.').pop()}
|
|
69
|
+
cardLabel={stateProps.primaryField?.split('.').pop()}
|
|
70
|
+
radioBtnValue={value}
|
|
71
|
+
onChange={handleChange}
|
|
72
|
+
image={{ imagePosition, imageSize, showImageDescription, imageField, imageDescription }}
|
|
73
|
+
setIsRadioCardSelected={displayMode !== 'DISPLAY_ONLY' ? setSelectedButton : undefined}
|
|
74
|
+
hideFieldLabels={hideFieldLabels}
|
|
75
|
+
additionalProps={additionalProps}
|
|
76
|
+
getPConnect={getPConnect}
|
|
77
|
+
/>
|
|
78
|
+
</div>
|
|
79
|
+
</div>
|
|
80
|
+
```
|
|
81
|
+
- `imageField`: `stateProps.image?.split('.').pop()`
|
|
82
|
+
- `imageDescription`: `stateProps.imageDescription?.split('.').pop()`
|
|
83
|
+
|
|
84
|
+
## Display Mode Rendering
|
|
85
|
+
|
|
86
|
+
Both modes render the localized display label of the selected option:
|
|
87
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={localizedValue} />`
|
|
88
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={localizedValue} variant='stacked' />`
|
|
89
|
+
|
|
90
|
+
Where `localizedValue = pConn.getLocalizedValue(value, localePath, localeRuleName)`.
|
|
91
|
+
|
|
92
|
+
## Visual Specifications
|
|
93
|
+
|
|
94
|
+
### Standard Variant
|
|
95
|
+
|
|
96
|
+
| Property | Value |
|
|
97
|
+
|----------|-------|
|
|
98
|
+
| Layout | Vertical stack (or horizontal row when `inline=true`) |
|
|
99
|
+
| Radio indicator | Circle button with filled inner circle when selected |
|
|
100
|
+
| Label | Label text to the right of the radio button (`labelPlacement='end'`) |
|
|
101
|
+
| Group label | `<legend>` / `<FormLabel>` above the group |
|
|
102
|
+
| Error state | Group border or text in red |
|
|
103
|
+
| Helper text | Below the group |
|
|
104
|
+
| Disabled (readOnly) | Greyed-out radio buttons, not-allowed cursor |
|
|
105
|
+
|
|
106
|
+
**CSS-only notes:**
|
|
107
|
+
```css
|
|
108
|
+
.radio-group { display: flex; flex-direction: column; gap: 4px; }
|
|
109
|
+
.radio-group.inline { flex-direction: row; flex-wrap: wrap; gap: 8px; }
|
|
110
|
+
.radio-label { display: flex; align-items: center; gap: 8px; cursor: pointer; }
|
|
111
|
+
input[type="radio"]:disabled { opacity: 0.38; cursor: default; }
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Card Variant
|
|
115
|
+
|
|
116
|
+
| Property | Value |
|
|
117
|
+
|----------|-------|
|
|
118
|
+
| Layout | CSS Grid: `repeat(auto-fit, minmax(min(200px, 100%), 1fr))`, gap `1rem` |
|
|
119
|
+
| Card | Elevated card with click handler that activates the radio |
|
|
120
|
+
| Heading | `<h4>` with `marginTop: 0, marginBottom: 0` above grid |
|
|
121
|
+
|
|
122
|
+
## Edge Cases & Special Logic
|
|
123
|
+
|
|
124
|
+
- `theOptions` is loaded synchronously from `Utils.getOptionList()` on every render — no async fetching.
|
|
125
|
+
- `theSelectedButton` tracks the selected key locally and syncs from `value` prop via `useEffect`.
|
|
126
|
+
- Card variant uses `setIsRadioCardSelected` callback to inform parent when a radio card is selected.
|
|
127
|
+
|
|
128
|
+
## Dependencies
|
|
129
|
+
|
|
130
|
+
- `Utils.getOptionList()` from `../../helpers/utils`.
|
|
131
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
132
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
133
|
+
- `getComponentFromRegistry('SelectableCard')` for card variant.
|
|
134
|
+
|
|
135
|
+
## Design System Mapping
|
|
136
|
+
|
|
137
|
+
**UI control type:** Radio button group (single selection).
|
|
138
|
+
|
|
139
|
+
Listed design systems are examples only.
|
|
140
|
+
|
|
141
|
+
| Design System | Recommended Component |
|
|
142
|
+
|---|---|
|
|
143
|
+
| Default (CSS only) | `<input type="radio">` with `<label>` per option |
|
|
144
|
+
| MUI | `<RadioGroup>` with `<FormControlLabel control={<Radio />}>` |
|
|
145
|
+
| Ant Design | `<Radio.Group>` with `<Radio>` options |
|
|
146
|
+
| Chakra UI | `<RadioGroup>` with `<Radio>` items |
|