@pega/sdk 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +2 -19
- package/package.json +4 -1
- package/templates/react-sdk-reference/.claude/instructions/component-map.md +38 -0
- package/templates/react-sdk-reference/.claude/instructions/dse-component.md +75 -0
- package/templates/react-sdk-reference/.claude/instructions/field-component.md +71 -0
- package/templates/react-sdk-reference/.claude/instructions/template-component.md +92 -0
- package/templates/react-sdk-reference/.claude/instructions/widget-component.md +87 -0
- package/templates/react-sdk-reference/.claude/prompts/add-component.md +144 -0
- package/templates/react-sdk-reference/.claude/prompts/component-manifest.json +111 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-all-components.md +149 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-dse-components.md +126 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-field-components.md +139 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-template-components.md +151 -0
- package/templates/react-sdk-reference/.claude/prompts/generate-widget-components.md +124 -0
- package/templates/react-sdk-reference/.claude/prompts/identify-components.md +105 -0
- package/templates/react-sdk-reference/.claude/prompts/replace-design-system.md +519 -0
- package/templates/react-sdk-reference/.claude/skills/component-contracts.md +140 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/AlertBanner.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Banner.md +149 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/CaseSummaryFields.md +154 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/DetailsFields.md +144 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroup.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldGroupList.md +111 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/FieldValueList.md +115 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Operator.md +149 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/Pulse.md +83 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/RichTextEditor.md +206 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension-skills/WssQuickCreate.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/design-system-extension.md +289 -0
- package/templates/react-sdk-reference/.claude/skills/field-components.md +294 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/AutoComplete.md +112 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/CancelAlert.md +203 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Checkbox.md +158 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Currency.md +106 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Date.md +99 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/DateTime.md +103 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Decimal.md +98 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Dropdown.md +114 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Email.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Group.md +90 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Integer.md +87 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Location.md +136 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Multiselect.md +164 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/ObjectReference.md +164 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Percentage.md +92 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Phone.md +110 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/RadioButtons.md +146 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/RichText.md +138 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/ScalarList.md +124 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/SelectableCard.md +216 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/SemanticLink.md +148 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextArea.md +96 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextContent.md +101 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/TextInput.md +104 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/Time.md +88 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/URL.md +85 -0
- package/templates/react-sdk-reference/.claude/skills/field-skills/UserReference.md +180 -0
- package/templates/react-sdk-reference/.claude/skills/run-and-verify.md +68 -0
- package/templates/react-sdk-reference/.claude/skills/template-components.md +322 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/AdvancedSearch.md +144 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/AppShell.md +122 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/BannerPage.md +83 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseSummary.md +100 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseView.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/CaseViewActionsMenu.md +126 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/Confirmation.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DataReference.md +120 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultForm.md +102 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DefaultPage.md +110 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/Details.md +88 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsSubTabs.md +95 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsThreeColumn.md +78 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DetailsTwoColumn.md +78 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/DynamicTabs.md +101 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/FieldGroupTemplate.md +109 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/HierarchicalForm.md +113 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboard.md +104 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/InlineDashboardPage.md +85 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/ListPage.md +68 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/ListView.md +139 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/MultiReferenceReadOnly.md +80 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/NarrowWide.md +141 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/OneColumn.md +109 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/PromotedFilters.md +124 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SelfServiceCaseView.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SimpleTable.md +127 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SingleReferenceReadOnly.md +103 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/SubTabs.md +79 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/TwoColumn.md +131 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/WideNarrow.md +150 -0
- package/templates/react-sdk-reference/.claude/skills/template-skills/WssNavBar.md +135 -0
- package/templates/react-sdk-reference/.claude/skills/widget-components.md +271 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/AppAnnouncement.md +82 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/Attachment.md +146 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/CaseHistory.md +107 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/FileUtility.md +200 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/Followers.md +99 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/QuickCreate.md +114 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/SummaryItem.md +167 -0
- package/templates/react-sdk-reference/.claude/skills/widget-skills/ToDo.md +190 -0
- package/templates/react-sdk-reference/.cursor/rules/component-map.mdrules +41 -0
- package/templates/react-sdk-reference/.cursor/rules/dse-component.mdrules +78 -0
- package/templates/react-sdk-reference/.cursor/rules/field-component.mdrules +74 -0
- package/templates/react-sdk-reference/.cursor/rules/pega-sdk.mdrules +247 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/add-component.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/component-manifest.json +111 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-all-components.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-dse-components.mdrules +131 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-field-components.mdrules +144 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-template-components.mdrules +156 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/generate-widget-components.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/identify-components.mdrules +110 -0
- package/templates/react-sdk-reference/.cursor/rules/prompts/replace-design-system.mdrules +524 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/component-contracts.mdrules +145 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/AlertBanner.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Banner.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/CaseSummaryFields.mdrules +159 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/DetailsFields.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroup.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldGroupList.mdrules +116 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/FieldValueList.mdrules +120 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Operator.mdrules +154 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/Pulse.mdrules +88 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/RichTextEditor.mdrules +211 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension-skills/WssQuickCreate.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/design-system-extension.mdrules +294 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-components.mdrules +299 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/AutoComplete.mdrules +117 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/CancelAlert.mdrules +208 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Checkbox.mdrules +163 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Currency.mdrules +111 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Date.mdrules +104 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/DateTime.mdrules +108 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Decimal.mdrules +103 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Dropdown.mdrules +119 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Email.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Group.mdrules +95 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Integer.mdrules +92 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Location.mdrules +141 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Multiselect.mdrules +169 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ObjectReference.mdrules +169 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Percentage.mdrules +97 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Phone.mdrules +115 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RadioButtons.mdrules +151 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/RichText.mdrules +143 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/ScalarList.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SelectableCard.mdrules +221 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/SemanticLink.mdrules +153 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextArea.mdrules +101 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextContent.mdrules +106 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/TextInput.mdrules +109 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/Time.mdrules +93 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/URL.mdrules +90 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/field-skills/UserReference.mdrules +185 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/run-and-verify.mdrules +73 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-components.mdrules +327 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AdvancedSearch.mdrules +149 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/AppShell.mdrules +127 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/BannerPage.mdrules +88 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseSummary.mdrules +105 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseView.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/CaseViewActionsMenu.mdrules +131 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Confirmation.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DataReference.mdrules +125 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultForm.mdrules +107 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DefaultPage.mdrules +115 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/Details.mdrules +93 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsSubTabs.mdrules +100 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsThreeColumn.mdrules +83 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DetailsTwoColumn.mdrules +83 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/DynamicTabs.mdrules +106 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/FieldGroupTemplate.mdrules +114 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/HierarchicalForm.mdrules +118 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboard.mdrules +109 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/InlineDashboardPage.mdrules +90 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListPage.mdrules +73 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/ListView.mdrules +144 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/MultiReferenceReadOnly.mdrules +85 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/NarrowWide.mdrules +146 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/OneColumn.mdrules +114 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/PromotedFilters.mdrules +129 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SelfServiceCaseView.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SimpleTable.mdrules +132 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SingleReferenceReadOnly.mdrules +108 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/SubTabs.mdrules +84 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/TwoColumn.mdrules +136 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WideNarrow.mdrules +155 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/WssNavBar.mdrules +140 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-components.mdrules +276 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/AppAnnouncement.mdrules +87 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Attachment.mdrules +151 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/CaseHistory.mdrules +112 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/FileUtility.mdrules +205 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/Followers.mdrules +104 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/QuickCreate.mdrules +119 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/SummaryItem.mdrules +172 -0
- package/templates/react-sdk-reference/.cursor/rules/skills/widget-skills/ToDo.mdrules +195 -0
- package/templates/react-sdk-reference/.cursor/rules/template-component.mdrules +95 -0
- package/templates/react-sdk-reference/.cursor/rules/widget-component.mdrules +90 -0
- package/templates/react-sdk-reference/.github/copilot-instructions.md +58 -0
- package/templates/react-sdk-reference/.github/prompts/add-component.prompt.md +144 -16
- package/templates/react-sdk-reference/.github/prompts/generate-all-components.prompt.md +154 -0
- package/templates/react-sdk-reference/.github/prompts/generate-dse-components.prompt.md +131 -0
- package/templates/react-sdk-reference/.github/prompts/generate-field-components.prompt.md +144 -0
- package/templates/react-sdk-reference/.github/prompts/generate-template-components.prompt.md +156 -0
- package/templates/react-sdk-reference/.github/prompts/generate-widget-components.prompt.md +129 -0
- package/templates/react-sdk-reference/.github/skills/design-system-extension.md +58 -18
- package/templates/react-sdk-reference/.github/skills/field-components.md +55 -23
- package/templates/react-sdk-reference/.github/skills/template-components.md +48 -11
- package/templates/react-sdk-reference/.github/skills/widget-components.md +49 -12
- package/templates/react-sdk-reference/AGENTS.md +217 -29
- package/templates/react-sdk-reference/package.json +3 -2
- package/templates/react-sdk-reference/pega-auth-0.2.42.tgz +0 -0
- package/templates/react-sdk-reference/pega-constellationjs-0.26.3-local.tgz +0 -0
- package/templates/react-sdk-reference/pega-sdk-react-0.1.0.tgz +0 -0
- package/templates/react-sdk-reference/pega-sdk-types-0.1.0.tgz +0 -0
- package/templates/react-sdk-reference/sdk-config.json +1 -1
- package/templates/react-sdk-reference/vite.config.ts +1 -1
- package/templates/react-sdk-reference/.github/prompts/replace-all-fields.prompt.md +0 -48
- package/templates/react-sdk-reference/.github/prompts/replace-component.prompt.md +0 -81
- package/templates/react-sdk-reference/.github/prompts/replace-field.prompt.md +0 -41
- package/templates/react-sdk-reference/.github/prompts/swap-design-system.prompt.md +0 -49
- package/templates/react-sdk-reference/.github/skills/swap-design-system.md +0 -105
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Skill: Dropdown
|
|
2
|
+
|
|
3
|
+
Select/dropdown field with options loaded from a data page, associated list, or deferred datasource. Includes localization of 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 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.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Dropdown`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Picklist`
|
|
17
|
+
- **Registration key:** `Dropdown` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Description |
|
|
22
|
+
|------|------|-------------|
|
|
23
|
+
| `listType` | `string` | `'associated'` or `'datapage'` — determines how options are loaded |
|
|
24
|
+
| `datasource` | `any[]` (optional) | The raw datasource (array for associated, string name for datapage) |
|
|
25
|
+
| `columns` | `any[]` | Column config for extracting key/value from datasource records |
|
|
26
|
+
| `parameters` | `any` (optional) | Query parameters for data page calls |
|
|
27
|
+
| `deferDatasource` | `boolean` (optional) | If true, transform `datasourceMetadata` into datapage config |
|
|
28
|
+
| `datasourceMetadata` | `any` (optional) | Metadata from deferred datasource resolution |
|
|
29
|
+
| `fieldMetadata` | `any` (optional) | Field metadata for localization context |
|
|
30
|
+
| `onRecordChange` | `any` (optional) | Callback fired after a selection change |
|
|
31
|
+
|
|
32
|
+
## Behavioral Contract
|
|
33
|
+
|
|
34
|
+
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).
|
|
35
|
+
2. **Datasource detection:** Use `isDeepEqual` (deep equality) to compare incoming `datasource` prop with cached `theDatasource` state. If different, update `theDatasource` to trigger a `useEffect`.
|
|
36
|
+
3. **Deferred datasource transformation:** If `deferDatasource && datasourceMetadata?.datasource?.name`:
|
|
37
|
+
- Override `listType = 'datapage'`
|
|
38
|
+
- Set `datasource = datasourceMetadata.datasource.name` (string page name)
|
|
39
|
+
- Flatten `parameters` from `{key: {name, value}}` format to `{name: value}` pairs
|
|
40
|
+
- Build `columns` from `propertyForDisplayText` and `propertyForValue`
|
|
41
|
+
4. **Column preprocessing:** Strip leading `.` from column `value` fields.
|
|
42
|
+
5. **Loading options for `associated` listType:** In `useEffect` watching `theDatasource`, call `Utils.getOptionList(props, pConn.getDataObject(''))`. Prepend a placeholder option `{key: placeholder, value: localizedPlaceholder}`.
|
|
43
|
+
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.
|
|
44
|
+
7. **Placeholder:** Default `'Select...'` if not provided. Prepended as the first option for associated lists.
|
|
45
|
+
8. **On change:**
|
|
46
|
+
- If selected value equals `placeholder`, treat as empty string: `selectedValue = evt.target.value === placeholder ? '' : evt.target.value`.
|
|
47
|
+
- Commit via `handleEvent(actionsApi, 'changeNblur', propName, selectedValue)`.
|
|
48
|
+
- Fire `onRecordChange(evt)` if provided.
|
|
49
|
+
9. **Read-only:** Set `readOnly: true` on the select input. Flat/borderless style. Change handler omitted.
|
|
50
|
+
10. **Localization:** Option labels and display values are localized via `pConn.getLocalizedValue(label, localePath, localeRuleName)`.
|
|
51
|
+
|
|
52
|
+
## Display Mode Rendering
|
|
53
|
+
|
|
54
|
+
Display modes use the **resolved display value** (the `value` string matching the selected `key`), NOT the raw stored key:
|
|
55
|
+
```
|
|
56
|
+
options.find(option => option.key === value)?.value || value
|
|
57
|
+
```
|
|
58
|
+
Both modes pass this resolved value through `pConn.getLocalizedValue()` for localization:
|
|
59
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={localizedDisplayValue} />`
|
|
60
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={localizedDisplayValue} variant='stacked' />`
|
|
61
|
+
|
|
62
|
+
## Read-Only Rendering
|
|
63
|
+
|
|
64
|
+
Set `readOnly: true` on the select element. Flat/borderless variant. Change handler removed.
|
|
65
|
+
|
|
66
|
+
## Visual Specifications
|
|
67
|
+
|
|
68
|
+
| Property | Standard (editable) | Read-only |
|
|
69
|
+
|----------|---------------------|-----------|
|
|
70
|
+
| Width | 100% | 100% |
|
|
71
|
+
| Size | Small | Small |
|
|
72
|
+
| Variant | Outlined | Standard (flat) |
|
|
73
|
+
| Placeholder option | First option in list (`'Select...'`) | Not shown |
|
|
74
|
+
| Options | Rendered as select menu items | — |
|
|
75
|
+
| Error state | Red border + red helper text | — |
|
|
76
|
+
| Label | Floating label | — |
|
|
77
|
+
|
|
78
|
+
**CSS-only notes:**
|
|
79
|
+
```css
|
|
80
|
+
select { width: 100%; height: 40px; border: 1px solid rgba(0,0,0,0.23); border-radius: 4px; padding: 8px 12px; font-size: 0.875rem; }
|
|
81
|
+
select:focus { border-color: #1976d2; outline: none; }
|
|
82
|
+
select.error { border-color: #d32f2f; }
|
|
83
|
+
select[readonly] { border: none; background: transparent; pointer-events: none; }
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Edge Cases & Special Logic
|
|
87
|
+
|
|
88
|
+
- Do NOT render the component until `options.length > 0` — return `null` until options load.
|
|
89
|
+
- **Localization keys:** Build from `fieldMetadata`:
|
|
90
|
+
- `localeContext`: `'datapage'` if `tableType === 'DataPage'`, else `'associated'`
|
|
91
|
+
- `localeClass`: `'@baseclass'` for datapage, else the case className
|
|
92
|
+
- `localeName`, `localePath` derived from datasource name and display text property
|
|
93
|
+
- `displayMode` check must resolve the key→value mapping — it calls `displayFn(displayMode, resolvedValue)`.
|
|
94
|
+
|
|
95
|
+
## Dependencies
|
|
96
|
+
|
|
97
|
+
- `isDeepEqual` from `fast-deep-equal/react` — for datasource change detection.
|
|
98
|
+
- `Utils.getOptionList()` from `../../helpers/utils` — for associated list options.
|
|
99
|
+
- `getDataPage()` from `../../helpers/data_page` — for datapage async fetch.
|
|
100
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
101
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
102
|
+
|
|
103
|
+
## Design System Mapping
|
|
104
|
+
|
|
105
|
+
**UI control type:** Single-select dropdown / select box.
|
|
106
|
+
|
|
107
|
+
Listed design systems are examples only.
|
|
108
|
+
|
|
109
|
+
| Design System | Recommended Component |
|
|
110
|
+
|---|---|
|
|
111
|
+
| Default (CSS only) | `<select>` with `<option>` elements |
|
|
112
|
+
| MUI | `<TextField select>` with `<MenuItem>` children |
|
|
113
|
+
| Ant Design | `<Select>` with `<Select.Option>` |
|
|
114
|
+
| Chakra UI | `<Select>` |
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Skill: Email
|
|
2
|
+
|
|
3
|
+
Email input field with a leading mail icon, 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 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.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Email`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Text-Email`
|
|
17
|
+
- **Registration key:** `Email` (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 (`''` default).
|
|
29
|
+
2. **Sync from store:** `useEffect` watching `value` → `setInputValue(value)`.
|
|
30
|
+
3. **On change:** Update local state only (`setInputValue(event.target.value)`).
|
|
31
|
+
4. **On blur:** Commit via `handleEvent(actions, 'changeNblur', propName, inputValue)`.
|
|
32
|
+
5. **Input type:** Use `type='email'` for browser-native email format validation.
|
|
33
|
+
6. **Read-only:** Delegate entirely to `TextInput` component: `return <TextInput {...props} />`. Do NOT render the email-specific UI.
|
|
34
|
+
|
|
35
|
+
## Display Mode Rendering
|
|
36
|
+
|
|
37
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={value} />` — raw email string, no formatting.
|
|
38
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />`.
|
|
39
|
+
|
|
40
|
+
## Read-Only Rendering
|
|
41
|
+
|
|
42
|
+
Delegate to `TextInput`: `return <TextInput {...props} />`. This means the mail icon adornment is NOT shown in read-only mode.
|
|
43
|
+
|
|
44
|
+
## Visual Specifications
|
|
45
|
+
|
|
46
|
+
Derived from the reference component's MUI props and styles:
|
|
47
|
+
|
|
48
|
+
| Property | Value |
|
|
49
|
+
|----------|-------|
|
|
50
|
+
| Width | 100% |
|
|
51
|
+
| Size | Small (~40px height) |
|
|
52
|
+
| Variant | Outlined |
|
|
53
|
+
| Leading icon | Mail/envelope icon (`position='start'` adornment) |
|
|
54
|
+
| Icon color | Inherits text color |
|
|
55
|
+
| Border | 1px solid outlined |
|
|
56
|
+
| Border radius | 4px |
|
|
57
|
+
| Error state | Red border + red helper text |
|
|
58
|
+
| Helper text | Below input |
|
|
59
|
+
| Placeholder | From `placeholder` prop (`''` default) |
|
|
60
|
+
|
|
61
|
+
**CSS-only implementation notes:**
|
|
62
|
+
```css
|
|
63
|
+
.email-input-wrapper {
|
|
64
|
+
position: relative;
|
|
65
|
+
display: flex;
|
|
66
|
+
align-items: center;
|
|
67
|
+
width: 100%;
|
|
68
|
+
border: 1px solid rgba(0, 0, 0, 0.23);
|
|
69
|
+
border-radius: 4px;
|
|
70
|
+
padding: 8px 14px 8px 36px; /* left padding for icon */
|
|
71
|
+
}
|
|
72
|
+
.email-input-icon {
|
|
73
|
+
position: absolute;
|
|
74
|
+
left: 10px;
|
|
75
|
+
color: rgba(0, 0, 0, 0.54);
|
|
76
|
+
pointer-events: none;
|
|
77
|
+
}
|
|
78
|
+
.email-input-wrapper.error {
|
|
79
|
+
border-color: #d32f2f;
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Edge Cases & Special Logic
|
|
84
|
+
|
|
85
|
+
- The `type='email'` attribute triggers browser-native validation — this is intentional and supplements Pega's server-side validation.
|
|
86
|
+
- In read-only mode, the full delegation to `TextInput` means the component renders without the mail icon adornment.
|
|
87
|
+
- `onBlur` is only attached when `!readOnly`.
|
|
88
|
+
|
|
89
|
+
## Dependencies
|
|
90
|
+
|
|
91
|
+
- `handleEvent` from `../../helpers/event-utils`
|
|
92
|
+
- `getComponentFromRegistry('TextInput')` — for read-only delegation
|
|
93
|
+
- `getComponentFromRegistry('FieldValueList')` — for display modes
|
|
94
|
+
- A mail/envelope icon (e.g., from an icon library or inline SVG)
|
|
95
|
+
|
|
96
|
+
## Design System Mapping
|
|
97
|
+
|
|
98
|
+
**UI control type:** Email text input with leading icon adornment.
|
|
99
|
+
|
|
100
|
+
Listed design systems are examples only.
|
|
101
|
+
|
|
102
|
+
| Design System | Recommended Component |
|
|
103
|
+
|---|---|
|
|
104
|
+
| Default (CSS only) | `<input type="email">` with absolutely-positioned icon |
|
|
105
|
+
| MUI | `<TextField type='email' InputProps={{ startAdornment: <MailIcon /> }} />` |
|
|
106
|
+
| Ant Design | `<Input type="email" prefix={<MailOutlined />} />` |
|
|
107
|
+
| Chakra UI | `<InputGroup><InputLeftElement><EmailIcon /></InputLeftElement><Input type="email" /></InputGroup>` |
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Skill: Group
|
|
2
|
+
|
|
3
|
+
Field group container that wraps child fields in a collapsible section with an optional heading and instructions.
|
|
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
|
+
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.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Group`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Group`
|
|
17
|
+
- **Registration key:** `Group` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Description |
|
|
22
|
+
|------|------|-------------|
|
|
23
|
+
| `children` | `ReactElement[]` | Child field components to render inside the group |
|
|
24
|
+
| `heading` | `string` | The group heading/title |
|
|
25
|
+
| `showHeading` | `boolean` | Whether to display the heading |
|
|
26
|
+
| `instructions` | `string` (optional) | Instructional text shown below the heading |
|
|
27
|
+
| `collapsible` | `boolean` | Whether the group can be collapsed |
|
|
28
|
+
| `type` | `string` | Group type (used for layout context) |
|
|
29
|
+
|
|
30
|
+
`displayMode` is also consumed from `PConnFieldProps`.
|
|
31
|
+
|
|
32
|
+
## Behavioral Contract
|
|
33
|
+
|
|
34
|
+
1. **No state, no event handling** — purely structural/layout.
|
|
35
|
+
2. **`isReadOnly` flag:** `isReadOnly = displayMode === 'DISPLAY_ONLY'` — passed through to grid for layout context.
|
|
36
|
+
3. **Content grid:** Build a responsive grid of children using `useMemo` (memoized based on `children`, `type`, `isReadOnly`):
|
|
37
|
+
- Each child gets a full-width grid item (`xs: 12` in a 12-column grid, or equivalent `100%` column).
|
|
38
|
+
- Children are mapped with their `key` prop preserved.
|
|
39
|
+
4. **Null guard:** If `!children`, return `null`.
|
|
40
|
+
5. **Heading:** Pass `showHeading ? heading : undefined` to `FieldGroup` — if `showHeading` is false, heading is `undefined` (not shown).
|
|
41
|
+
6. **FieldGroup:** Resolved via `getComponentFromRegistry('FieldGroup')`. Receives `name`, `collapsible`, and `instructions` props.
|
|
42
|
+
|
|
43
|
+
## Display Mode Rendering
|
|
44
|
+
|
|
45
|
+
`displayMode` is not explicitly handled — it's passed through as a prop for context. `FieldGroup` and children handle their own display mode behavior.
|
|
46
|
+
|
|
47
|
+
## Visual Specifications
|
|
48
|
+
|
|
49
|
+
The visual appearance is determined by the `FieldGroup` design system extension component. `Group` itself only applies grid layout to children:
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
Grid container (spacing=2):
|
|
53
|
+
per child → Grid item (xs: 12, full width)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**CSS-only grid layout:**
|
|
57
|
+
```css
|
|
58
|
+
.field-group-children { display: grid; grid-template-columns: 1fr; gap: 16px; }
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
The `FieldGroup` component itself provides:
|
|
62
|
+
- Optional heading/title above the children
|
|
63
|
+
- Optional collapse/expand control
|
|
64
|
+
- Optional instructions text
|
|
65
|
+
- Container border/background (design-system-dependent)
|
|
66
|
+
|
|
67
|
+
## Edge Cases & Special Logic
|
|
68
|
+
|
|
69
|
+
- **`useMemo` dependencies:** `[children, type, isReadOnly]` — the grid re-renders only when these change, not on every parent render.
|
|
70
|
+
- Children must have stable `key` props for React reconciliation.
|
|
71
|
+
- `instructions` may be undefined — `FieldGroup` should handle this gracefully.
|
|
72
|
+
|
|
73
|
+
## Dependencies
|
|
74
|
+
|
|
75
|
+
- `getComponentFromRegistry('FieldGroup')` — design system extension providing the collapsible container.
|
|
76
|
+
- `useMemo` from React.
|
|
77
|
+
- Grid layout component (e.g., MUI `Grid`).
|
|
78
|
+
|
|
79
|
+
## Design System Mapping
|
|
80
|
+
|
|
81
|
+
**UI control type:** Collapsible field group container with heading.
|
|
82
|
+
|
|
83
|
+
Listed design systems are examples only.
|
|
84
|
+
|
|
85
|
+
| Design System | Recommended Component |
|
|
86
|
+
|---|---|
|
|
87
|
+
| Default (CSS only) | `<fieldset>` or `<details>/<summary>` for collapsible |
|
|
88
|
+
| MUI | `<Grid container spacing={2}>` with `<Grid size={{ xs: 12 }}>` per child |
|
|
89
|
+
| Ant Design | `<Collapse>` panel or `<Card>` |
|
|
90
|
+
| Chakra UI | `<Box>` or `<Accordion>` |
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Skill: Integer
|
|
2
|
+
|
|
3
|
+
Integer-only text input that filters out decimal separators, 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 single-line text input restricted to integer values. Actively filters out decimal (`.`) and thousands separator (`,`) characters as the user types, mimicking Pega's native integer field behavior. Delegates read-only rendering to `TextInput`.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Integer`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Integer`
|
|
17
|
+
- **Registration key:** `Integer` (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 (`''` default).
|
|
29
|
+
2. **Sync from store:** `useEffect` watching `value` → `setInputValue(value)`.
|
|
30
|
+
3. **On change (character filtering):** Before updating local state, inspect the last character typed:
|
|
31
|
+
- If the last character is `.` or `,`, strip it from the value: `event.target.value = theAttemptedValue.slice(0, -1)`.
|
|
32
|
+
- Then update local state with the sanitized value.
|
|
33
|
+
- This "eating" of separator characters replicates Pega's native integer field behavior.
|
|
34
|
+
4. **Input mode:** Set `inputMode='numeric'` and `pattern='[0-9]*'` on the input element for mobile keyboards.
|
|
35
|
+
5. **Input type:** Use `type='text'` (NOT `type='number'`) — this avoids browser-specific number input quirks.
|
|
36
|
+
6. **On blur:** Commit via `handleEvent(actions, 'changeNblur', propName, inputValue)`.
|
|
37
|
+
7. **Read-only:** Delegate to `TextInput`: `return <TextInput {...props} />`.
|
|
38
|
+
|
|
39
|
+
## Display Mode Rendering
|
|
40
|
+
|
|
41
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={value} />`.
|
|
42
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />`.
|
|
43
|
+
|
|
44
|
+
## Read-Only Rendering
|
|
45
|
+
|
|
46
|
+
Delegate to `TextInput`: `return <TextInput {...props} />`.
|
|
47
|
+
|
|
48
|
+
## Visual Specifications
|
|
49
|
+
|
|
50
|
+
Identical to `TextInput` visually:
|
|
51
|
+
|
|
52
|
+
| Property | Value |
|
|
53
|
+
|----------|-------|
|
|
54
|
+
| Width | 100% |
|
|
55
|
+
| Size | Small (~40px height) |
|
|
56
|
+
| Variant | Outlined |
|
|
57
|
+
| Border | 1px solid |
|
|
58
|
+
| Border radius | 4px |
|
|
59
|
+
| Error state | Red border + red helper text |
|
|
60
|
+
| Input mode | `numeric` (shows numeric keyboard on mobile) |
|
|
61
|
+
| Pattern | `[0-9]*` |
|
|
62
|
+
|
|
63
|
+
## Edge Cases & Special Logic
|
|
64
|
+
|
|
65
|
+
- **Character filtering is inline** — do NOT use `type='number'` as it introduces inconsistent behavior across browsers (e.g., accepts `e`, `+`, `-` by default).
|
|
66
|
+
- The disallowed characters array is `['.', ',']` — both decimal point and thousands separator are rejected.
|
|
67
|
+
- Strip only the LAST character if it is disallowed — do not strip from anywhere else in the string (user may paste a valid integer that is then validated by blur).
|
|
68
|
+
- `onBlur` is omitted when `readOnly`.
|
|
69
|
+
|
|
70
|
+
## Dependencies
|
|
71
|
+
|
|
72
|
+
- `handleEvent` from `../../helpers/event-utils`
|
|
73
|
+
- `getComponentFromRegistry('TextInput')` — for read-only delegation
|
|
74
|
+
- `getComponentFromRegistry('FieldValueList')` — for display modes
|
|
75
|
+
|
|
76
|
+
## Design System Mapping
|
|
77
|
+
|
|
78
|
+
**UI control type:** Numeric text input (integer-only) — use `<input type="text" inputmode="numeric" pattern="[0-9]*">`.
|
|
79
|
+
|
|
80
|
+
Listed design systems are examples only.
|
|
81
|
+
|
|
82
|
+
| Design System | Recommended Component |
|
|
83
|
+
|---|---|
|
|
84
|
+
| Default (CSS only) | `<input type="text" inputMode="numeric" pattern="[0-9]*">` |
|
|
85
|
+
| MUI | `<TextField type='text' slotProps={{ htmlInput: { inputMode: 'numeric', pattern: '[0-9]*' } }} />` |
|
|
86
|
+
| Ant Design | `<InputNumber precision={0} />` or `<Input />` with custom `onChange` filter |
|
|
87
|
+
| Chakra UI | `<NumberInput allowMouseWheel={false} />` or plain `<Input>` with filter |
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
# Skill: Location
|
|
2
|
+
|
|
3
|
+
Location input with Google Maps Places autocomplete, interactive map display, and optional geolocation (current location).
|
|
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 text input that integrates with Google Maps Places API for address/location autocomplete. Optionally shows an interactive map with a marker. Supports an `onlyCoordinates` mode that stores `"lat, lng"` instead of address text. Includes a "get current location" button using the browser geolocation API.
|
|
12
|
+
|
|
13
|
+
## Pega Metadata
|
|
14
|
+
|
|
15
|
+
- **Pega Name:** `Location`
|
|
16
|
+
- **Type / Subtype:** `Field` / `Text-Location`
|
|
17
|
+
- **Registration key:** `Location` (in `component-map.ts`)
|
|
18
|
+
|
|
19
|
+
## Props (component-specific)
|
|
20
|
+
|
|
21
|
+
| Prop | Type | Default | Description |
|
|
22
|
+
|------|------|---------|-------------|
|
|
23
|
+
| `coordinates` | `string` (optional) | `''` | Comma-separated lat/lng string (e.g., `'18.5204, 73.8567'`) |
|
|
24
|
+
| `onlyCoordinates` | `boolean` (optional) | `false` | If `true`, store and display lat/lng coordinates instead of address text |
|
|
25
|
+
| `showMap` | `boolean` (optional) | — | Show the interactive map in editable mode |
|
|
26
|
+
| `showMapReadOnly` | `boolean` (optional) | — | Show the map in read-only mode |
|
|
27
|
+
|
|
28
|
+
## Behavioral Contract
|
|
29
|
+
|
|
30
|
+
1. **APIs required:**
|
|
31
|
+
- Google Maps JavaScript API with `places` and `geocoding` libraries
|
|
32
|
+
- API key obtained from `pConn.getGoogleMapsAPIKey?.() || ''`
|
|
33
|
+
2. **Local state:**
|
|
34
|
+
- `inputValue` (string): shown in the text input
|
|
35
|
+
- `mapCenter` (`{lat, lng}`): default `{ lat: 18.5204, lng: 73.8567 }` (Pune, India)
|
|
36
|
+
- `markerPosition` (`{lat, lng} | null`)
|
|
37
|
+
3. **Value sync:** `useEffect` watching `value`, `coordinates`, `onlyCoordinates`:
|
|
38
|
+
- If `onlyCoordinates && coordinates`: `setInputValue(coordinates)`
|
|
39
|
+
- Else: `setInputValue(value ?? '')`
|
|
40
|
+
- If `coordinates` exists: parse `lat, lng`, update `mapCenter` and `markerPosition`
|
|
41
|
+
4. **Places Autocomplete (init):** `useEffect` watching `isLoaded` — once Maps API loads and `inputRef.current` is set, attach `new google.maps.places.Autocomplete(inputRef.current)` and add `place_changed` listener.
|
|
42
|
+
5. **On place changed:**
|
|
43
|
+
- Get `place.geometry.location` → extract `lat`, `lng`
|
|
44
|
+
- If `onlyCoordinates`: `inputValue = "${lat}, ${lng}"`, commit this as the value AND update `coordinates` property
|
|
45
|
+
- Else: `inputValue = place.formatted_address`, commit address as value, update `coordinates` property separately: `actions.updateFieldValue(coordPropName, coordinateString)`
|
|
46
|
+
- Update `mapCenter` and `markerPosition`
|
|
47
|
+
6. **On text change (manual):**
|
|
48
|
+
- Update `inputValue` and commit immediately via `handleEvent(actions, 'changeNblur', propName, newValue)`
|
|
49
|
+
- If input cleared and `coordPropName` exists: `actions.updateFieldValue(coordPropName, '')`; `setMarkerPosition(null)`
|
|
50
|
+
7. **Get current location button:**
|
|
51
|
+
- Use `navigator.geolocation.getCurrentPosition()`
|
|
52
|
+
- If `onlyCoordinates`: store `"lat, lng"` as value and coordinates
|
|
53
|
+
- Else: reverse-geocode using `google.maps.Geocoder`, store address as value, `"lat, lng"` as coordinates
|
|
54
|
+
8. **Coordinate property name:** `coordPropName = (pConn.getStateProps() as any).coordinates` — separate from the main `propName`
|
|
55
|
+
9. **Error display:** If `status === 'error' && !!validatemessage && !disabled`, show an error alert ABOVE the input.
|
|
56
|
+
10. **Read-only:** Delegate text to `TextInput`, optionally show map if `showMapReadOnly`.
|
|
57
|
+
|
|
58
|
+
### Map configuration (disabled state)
|
|
59
|
+
|
|
60
|
+
When `disabled`, map options disable all interactions:
|
|
61
|
+
- `gestureHandling: 'none'`, `keyboardShortcuts: false`, `disableDefaultUI: true`, `clickableIcons: false`
|
|
62
|
+
- Map opacity: `0.7` when disabled
|
|
63
|
+
|
|
64
|
+
### CSS for Google Maps autocomplete dropdown z-index:
|
|
65
|
+
```css
|
|
66
|
+
/* Location.css */
|
|
67
|
+
.pac-container { z-index: 2147483647; }
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Display Mode Rendering
|
|
71
|
+
|
|
72
|
+
- **`DISPLAY_ONLY`:** `<FieldValueList name={hideLabel ? '' : label} value={value} />` — raw address/coordinates string.
|
|
73
|
+
- **`STACKED_LARGE_VAL`:** `<FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />`.
|
|
74
|
+
|
|
75
|
+
## Read-Only Rendering
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
<div>
|
|
79
|
+
<TextInput {...props} />
|
|
80
|
+
{isLoaded && showMapReadOnly && <GoogleMap ... />}
|
|
81
|
+
</div>
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Visual Specifications
|
|
85
|
+
|
|
86
|
+
| Property | Value |
|
|
87
|
+
|----------|-------|
|
|
88
|
+
| Width | 100% |
|
|
89
|
+
| Input variant | Default (outlined, from `TextField`) |
|
|
90
|
+
| Trailing icon | Location pin icon button (for current location) |
|
|
91
|
+
| Error alert | Alert banner ABOVE the input field when `hasError` |
|
|
92
|
+
| Map container | `width: 100%`, `height: 300px`, `marginTop: 0px` |
|
|
93
|
+
| Map render | Only shown when `isLoaded && (showMap || showMapReadOnly)` |
|
|
94
|
+
| Disabled map opacity | `0.7` |
|
|
95
|
+
|
|
96
|
+
**CSS companion file required:** `Location.css` with:
|
|
97
|
+
```css
|
|
98
|
+
.pac-container { z-index: 2147483647; }
|
|
99
|
+
```
|
|
100
|
+
This ensures the Google Maps autocomplete dropdown appears above modal/dialog overlays.
|
|
101
|
+
|
|
102
|
+
**CSS-only implementation notes:**
|
|
103
|
+
- Location pin button: `<button>` with `position: absolute; right: 8px; top: 50%; transform: translateY(-50%);`
|
|
104
|
+
|
|
105
|
+
## Edge Cases & Special Logic
|
|
106
|
+
|
|
107
|
+
- **`isLoaded` guard:** Only render the `TextField` and map after Google Maps API is fully loaded.
|
|
108
|
+
- **`onlyCoordinates` mode:** The stored `value` is `"lat, lng"` format; coordinates and address are the same.
|
|
109
|
+
- **Dual property:** The component writes to TWO properties — `propName` (address or coordinates) and `coordPropName` (coordinates). `coordPropName` may be undefined if the Pega config doesn't include a coordinates property.
|
|
110
|
+
- **Autocomplete ref lifecycle:** `autocompleteRef` is only initialized once (when `!autocompleteRef.current`). The `handlePlaceChanged` callback must be stable (`useCallback` with deps).
|
|
111
|
+
- **Map default center:** Pune, India — `{ lat: 18.5204, lng: 73.8567 }`.
|
|
112
|
+
- Google Maps Geocoder is only called in non-`onlyCoordinates` geolocation mode for reverse geocoding.
|
|
113
|
+
|
|
114
|
+
## Dependencies
|
|
115
|
+
|
|
116
|
+
- Google Maps JavaScript API (loaded dynamically via `@react-google-maps/api` or equivalent loader).
|
|
117
|
+
- `@react-google-maps/api` — `GoogleMap`, `Marker`, `useLoadScript`.
|
|
118
|
+
- `handleEvent` from `../../helpers/event-utils`.
|
|
119
|
+
- `getComponentFromRegistry('TextInput')` for read-only.
|
|
120
|
+
- `getComponentFromRegistry('FieldValueList')` for display modes.
|
|
121
|
+
- A location pin icon.
|
|
122
|
+
|
|
123
|
+
**CSS companion:** `Location.css` — must be imported to fix autocomplete z-index.
|
|
124
|
+
|
|
125
|
+
## Design System Mapping
|
|
126
|
+
|
|
127
|
+
**UI control type:** Text input with location autocomplete dropdown + optional map.
|
|
128
|
+
|
|
129
|
+
Listed design systems are examples only.
|
|
130
|
+
|
|
131
|
+
| Design System | Recommended Component |
|
|
132
|
+
|---|---|
|
|
133
|
+
| Default (CSS only) | `<input type="text">` + Google Maps Autocomplete API + Google Map embed |
|
|
134
|
+
| MUI | `<TextField>` + `InputAdornment` for icon + `@react-google-maps/api` |
|
|
135
|
+
| Ant Design | `<Input suffix={<LocationIcon />}>` + Google Maps |
|
|
136
|
+
| Chakra UI | `<InputGroup>` + `<InputRightElement>` + Google Maps |
|