@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,104 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: Date
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: Date
|
|
7
|
+
|
|
8
|
+
Date picker field with locale-aware date format string, binds to a Pega case property.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a date picker input. Stores dates as `YYYY-MM-DD` strings. Displays dates according to locale-aware format (e.g., `MM/DD/YYYY` for en-US). Uses a date picker library for the calendar UI. Delegates read-only rendering to `TextInput`.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `Date`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Date`
|
|
22
|
+
- **Registration key:** `Date` (mapped to `DateField` import in `component-map.ts` to avoid conflicts with the JS `Date` global)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
No props beyond `PConnFieldProps`. Import type as:
|
|
27
|
+
```typescript
|
|
28
|
+
import type { PConnFieldProps } from '@pega/sdk-react';
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
> **Important naming note:** The component file exports a function named `Date`. In `component-map.ts`, import it as `DateField` and register it as `Date: DateField`.
|
|
32
|
+
|
|
33
|
+
## Behavioral Contract
|
|
34
|
+
|
|
35
|
+
1. **Local state:** Maintain `dateValue` as a date object (e.g., a `dayjs` object or `Date` instance), initialized from `value` prop using the date library's parser. Default to `null` if value is empty/falsy.
|
|
36
|
+
2. **Sync from store:** `useEffect` watching `value` → re-parse and `setDateValue(dayjs(value))`.
|
|
37
|
+
3. **Date format:** Get locale-aware format string via `getDateFormatInfo()`:
|
|
38
|
+
- Returns `dateFormatString` (display format, e.g., `'MM/DD/YYYY'`), `dateFormatStringLC` (lowercase for placeholder, e.g., `'mm/dd/yyyy'`), `dateFormatMask`.
|
|
39
|
+
- Start from `dateFormatInfoDefault` and override with locale-specific values.
|
|
40
|
+
4. **On change (valid date selected):**
|
|
41
|
+
- Validate the date is valid (e.g., `date.isValid()`).
|
|
42
|
+
- Format to `YYYY-MM-DD` string: `${year}-${(month+1).padStart(2,'0')}-${day.padStart(2,'0')}`.
|
|
43
|
+
- Commit immediately via `handleEvent(actions, 'changeNblur', propName, formattedDate)`.
|
|
44
|
+
- Update local `dateValue` state.
|
|
45
|
+
5. **Invalid dates:** If `date.isValid()` is false, do NOT commit — ignore the change.
|
|
46
|
+
6. **Read-only:** Delegate to `TextInput`: `return <TextInput {...props} />`.
|
|
47
|
+
7. **Placeholder:** Use lowercase format string (e.g., `'mm/dd/yyyy'`).
|
|
48
|
+
|
|
49
|
+
## Display Mode Rendering
|
|
50
|
+
|
|
51
|
+
Format the value before display using `format(value, 'date', { format: dateFormatInfo.dateFormatString })`:
|
|
52
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={formattedDate} />`.
|
|
53
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={formattedDate} variant='stacked' />`.
|
|
54
|
+
- Both modes compute `formattedDate` from the raw `props.value` (not local state).
|
|
55
|
+
|
|
56
|
+
## Read-Only Rendering
|
|
57
|
+
|
|
58
|
+
Delegate to `TextInput`: `return <TextInput {...props} />`. The raw `YYYY-MM-DD` string is displayed as-is (or formatted by `TextInput`'s read-only rendering).
|
|
59
|
+
|
|
60
|
+
## Visual Specifications
|
|
61
|
+
|
|
62
|
+
| Property | Value |
|
|
63
|
+
|----------|-------|
|
|
64
|
+
| Width | Auto (date picker natural width) |
|
|
65
|
+
| Size | Small |
|
|
66
|
+
| Variant | Outlined |
|
|
67
|
+
| Placeholder | Lowercase format string (e.g., `mm/dd/yyyy`) |
|
|
68
|
+
| Calendar popup | Opens below the input |
|
|
69
|
+
| Error state | Red border + red helper text |
|
|
70
|
+
| Required indicator | `*` on label |
|
|
71
|
+
| Format display | Locale-aware (e.g., `MM/DD/YYYY`, `DD/MM/YYYY`) |
|
|
72
|
+
|
|
73
|
+
**CSS-only notes:** For a CSS-only date input, use `<input type="date">` — note that the display format is browser-controlled. A custom date picker component is needed for locale-aware format strings.
|
|
74
|
+
|
|
75
|
+
## Edge Cases & Special Logic
|
|
76
|
+
|
|
77
|
+
- Commit on **change** (when a valid date is selected), not on blur — this differs from text inputs.
|
|
78
|
+
- Always store value as `YYYY-MM-DD` regardless of display format.
|
|
79
|
+
- Invalid/incomplete dates (e.g., partially typed) are ignored — only commit when `isValid()` returns true.
|
|
80
|
+
- Locale format info is derived at render time from `getDateFormatInfo()` — this reads the Pega environment locale.
|
|
81
|
+
|
|
82
|
+
## Dependencies
|
|
83
|
+
|
|
84
|
+
- Date manipulation library (e.g., `dayjs`) — for parsing, formatting, validity checking.
|
|
85
|
+
- Date picker UI component (e.g., `@mui/x-date-pickers/DatePicker`) — for calendar popup.
|
|
86
|
+
- `getDateFormatInfo()` from `../../helpers/date-format-utils` — for locale-aware format string.
|
|
87
|
+
- `dateFormatInfoDefault` from same helper — default fallback.
|
|
88
|
+
- `format()` from `../../helpers/formatters` — for display mode formatting.
|
|
89
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
90
|
+
- `getComponentFromRegistry('TextInput')` for read-only delegation.
|
|
91
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
92
|
+
|
|
93
|
+
## Design System Mapping
|
|
94
|
+
|
|
95
|
+
**UI control type:** Date picker with calendar popup.
|
|
96
|
+
|
|
97
|
+
Listed design systems are examples only.
|
|
98
|
+
|
|
99
|
+
| Design System | Recommended Component |
|
|
100
|
+
|---|---|
|
|
101
|
+
| Default (CSS only) | `<input type="date">` (browser native, limited locale control) |
|
|
102
|
+
| MUI | `<DatePicker />` from `@mui/x-date-pickers` with `dayjs` adapter |
|
|
103
|
+
| Ant Design | `<DatePicker format="MM/DD/YYYY" />` |
|
|
104
|
+
| Chakra UI | Third-party date picker or `<input type="date">` |
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: DateTime
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: DateTime
|
|
7
|
+
|
|
8
|
+
Date and time picker with timezone conversion, binds to a Pega case property.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a combined date and time picker. Stores values as ISO 8601 UTC strings. Converts to/from the Pega environment's configured timezone for display. Shows formatted date-time in display modes. Delegates read-only rendering to `TextInput` with a formatted string.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `DateTime`
|
|
21
|
+
- **Type / Subtype:** `Field` / `DateTime`
|
|
22
|
+
- **Registration key:** `DateTime` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
No props beyond `PConnFieldProps`. Import type as:
|
|
27
|
+
```typescript
|
|
28
|
+
import type { PConnFieldProps } from '@pega/sdk-react';
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Behavioral Contract
|
|
32
|
+
|
|
33
|
+
1. **Timezone:** Read the environment timezone at render time:
|
|
34
|
+
```
|
|
35
|
+
const timezone = PCore.getEnvironmentInfo().getTimeZone()
|
|
36
|
+
```
|
|
37
|
+
2. **Local state:** Maintain `dateValue` as a timezone-aware date object. Initialize from `value` prop by converting to the environment timezone using `DateFormatter.convertToTimezone(value, { timezone })`.
|
|
38
|
+
3. **Sync from store:** `useEffect` watching `value` → re-convert and `setDateValue(dayjs(DateFormatter.convertToTimezone(value, { timezone })))`.
|
|
39
|
+
4. **Date/time format:** Get locale-aware format from `getDateFormatInfo()`. Combined format: `${dateFormatString} hh:mm a` (e.g., `'MM/DD/YYYY hh:mm a'`). Placeholder: `${dateFormatStringLC} hh:mm a`.
|
|
40
|
+
5. **Minutes step:** `minutesStep={5}` — time picker snaps to 5-minute increments.
|
|
41
|
+
6. **On change:**
|
|
42
|
+
- Convert the selected date to timezone-aware ISO string:
|
|
43
|
+
```
|
|
44
|
+
const timeZoneDateTime = dayjs.tz(date.format('YYYY-MM-DDTHH:mm:ss'), timezone)
|
|
45
|
+
const changeValue = timeZoneDateTime?.isValid() ? timeZoneDateTime.toISOString() : ''
|
|
46
|
+
```
|
|
47
|
+
- Commit immediately via `handleEvent(actions, 'changeNblur', propName, changeValue)`.
|
|
48
|
+
- Update local `dateValue`.
|
|
49
|
+
7. **Read-only:** Format value as string using `format(value, 'datetime')`, then delegate: `return <TextInput {...props} value={formattedDateTime} />`.
|
|
50
|
+
|
|
51
|
+
## Display Mode Rendering
|
|
52
|
+
|
|
53
|
+
Format using `format(value, 'datetime', { format: \`${dateFormatString} hh:mm a\` })`:
|
|
54
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={formattedDateTime} />`.
|
|
55
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={formattedDateTime} variant='stacked' />`.
|
|
56
|
+
|
|
57
|
+
## Read-Only Rendering
|
|
58
|
+
|
|
59
|
+
Format value as `format(props.value, 'datetime')` then pass to `TextInput`:
|
|
60
|
+
```
|
|
61
|
+
return <TextInput {...props} value={formattedDateTime} />
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Visual Specifications
|
|
65
|
+
|
|
66
|
+
| Property | Value |
|
|
67
|
+
|----------|-------|
|
|
68
|
+
| Width | Auto |
|
|
69
|
+
| Size | Small |
|
|
70
|
+
| Variant | Outlined |
|
|
71
|
+
| Format | `MM/DD/YYYY hh:mm a` (locale-aware date + 12h time) |
|
|
72
|
+
| Placeholder | Lowercase format, e.g., `mm/dd/yyyy hh:mm a` |
|
|
73
|
+
| Minutes step | 5 minutes |
|
|
74
|
+
| Error state | Red border + red helper text |
|
|
75
|
+
|
|
76
|
+
**Note on known issue:** Keyboard input in the minute field may jump to the am/pm field after one digit — this is a known quirk of some date-time picker library versions.
|
|
77
|
+
|
|
78
|
+
## Edge Cases & Special Logic
|
|
79
|
+
|
|
80
|
+
- All stored values are **UTC ISO 8601 strings** (e.g., `'2024-03-15T14:30:00.000Z'`).
|
|
81
|
+
- **Timezone conversion** is critical: always convert from UTC → environment timezone for display, and from environment timezone → UTC when committing.
|
|
82
|
+
- If `timeZoneDateTime.isValid()` is false, commit an empty string `''`.
|
|
83
|
+
- Commits on **change** (picker selection), not on blur.
|
|
84
|
+
- `dayjs.tz` requires `dayjs-timezone` plugin.
|
|
85
|
+
|
|
86
|
+
## Dependencies
|
|
87
|
+
|
|
88
|
+
- Date manipulation library with timezone support (e.g., `dayjs` + `dayjs/plugin/timezone`).
|
|
89
|
+
- `DateFormatter.convertToTimezone(value, { timezone })` from `../../helpers/formatters/Date` — converts stored UTC value to display timezone.
|
|
90
|
+
- `format()` from `../../helpers/formatters` — for display mode formatting.
|
|
91
|
+
- `getDateFormatInfo()` from `../../helpers/date-format-utils` — for locale date format string.
|
|
92
|
+
- Date-time picker UI component (e.g., `@mui/x-date-pickers/DateTimePicker`).
|
|
93
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
94
|
+
- `getComponentFromRegistry('TextInput')` for read-only.
|
|
95
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
96
|
+
|
|
97
|
+
## Design System Mapping
|
|
98
|
+
|
|
99
|
+
**UI control type:** Combined date and time picker with timezone awareness.
|
|
100
|
+
|
|
101
|
+
Listed design systems are examples only.
|
|
102
|
+
|
|
103
|
+
| Design System | Recommended Component |
|
|
104
|
+
|---|---|
|
|
105
|
+
| Default (CSS only) | `<input type="datetime-local">` (no timezone control) |
|
|
106
|
+
| MUI | `<DateTimePicker />` from `@mui/x-date-pickers` + `dayjs.tz` |
|
|
107
|
+
| Ant Design | `<DatePicker showTime />` |
|
|
108
|
+
| Chakra UI | Third-party datetime picker |
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: Decimal
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: Decimal
|
|
7
|
+
|
|
8
|
+
Decimal number input with configurable precision, group separators, and optional currency/percentage display formatting.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a numeric input that accepts decimal values. Supports configurable decimal precision, optional thousands separator, and optional formatter override (`'Currency'` or `'Percentage'`). Differs from `Currency` in that it's more generic — it can display values as currency, percentage, or plain decimal based on a `formatter` prop.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `Decimal`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Decimal`
|
|
22
|
+
- **Registration key:** `Decimal` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Default | Description |
|
|
27
|
+
|------|------|---------|-------------|
|
|
28
|
+
| `currencyISOCode` | `string` (optional) | `'USD'` | ISO code for symbol/separator lookup (used when `formatter === 'Currency'`) |
|
|
29
|
+
| `decimalPrecision` | `number` (optional) | — | Number of decimal places to show |
|
|
30
|
+
| `showGroupSeparators` | `boolean` (optional) | — | Whether to show thousands separators |
|
|
31
|
+
| `formatter` | `string` (optional) | — | `'Currency'` or `'Percentage'` — changes display mode formatting and read-only prefix/suffix |
|
|
32
|
+
|
|
33
|
+
## Behavioral Contract
|
|
34
|
+
|
|
35
|
+
1. **Local state:** Maintain `values` (string). Initialize from `value.toString()`.
|
|
36
|
+
2. **Sync from store:** `useEffect` watching `value` → `setValues(value.toString())`.
|
|
37
|
+
3. **Separators:** Always derive `decimalSeparator` and `thousandSeparator` from locale lookup using `currencyISOCode`. Apply `thousandSeparator` only when `showGroupSeparators` is `true`.
|
|
38
|
+
4. **Decimal scale:** Use `decimalPrecision` prop for `decimalScale` — except in read-only mode with `formatter === 'Currency'`, where `decimalScale` is `undefined`.
|
|
39
|
+
5. **Prefix/Suffix in read-only:**
|
|
40
|
+
- If `readOnly && formatter === 'Currency'`: show currency symbol as prefix.
|
|
41
|
+
- If `readOnly && formatter === 'Percentage'`: show `%` as suffix.
|
|
42
|
+
- Otherwise: no prefix/suffix.
|
|
43
|
+
6. **Formatted display value:**
|
|
44
|
+
- If `formatter === 'Currency'`: `formattedValue = format(value, 'currency', currencyOptions)`.
|
|
45
|
+
- Otherwise: `formattedValue = format(value, 'decimal', currencyOptions)`.
|
|
46
|
+
7. **On value change:** Update local `values` state with the raw numeric string.
|
|
47
|
+
8. **On blur:** Commit via `handleEvent(actions, 'changeNblur', propName, values)`.
|
|
48
|
+
9. **Read-only:** Set `readOnly: true` on the input. Visual style switches to flat/borderless. `onBlur` omitted.
|
|
49
|
+
|
|
50
|
+
## Display Mode Rendering
|
|
51
|
+
|
|
52
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={formattedValue} />`.
|
|
53
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={formattedValue} variant='stacked' />`.
|
|
54
|
+
|
|
55
|
+
`formattedValue` is computed before display-mode check:
|
|
56
|
+
- `formatter === 'Currency'` → currency-formatted string.
|
|
57
|
+
- Otherwise → decimal-formatted string using `pConn.getComponentName()?.toLowerCase()` as format key.
|
|
58
|
+
|
|
59
|
+
## Read-Only Rendering
|
|
60
|
+
|
|
61
|
+
Keep numeric format input with `readOnly: true`. Apply prefix (`$`) or suffix (`%`) based on `formatter`. Flat/borderless visual style.
|
|
62
|
+
|
|
63
|
+
## Visual Specifications
|
|
64
|
+
|
|
65
|
+
| Property | Standard (editable) | Read-only |
|
|
66
|
+
|----------|---------------------|-----------|
|
|
67
|
+
| Width | 100% | 100% |
|
|
68
|
+
| Size | Small | Small |
|
|
69
|
+
| Variant | Outlined | Standard (flat) |
|
|
70
|
+
| Prefix | None (unless read-only Currency) | Currency symbol if `formatter='Currency'` |
|
|
71
|
+
| Suffix | None (unless read-only Percentage) | `%` if `formatter='Percentage'` |
|
|
72
|
+
| Thousands separator | Only when `showGroupSeparators=true` | Same |
|
|
73
|
+
| Decimal scale | From `decimalPrecision` | Undefined for Currency, `decimalPrecision` otherwise |
|
|
74
|
+
| Placeholder | From `placeholder` prop | — |
|
|
75
|
+
|
|
76
|
+
## Edge Cases & Special Logic
|
|
77
|
+
|
|
78
|
+
- In read-only Currency mode, `decimalScale` is set to `undefined` (let the formatter decide), not `decimalPrecision`.
|
|
79
|
+
- `thousandSeparator` defaults to `''` (disabled) unless `showGroupSeparators` is `true`.
|
|
80
|
+
- `prefix` and `suffix` are only rendered in read-only mode — NOT in editable mode.
|
|
81
|
+
- The stored value is always a raw numeric string, not the formatted display string.
|
|
82
|
+
|
|
83
|
+
## Dependencies
|
|
84
|
+
|
|
85
|
+
- Numeric formatting library (e.g., `react-number-format`'s `NumericFormat`).
|
|
86
|
+
- `getCurrencyCharacters(currencyISOCode)` — for `theDecimalIndicator` and `theDigitGroupSeparator`.
|
|
87
|
+
- `getCurrencyOptions(currencyISOCode)` — for `format()` options.
|
|
88
|
+
- `format()` from `../../helpers/formatters`.
|
|
89
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
90
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
91
|
+
|
|
92
|
+
## Design System Mapping
|
|
93
|
+
|
|
94
|
+
**UI control type:** Decimal / numeric formatted input.
|
|
95
|
+
|
|
96
|
+
Listed design systems are examples only.
|
|
97
|
+
|
|
98
|
+
| Design System | Recommended Component |
|
|
99
|
+
|---|---|
|
|
100
|
+
| Default (CSS only) | `<input type="text">` with custom numeric masking |
|
|
101
|
+
| MUI | `NumericFormat` with `customInput={TextField}` |
|
|
102
|
+
| Ant Design | `<InputNumber precision={decimalPrecision} />` |
|
|
103
|
+
| Chakra UI | `<NumberInput>` |
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: Dropdown
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: Dropdown
|
|
7
|
+
|
|
8
|
+
Select/dropdown field with options loaded from a data page, associated list, or deferred datasource. Includes localization of option labels.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a single-select dropdown (select box). Options are loaded from a Pega datasource — either an `associated` list (static key/value pairs) or a `datapage` (async data page fetch). Supports deferred datasource loading and localized option labels. Commits value immediately on selection change.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `Dropdown`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Picklist`
|
|
22
|
+
- **Registration key:** `Dropdown` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Description |
|
|
27
|
+
|------|------|-------------|
|
|
28
|
+
| `listType` | `string` | `'associated'` or `'datapage'` — determines how options are loaded |
|
|
29
|
+
| `datasource` | `any[]` (optional) | The raw datasource (array for associated, string name for datapage) |
|
|
30
|
+
| `columns` | `any[]` | Column config for extracting key/value from datasource records |
|
|
31
|
+
| `parameters` | `any` (optional) | Query parameters for data page calls |
|
|
32
|
+
| `deferDatasource` | `boolean` (optional) | If true, transform `datasourceMetadata` into datapage config |
|
|
33
|
+
| `datasourceMetadata` | `any` (optional) | Metadata from deferred datasource resolution |
|
|
34
|
+
| `fieldMetadata` | `any` (optional) | Field metadata for localization context |
|
|
35
|
+
| `onRecordChange` | `any` (optional) | Callback fired after a selection change |
|
|
36
|
+
|
|
37
|
+
## Behavioral Contract
|
|
38
|
+
|
|
39
|
+
1. **Options state:** Maintain `options` as `Array<{key: string, value: string}>`. Initially empty — render nothing (`return null`) until options are populated (avoids design system warnings about undefined options).
|
|
40
|
+
2. **Datasource detection:** Use `isDeepEqual` (deep equality) to compare incoming `datasource` prop with cached `theDatasource` state. If different, update `theDatasource` to trigger a `useEffect`.
|
|
41
|
+
3. **Deferred datasource transformation:** If `deferDatasource && datasourceMetadata?.datasource?.name`:
|
|
42
|
+
- Override `listType = 'datapage'`
|
|
43
|
+
- Set `datasource = datasourceMetadata.datasource.name` (string page name)
|
|
44
|
+
- Flatten `parameters` from `{key: {name, value}}` format to `{name: value}` pairs
|
|
45
|
+
- Build `columns` from `propertyForDisplayText` and `propertyForValue`
|
|
46
|
+
4. **Column preprocessing:** Strip leading `.` from column `value` fields.
|
|
47
|
+
5. **Loading options for `associated` listType:** In `useEffect` watching `theDatasource`, call `Utils.getOptionList(props, pConn.getDataObject(''))`. Prepend a placeholder option `{key: placeholder, value: localizedPlaceholder}`.
|
|
48
|
+
6. **Loading options for `datapage` listType:** In mount-time `useEffect`, call `getDataPage(datasource, parameters, context)`. Map results using `getDisplayFieldsMetaData(columns)` to extract `key` and `value` per row.
|
|
49
|
+
7. **Placeholder:** Default `'Select...'` if not provided. Prepended as the first option for associated lists.
|
|
50
|
+
8. **On change:**
|
|
51
|
+
- If selected value equals `placeholder`, treat as empty string: `selectedValue = evt.target.value === placeholder ? '' : evt.target.value`.
|
|
52
|
+
- Commit via `handleEvent(actionsApi, 'changeNblur', propName, selectedValue)`.
|
|
53
|
+
- Fire `onRecordChange(evt)` if provided.
|
|
54
|
+
9. **Read-only:** Set `readOnly: true` on the select input. Flat/borderless style. Change handler omitted.
|
|
55
|
+
10. **Localization:** Option labels and display values are localized via `pConn.getLocalizedValue(label, localePath, localeRuleName)`.
|
|
56
|
+
|
|
57
|
+
## Display Mode Rendering
|
|
58
|
+
|
|
59
|
+
Display modes use the **resolved display value** (the `value` string matching the selected `key`), NOT the raw stored key:
|
|
60
|
+
```
|
|
61
|
+
options.find(option => option.key === value)?.value || value
|
|
62
|
+
```
|
|
63
|
+
Both modes pass this resolved value through `pConn.getLocalizedValue()` for localization:
|
|
64
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={localizedDisplayValue} />`
|
|
65
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={localizedDisplayValue} variant='stacked' />`
|
|
66
|
+
|
|
67
|
+
## Read-Only Rendering
|
|
68
|
+
|
|
69
|
+
Set `readOnly: true` on the select element. Flat/borderless variant. Change handler removed.
|
|
70
|
+
|
|
71
|
+
## Visual Specifications
|
|
72
|
+
|
|
73
|
+
| Property | Standard (editable) | Read-only |
|
|
74
|
+
|----------|---------------------|-----------|
|
|
75
|
+
| Width | 100% | 100% |
|
|
76
|
+
| Size | Small | Small |
|
|
77
|
+
| Variant | Outlined | Standard (flat) |
|
|
78
|
+
| Placeholder option | First option in list (`'Select...'`) | Not shown |
|
|
79
|
+
| Options | Rendered as select menu items | — |
|
|
80
|
+
| Error state | Red border + red helper text | — |
|
|
81
|
+
| Label | Floating label | — |
|
|
82
|
+
|
|
83
|
+
**CSS-only notes:**
|
|
84
|
+
```css
|
|
85
|
+
select { width: 100%; height: 40px; border: 1px solid rgba(0,0,0,0.23); border-radius: 4px; padding: 8px 12px; font-size: 0.875rem; }
|
|
86
|
+
select:focus { border-color: #1976d2; outline: none; }
|
|
87
|
+
select.error { border-color: #d32f2f; }
|
|
88
|
+
select[readonly] { border: none; background: transparent; pointer-events: none; }
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Edge Cases & Special Logic
|
|
92
|
+
|
|
93
|
+
- Do NOT render the component until `options.length > 0` — return `null` until options load.
|
|
94
|
+
- **Localization keys:** Build from `fieldMetadata`:
|
|
95
|
+
- `localeContext`: `'datapage'` if `tableType === 'DataPage'`, else `'associated'`
|
|
96
|
+
- `localeClass`: `'@baseclass'` for datapage, else the case className
|
|
97
|
+
- `localeName`, `localePath` derived from datasource name and display text property
|
|
98
|
+
- `displayMode` check must resolve the key→value mapping — it calls `displayFn(displayMode, resolvedValue)`.
|
|
99
|
+
|
|
100
|
+
## Dependencies
|
|
101
|
+
|
|
102
|
+
- `isDeepEqual` from `fast-deep-equal/react` — for datasource change detection.
|
|
103
|
+
- `Utils.getOptionList()` from `../../helpers/utils` — for associated list options.
|
|
104
|
+
- `getDataPage()` from `../../helpers/data_page` — for datapage async fetch.
|
|
105
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
106
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
107
|
+
|
|
108
|
+
## Design System Mapping
|
|
109
|
+
|
|
110
|
+
**UI control type:** Single-select dropdown / select box.
|
|
111
|
+
|
|
112
|
+
Listed design systems are examples only.
|
|
113
|
+
|
|
114
|
+
| Design System | Recommended Component |
|
|
115
|
+
|---|---|
|
|
116
|
+
| Default (CSS only) | `<select>` with `<option>` elements |
|
|
117
|
+
| MUI | `<TextField select>` with `<MenuItem>` children |
|
|
118
|
+
| Ant Design | `<Select>` with `<Select.Option>` |
|
|
119
|
+
| Chakra UI | `<Select>` |
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: Email
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: Email
|
|
7
|
+
|
|
8
|
+
Email input field with a leading mail icon, binds to a Pega case property.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a single-line text input of type `email` with a leading mail icon adornment. Provides browser-native email validation via `type='email'`. Delegates read-only rendering to the `TextInput` component.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `Email`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Text-Email`
|
|
22
|
+
- **Registration key:** `Email` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
No props beyond `PConnFieldProps`. Import type as:
|
|
27
|
+
```typescript
|
|
28
|
+
import type { PConnFieldProps } from '@pega/sdk-react';
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Behavioral Contract
|
|
32
|
+
|
|
33
|
+
1. **Local state:** Maintain `inputValue` (string). Initialize from `value` prop (`''` default).
|
|
34
|
+
2. **Sync from store:** `useEffect` watching `value` → `setInputValue(value)`.
|
|
35
|
+
3. **On change:** Update local state only (`setInputValue(event.target.value)`).
|
|
36
|
+
4. **On blur:** Commit via `handleEvent(actions, 'changeNblur', propName, inputValue)`.
|
|
37
|
+
5. **Input type:** Use `type='email'` for browser-native email format validation.
|
|
38
|
+
6. **Read-only:** Delegate entirely to `TextInput` component: `return <TextInput {...props} />`. Do NOT render the email-specific UI.
|
|
39
|
+
|
|
40
|
+
## Display Mode Rendering
|
|
41
|
+
|
|
42
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={value} />` — raw email string, no formatting.
|
|
43
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />`.
|
|
44
|
+
|
|
45
|
+
## Read-Only Rendering
|
|
46
|
+
|
|
47
|
+
Delegate to `TextInput`: `return <TextInput {...props} />`. This means the mail icon adornment is NOT shown in read-only mode.
|
|
48
|
+
|
|
49
|
+
## Visual Specifications
|
|
50
|
+
|
|
51
|
+
Derived from the reference component's MUI props and styles:
|
|
52
|
+
|
|
53
|
+
| Property | Value |
|
|
54
|
+
|----------|-------|
|
|
55
|
+
| Width | 100% |
|
|
56
|
+
| Size | Small (~40px height) |
|
|
57
|
+
| Variant | Outlined |
|
|
58
|
+
| Leading icon | Mail/envelope icon (`position='start'` adornment) |
|
|
59
|
+
| Icon color | Inherits text color |
|
|
60
|
+
| Border | 1px solid outlined |
|
|
61
|
+
| Border radius | 4px |
|
|
62
|
+
| Error state | Red border + red helper text |
|
|
63
|
+
| Helper text | Below input |
|
|
64
|
+
| Placeholder | From `placeholder` prop (`''` default) |
|
|
65
|
+
|
|
66
|
+
**CSS-only implementation notes:**
|
|
67
|
+
```css
|
|
68
|
+
.email-input-wrapper {
|
|
69
|
+
position: relative;
|
|
70
|
+
display: flex;
|
|
71
|
+
align-items: center;
|
|
72
|
+
width: 100%;
|
|
73
|
+
border: 1px solid rgba(0, 0, 0, 0.23);
|
|
74
|
+
border-radius: 4px;
|
|
75
|
+
padding: 8px 14px 8px 36px; /* left padding for icon */
|
|
76
|
+
}
|
|
77
|
+
.email-input-icon {
|
|
78
|
+
position: absolute;
|
|
79
|
+
left: 10px;
|
|
80
|
+
color: rgba(0, 0, 0, 0.54);
|
|
81
|
+
pointer-events: none;
|
|
82
|
+
}
|
|
83
|
+
.email-input-wrapper.error {
|
|
84
|
+
border-color: #d32f2f;
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Edge Cases & Special Logic
|
|
89
|
+
|
|
90
|
+
- The `type='email'` attribute triggers browser-native validation — this is intentional and supplements Pega's server-side validation.
|
|
91
|
+
- In read-only mode, the full delegation to `TextInput` means the component renders without the mail icon adornment.
|
|
92
|
+
- `onBlur` is only attached when `!readOnly`.
|
|
93
|
+
|
|
94
|
+
## Dependencies
|
|
95
|
+
|
|
96
|
+
- `handleEvent` from `../../helpers/event-utils`
|
|
97
|
+
- `getComponentFromRegistry('TextInput')` — for read-only delegation
|
|
98
|
+
- `getComponentFromRegistry('FieldValueList')` — for display modes
|
|
99
|
+
- A mail/envelope icon (e.g., from an icon library or inline SVG)
|
|
100
|
+
|
|
101
|
+
## Design System Mapping
|
|
102
|
+
|
|
103
|
+
**UI control type:** Email text input with leading icon adornment.
|
|
104
|
+
|
|
105
|
+
Listed design systems are examples only.
|
|
106
|
+
|
|
107
|
+
| Design System | Recommended Component |
|
|
108
|
+
|---|---|
|
|
109
|
+
| Default (CSS only) | `<input type="email">` with absolutely-positioned icon |
|
|
110
|
+
| MUI | `<TextField type='email' InputProps={{ startAdornment: <MailIcon /> }} />` |
|
|
111
|
+
| Ant Design | `<Input type="email" prefix={<MailOutlined />} />` |
|
|
112
|
+
| Chakra UI | `<InputGroup><InputLeftElement><EmailIcon /></InputLeftElement><Input type="email" /></InputGroup>` |
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Field component skill: Group
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: Group
|
|
7
|
+
|
|
8
|
+
Field group container that wraps child fields in a collapsible section with an optional heading and instructions.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`field-components.md`](../field-components.md) — covers architecture, props interface, display modes, event handling, and registration patterns common to ALL field components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
A layout/structural component (not a form input). Wraps a set of child field components in a `FieldGroup` container with an optional heading, collapsibility, and instructions text. Arranges children in a responsive grid. Does not bind to a Pega property directly.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Pega Name:** `Group`
|
|
21
|
+
- **Type / Subtype:** `Field` / `Group`
|
|
22
|
+
- **Registration key:** `Group` (in `component-map.ts`)
|
|
23
|
+
|
|
24
|
+
## Props (component-specific)
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Description |
|
|
27
|
+
|------|------|-------------|
|
|
28
|
+
| `children` | `ReactElement[]` | Child field components to render inside the group |
|
|
29
|
+
| `heading` | `string` | The group heading/title |
|
|
30
|
+
| `showHeading` | `boolean` | Whether to display the heading |
|
|
31
|
+
| `instructions` | `string` (optional) | Instructional text shown below the heading |
|
|
32
|
+
| `collapsible` | `boolean` | Whether the group can be collapsed |
|
|
33
|
+
| `type` | `string` | Group type (used for layout context) |
|
|
34
|
+
|
|
35
|
+
`displayMode` is also consumed from `PConnFieldProps`.
|
|
36
|
+
|
|
37
|
+
## Behavioral Contract
|
|
38
|
+
|
|
39
|
+
1. **No state, no event handling** — purely structural/layout.
|
|
40
|
+
2. **`isReadOnly` flag:** `isReadOnly = displayMode === 'DISPLAY_ONLY'` — passed through to grid for layout context.
|
|
41
|
+
3. **Content grid:** Build a responsive grid of children using `useMemo` (memoized based on `children`, `type`, `isReadOnly`):
|
|
42
|
+
- Each child gets a full-width grid item (`xs: 12` in a 12-column grid, or equivalent `100%` column).
|
|
43
|
+
- Children are mapped with their `key` prop preserved.
|
|
44
|
+
4. **Null guard:** If `!children`, return `null`.
|
|
45
|
+
5. **Heading:** Pass `showHeading ? heading : undefined` to `FieldGroup` — if `showHeading` is false, heading is `undefined` (not shown).
|
|
46
|
+
6. **FieldGroup:** Resolved via `getComponentFromRegistry('FieldGroup')`. Receives `name`, `collapsible`, and `instructions` props.
|
|
47
|
+
|
|
48
|
+
## Display Mode Rendering
|
|
49
|
+
|
|
50
|
+
`displayMode` is not explicitly handled — it's passed through as a prop for context. `FieldGroup` and children handle their own display mode behavior.
|
|
51
|
+
|
|
52
|
+
## Visual Specifications
|
|
53
|
+
|
|
54
|
+
The visual appearance is determined by the `FieldGroup` design system extension component. `Group` itself only applies grid layout to children:
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
Grid container (spacing=2):
|
|
58
|
+
per child → Grid item (xs: 12, full width)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**CSS-only grid layout:**
|
|
62
|
+
```css
|
|
63
|
+
.field-group-children { display: grid; grid-template-columns: 1fr; gap: 16px; }
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
The `FieldGroup` component itself provides:
|
|
67
|
+
- Optional heading/title above the children
|
|
68
|
+
- Optional collapse/expand control
|
|
69
|
+
- Optional instructions text
|
|
70
|
+
- Container border/background (design-system-dependent)
|
|
71
|
+
|
|
72
|
+
## Edge Cases & Special Logic
|
|
73
|
+
|
|
74
|
+
- **`useMemo` dependencies:** `[children, type, isReadOnly]` — the grid re-renders only when these change, not on every parent render.
|
|
75
|
+
- Children must have stable `key` props for React reconciliation.
|
|
76
|
+
- `instructions` may be undefined — `FieldGroup` should handle this gracefully.
|
|
77
|
+
|
|
78
|
+
## Dependencies
|
|
79
|
+
|
|
80
|
+
- `getComponentFromRegistry('FieldGroup')` — design system extension providing the collapsible container.
|
|
81
|
+
- `useMemo` from React.
|
|
82
|
+
- Grid layout component (e.g., MUI `Grid`).
|
|
83
|
+
|
|
84
|
+
## Design System Mapping
|
|
85
|
+
|
|
86
|
+
**UI control type:** Collapsible field group container with heading.
|
|
87
|
+
|
|
88
|
+
Listed design systems are examples only.
|
|
89
|
+
|
|
90
|
+
| Design System | Recommended Component |
|
|
91
|
+
|---|---|
|
|
92
|
+
| Default (CSS only) | `<fieldset>` or `<details>/<summary>` for collapsible |
|
|
93
|
+
| MUI | `<Grid container spacing={2}>` with `<Grid size={{ xs: 12 }}>` per child |
|
|
94
|
+
| Ant Design | `<Collapse>` panel or `<Card>` |
|
|
95
|
+
| Chakra UI | `<Box>` or `<Accordion>` |
|