@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,144 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: ListView
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: ListView
|
|
7
|
+
|
|
8
|
+
Full-featured list view template. Renders a data table with sorting, pagination, global search, single/multi selection, column menu, and filter dialog.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
The primary data table component. Renders a sortable, paginated, filterable, and selectable table from a PConnect data source. Supports both standalone page use (`bInForm: false`) and embedded form use (`bInForm: true`). Columns are configurable, and the table supports row-level selection with callback.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `ListView` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Data display template
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `bInForm` | `boolean` | No | Whether rendered inside a form (affects toolbar and padding). Default `false` |
|
|
29
|
+
| `selectionMode` | `string` | No | `'single'` (radio) or `'multi'` (checkbox) or absent (no selection) |
|
|
30
|
+
| `dataPageName` | `string` | No | Name of data page to fetch records from |
|
|
31
|
+
| `referenceList` | `array` | No | In-memory data array (used when data is already available) |
|
|
32
|
+
| `compositeKeys` | `object` | No | Key fields for unique row identification |
|
|
33
|
+
| `columns` | `array` | No | Column definition objects `{ fieldName, label, sortable, filterable }` |
|
|
34
|
+
| `additionalTableConfig` | `object` | No | Extra config merged with column/sort/filter settings |
|
|
35
|
+
| `isSearchable` | `boolean` | No | Whether global search input is shown |
|
|
36
|
+
| `payload` | `object` | No | Query payload for data page requests |
|
|
37
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
38
|
+
|
|
39
|
+
## Behavioral Contract
|
|
40
|
+
|
|
41
|
+
### Initialization
|
|
42
|
+
|
|
43
|
+
`useInit(getPConnect, columns, dataPageName, payload)` hook:
|
|
44
|
+
1. Calls `initializeColumns(getPConnect, columns)` to build `configFields`.
|
|
45
|
+
2. Calls `buildFieldsForTable(configFields)` to produce display column definitions.
|
|
46
|
+
3. Calls `getConfigFields(configFields)` for sort/filter metadata.
|
|
47
|
+
4. Fetches initial data via `PCore.getDataApiUtils().getDataAsync(dataPageName, payload)`.
|
|
48
|
+
5. Returns `{ tableDataRows, configFields, totalCount }`.
|
|
49
|
+
|
|
50
|
+
### Sorting
|
|
51
|
+
|
|
52
|
+
- `<TableSortLabel>` in each sortable column header.
|
|
53
|
+
- On click: call `PCore.getDataApiUtils().getDataAsync(dataPageName, { ...payload, sortBy, sortOrder })`.
|
|
54
|
+
- `sortBy` = column field name, `sortOrder` = `'ASC'` or `'DESC'`.
|
|
55
|
+
|
|
56
|
+
### Pagination
|
|
57
|
+
|
|
58
|
+
- `<TablePagination>` component below the table.
|
|
59
|
+
- `rowsPerPageOptions`: `[5, 10, 25]`.
|
|
60
|
+
- On page/rows change: re-fetch with `startIndex` and `maxResults` params.
|
|
61
|
+
|
|
62
|
+
### Global Search
|
|
63
|
+
|
|
64
|
+
- Shown when `isSearchable === true`.
|
|
65
|
+
- `<TextField>` input above the table (toolbar area).
|
|
66
|
+
- On submit/debounce: re-fetch with `searchText` param.
|
|
67
|
+
|
|
68
|
+
### Selection
|
|
69
|
+
|
|
70
|
+
| `selectionMode` | Control per row | Callback |
|
|
71
|
+
|---|---|---|
|
|
72
|
+
| `'single'` | `<Radio>` | `onRowSelect(rowData)` |
|
|
73
|
+
| `'multi'` | `<Checkbox>` | `onRowsSelect(selectedRows)` |
|
|
74
|
+
| absent | None | None |
|
|
75
|
+
|
|
76
|
+
- Select-all checkbox in the header for multi-selection.
|
|
77
|
+
- Selected rows highlighted with `selected` row class.
|
|
78
|
+
|
|
79
|
+
### Column Menu
|
|
80
|
+
|
|
81
|
+
- `<MoreVertIcon>` button in each column header.
|
|
82
|
+
- Opens `<Menu>` with options: Show/Hide column, Pin column.
|
|
83
|
+
- Column visibility stored in local state `columnVisibility`.
|
|
84
|
+
|
|
85
|
+
### Filter Dialog
|
|
86
|
+
|
|
87
|
+
- Filter icon in toolbar or column header.
|
|
88
|
+
- Opens `<Dialog>` with filter form fields for each filterable column.
|
|
89
|
+
- On apply: re-fetch with filter params.
|
|
90
|
+
- `filterData(filters, configFields)` formats filter objects for the API.
|
|
91
|
+
|
|
92
|
+
### Snackbar Toast
|
|
93
|
+
|
|
94
|
+
- Shown on fetch errors or action feedback.
|
|
95
|
+
- Auto-hides after 3000ms.
|
|
96
|
+
|
|
97
|
+
## Visual Specifications
|
|
98
|
+
|
|
99
|
+
| Element | Description |
|
|
100
|
+
|---------|-------------|
|
|
101
|
+
| Toolbar | Search input + filter button + (optional) action buttons |
|
|
102
|
+
| Table head | Sticky header with sort labels and column menu |
|
|
103
|
+
| Table body | Striped rows, hover state, selected state |
|
|
104
|
+
| Pagination bar | Below table, page size selector + page nav |
|
|
105
|
+
|
|
106
|
+
**CSS-only implementation notes:**
|
|
107
|
+
- Table container: `overflow-x: auto`.
|
|
108
|
+
- Header row: `background: var(--table-header-bg); font-weight: 600`.
|
|
109
|
+
- Selected row: `background: var(--selection-highlight-bg)`.
|
|
110
|
+
- Hover row: `background: var(--hover-bg)`.
|
|
111
|
+
- Sticky header: `position: sticky; top: 0; z-index: 1`.
|
|
112
|
+
|
|
113
|
+
## Edge Cases & Special Logic
|
|
114
|
+
|
|
115
|
+
- `bInForm: true` — remove outer padding, hide some toolbar elements.
|
|
116
|
+
- Empty result set — show empty state message `"No records found"`.
|
|
117
|
+
- `compositeKeys` — used for unique row key generation when no single ID field exists.
|
|
118
|
+
- Column visibility changes are local state only — not persisted by default.
|
|
119
|
+
- Large datasets — pagination is mandatory; do not load all rows at once.
|
|
120
|
+
|
|
121
|
+
## Dependencies
|
|
122
|
+
|
|
123
|
+
- `useInit`, `filterData`, `buildFieldsForTable`, `getConfigFields`, `initializeColumns` from `./utils`
|
|
124
|
+
- `PCore.getDataApiUtils().getDataAsync()` — data fetching
|
|
125
|
+
- MUI: `<Table>`, `<TableHead>`, `<TableBody>`, `<TableRow>`, `<TableCell>`, `<TableSortLabel>`, `<TablePagination>`, `<Checkbox>`, `<Radio>`, `<Dialog>`, `<TextField>`, `<Menu>`, `<MenuItem>`, `<Snackbar>`
|
|
126
|
+
|
|
127
|
+
## Design System Mapping
|
|
128
|
+
|
|
129
|
+
**UI control type:** Full-featured data table with sorting, pagination, search, selection, and filtering.
|
|
130
|
+
|
|
131
|
+
Listed design systems are examples only.
|
|
132
|
+
|
|
133
|
+
| Design System | Table | Pagination | Dialog |
|
|
134
|
+
|---|---|---|---|
|
|
135
|
+
| Default (CSS only) | `<table>/<thead>/<tbody>` | Custom pagination controls | `<dialog>` element |
|
|
136
|
+
| MUI | `<Table>` + sub-components | `<TablePagination>` | `<Dialog>` |
|
|
137
|
+
| Ant Design | `<Table>` | Built-in pagination prop | `<Modal>` |
|
|
138
|
+
| Chakra UI | `<Table>` | Custom or `react-table` | `<Modal>` |
|
|
139
|
+
| Shadcn/ui | `<Table>` + TanStack Table | Custom pagination | `<Dialog>` |
|
|
140
|
+
|
|
141
|
+
When implementing in a specific design system:
|
|
142
|
+
- `bInForm` prop affects layout — tighten spacing and remove outer chrome when `true`
|
|
143
|
+
- Sorting, pagination, and search all trigger data re-fetches — do not filter client-side for server-paged data
|
|
144
|
+
- Selection mode (`single`/`multi`) requires different controls and callbacks
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: MultiReferenceReadOnly
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: MultiReferenceReadOnly
|
|
7
|
+
|
|
8
|
+
Multi-reference read-only template. Routes to `SimpleTableSelectReadonly` or `SimpleTable` based on `displayAs` for read-only rendering of multi-value reference fields.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders a multi-value reference field in read-only mode. Routing is based on the `displayAs` prop: certain display variants use `SimpleTableSelectReadonly` (link + modal), while others use `SimpleTable` directly.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `MultiReferenceReadOnly` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Display template — read-only multi-reference
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `displayAs` | `string` | Yes | UI variant that was used in edit mode |
|
|
29
|
+
| `referenceList` | `string` | No | Property path to the reference list |
|
|
30
|
+
| `readonlyContextList` | `array` | No | Fallback data array when `referenceList` is not resolved |
|
|
31
|
+
| `fieldMetadata` | `object` | No | Field-level metadata |
|
|
32
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
33
|
+
|
|
34
|
+
## Behavioral Contract
|
|
35
|
+
|
|
36
|
+
### Routing by `displayAs`
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
if displayAs in ['readonlyMulti', 'combobox', 'checkboxgroup']:
|
|
40
|
+
→ render SimpleTableSelectReadonly
|
|
41
|
+
else:
|
|
42
|
+
→ render SimpleTable (with readOnly=true / displayMode='DISPLAY_ONLY')
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Reference List Fallback
|
|
46
|
+
|
|
47
|
+
- Primary: `pConn.getValue(referenceList + '.pxResults')`.
|
|
48
|
+
- Fallback: use `readonlyContextList` directly if the above is undefined/empty.
|
|
49
|
+
|
|
50
|
+
## Visual Specifications
|
|
51
|
+
|
|
52
|
+
- `SimpleTableSelectReadonly` variant: link/chip showing selection count + modal dialog.
|
|
53
|
+
- `SimpleTable` variant: flat read-only table of values.
|
|
54
|
+
|
|
55
|
+
See `SimpleTable.md` and `ListView.md` for detailed visual specs.
|
|
56
|
+
|
|
57
|
+
**CSS-only notes:**
|
|
58
|
+
- Fallback to `readonlyContextList` renders identically to the resolved reference list.
|
|
59
|
+
- No edit controls in either variant.
|
|
60
|
+
|
|
61
|
+
## Edge Cases & Special Logic
|
|
62
|
+
|
|
63
|
+
- `readonlyContextList` is the fallback — always use it when `pConn.getValue(referenceList)` returns nothing.
|
|
64
|
+
- `displayAs` check uses an inclusion array: `['readonlyMulti', 'combobox', 'checkboxgroup']` — extend this list if new multi-select display variants are added.
|
|
65
|
+
- The component is only reached in `DISPLAY_ONLY`/`readOnly` mode — never needs to handle edit states.
|
|
66
|
+
|
|
67
|
+
## Dependencies
|
|
68
|
+
|
|
69
|
+
- `SimpleTableSelectReadonly` (see `SimpleTable.md`)
|
|
70
|
+
- `SimpleTable` (see `SimpleTable.md`)
|
|
71
|
+
|
|
72
|
+
## Design System Mapping
|
|
73
|
+
|
|
74
|
+
**UI control type:** Read-only multi-value reference display — routes to modal table or flat table.
|
|
75
|
+
|
|
76
|
+
Listed design systems are examples only.
|
|
77
|
+
|
|
78
|
+
| `displayAs` | Routing | DS Implementation |
|
|
79
|
+
|---|---|---|
|
|
80
|
+
| `readonlyMulti`, `combobox`, `checkboxgroup` | `SimpleTableSelectReadonly` | Link/chip + modal |
|
|
81
|
+
| All others | `SimpleTable` | Flat read-only table |
|
|
82
|
+
|
|
83
|
+
When implementing in a specific design system:
|
|
84
|
+
- The `displayAs` routing list must match the edit-mode variants defined in `DataReference.md`
|
|
85
|
+
- `readonlyContextList` fallback is critical — reference list data may not be available on initial render
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: NarrowWide
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: NarrowWide
|
|
7
|
+
|
|
8
|
+
Asymmetric two-column layout with a narrow left column (~33%) and a wide right column (~67%). Includes four sub-variants for different contexts.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders two children side by side with the left column narrower than the right. Used for case layouts where a sidebar panel sits beside a main content area. Four sub-variants:
|
|
17
|
+
|
|
18
|
+
- **`NarrowWide`** — core CSS-based layout, accepts either `a`/`b` slot props or React `children[0]`/`children[1]`
|
|
19
|
+
- **`NarrowWidePage`** — wrapper that passes React children as `a` and `b` slot props to `NarrowWide`
|
|
20
|
+
- **`NarrowWideForm`** — simplified wrapper using only `children` (no `a`/`b` slots, no title/icon)
|
|
21
|
+
- **`NarrowWideDetails`** — details read-only variant; sets children to DISPLAY_ONLY mode and supports highlighted data
|
|
22
|
+
|
|
23
|
+
## Pega Metadata
|
|
24
|
+
|
|
25
|
+
| Variant | Registration Key |
|
|
26
|
+
|---------|-----------------|
|
|
27
|
+
| NarrowWide | `NarrowWide` |
|
|
28
|
+
| NarrowWidePage | `NarrowWidePage` |
|
|
29
|
+
| NarrowWideForm | `NarrowWideForm` |
|
|
30
|
+
| NarrowWideDetails | `NarrowWideDetails` |
|
|
31
|
+
|
|
32
|
+
All extend `PConnProps`.
|
|
33
|
+
|
|
34
|
+
## Props
|
|
35
|
+
|
|
36
|
+
### NarrowWide
|
|
37
|
+
|
|
38
|
+
| Prop | Type | Required | Description |
|
|
39
|
+
|------|------|----------|-------------|
|
|
40
|
+
| `children` | `ReactNode[]` | No | Two children rendered in narrow/wide slots |
|
|
41
|
+
| `a` | `any` | No | Narrow (left) column content |
|
|
42
|
+
| `b` | `any` | No | Wide (right) column content |
|
|
43
|
+
| `title` | `string` | No | Optional title (not rendered in reference implementation) |
|
|
44
|
+
| `cols` | `string` | No | Column template (not rendered in reference implementation) |
|
|
45
|
+
| `icon` | `string` | No | Optional icon (not rendered in reference implementation) |
|
|
46
|
+
|
|
47
|
+
### NarrowWidePage
|
|
48
|
+
|
|
49
|
+
| Prop | Type | Required | Description |
|
|
50
|
+
|------|------|----------|-------------|
|
|
51
|
+
| `children` | `ReactNode[]` | Yes | Two children — `[0]` → narrow slot, `[1]` → wide slot |
|
|
52
|
+
| `title` | `string` | Yes | Page title (passed to NarrowWide) |
|
|
53
|
+
| `templateCol` | `string` | No | Column ratio (default `'1fr 1fr'`) |
|
|
54
|
+
| `icon` | `string` | No | Icon name (strips `'pi pi-'` prefix) |
|
|
55
|
+
|
|
56
|
+
### NarrowWideForm
|
|
57
|
+
|
|
58
|
+
| Prop | Type | Required | Description |
|
|
59
|
+
|------|------|----------|-------------|
|
|
60
|
+
| `children` | `ReactNode[]` | Yes | Two children — `[0]` → narrow slot, `[1]` → wide slot |
|
|
61
|
+
|
|
62
|
+
### NarrowWideDetails
|
|
63
|
+
|
|
64
|
+
| Prop | Type | Required | Description |
|
|
65
|
+
|------|------|----------|-------------|
|
|
66
|
+
| `label` | `string` | Yes | Section label for FieldGroup |
|
|
67
|
+
| `showLabel` | `boolean` | No | Whether to show the label. Default `true` |
|
|
68
|
+
| `showHighlightedData` | `boolean` | No | Whether to render highlighted data fields above children. Default `false` |
|
|
69
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
70
|
+
|
|
71
|
+
## Behavioral Contract
|
|
72
|
+
|
|
73
|
+
### NarrowWide
|
|
74
|
+
|
|
75
|
+
1. If `children` is provided and has exactly 2 items, render `children[0]` in `.psdk-narrow-column-column` and `children[1]` in `.psdk-wide-column-column` (both wrapped in `.psdk-narrow-wide-column`).
|
|
76
|
+
2. If `a` and `b` are provided (and children is empty/not 2 items), render `a` in the narrow slot and `b` in the wide slot.
|
|
77
|
+
3. The two render paths are independent — priority is `children` if length === 2, otherwise `a`/`b`.
|
|
78
|
+
|
|
79
|
+
### NarrowWidePage
|
|
80
|
+
|
|
81
|
+
1. Extract `childrenToRender = children as ReactElement[]`.
|
|
82
|
+
2. Retrieve `NarrowWide` from the component registry.
|
|
83
|
+
3. Render `<NarrowWide a={childrenToRender[0]} b={childrenToRender[1]} title={title} cols={templateCol} icon={icon?.replace('pi pi-', '')} />`.
|
|
84
|
+
|
|
85
|
+
### NarrowWideForm
|
|
86
|
+
|
|
87
|
+
1. Render exactly as `NarrowWide` with `children` path — checks `children.length === 2`, renders narrow/wide slots.
|
|
88
|
+
2. Does not support `a`/`b` props.
|
|
89
|
+
|
|
90
|
+
### NarrowWideDetails
|
|
91
|
+
|
|
92
|
+
1. Call `getPConnect().getInheritedProps()` and merge with `{ label, showLabel }` for `propsToUse`.
|
|
93
|
+
2. Set `getPConnect().setInheritedProp('displayMode', 'DISPLAY_ONLY')` and `setInheritedProp('readOnly', true)`.
|
|
94
|
+
3. Map `getPConnect().getChildren()` → `createElement(PConnectComponent, { ...configObject, key: index })`.
|
|
95
|
+
4. If `showHighlightedData` is true, read `getRawMetadata().config.highlightedData`, set each field's `displayMode = 'STACKED_LARGE_VAL'`, mark `pyStatusWork` fields as `type='TextInput', displayAsStatus=true`, and create components via `getPConnect().createComponent(field, '', 0, {})`.
|
|
96
|
+
5. Wrap everything in `<FieldGroup name={theName}>` where `theName = propsToUse.showLabel && propsToUse.label ? propsToUse.label : ''`.
|
|
97
|
+
6. Layout: highlighted data in `Grid size={{ xs: COLUMN_WIDTHS[i] }}` where `COLUMN_WIDTHS = [4, 8]`, then children in `Grid size={{ xs: 12 }}` rows.
|
|
98
|
+
|
|
99
|
+
## Visual Specifications
|
|
100
|
+
|
|
101
|
+
Derived from `NarrowWide.css`:
|
|
102
|
+
|
|
103
|
+
### Container
|
|
104
|
+
|
|
105
|
+
| CSS Class | Property | Value |
|
|
106
|
+
|-----------|----------|-------|
|
|
107
|
+
| `.psdk-narrow-wide-column` | Display | flex or grid (two-column row) |
|
|
108
|
+
| `.psdk-narrow-column-column` | Width | ~33% (1 of 3 parts) |
|
|
109
|
+
| `.psdk-wide-column-column` | Width | ~67% (2 of 3 parts) |
|
|
110
|
+
|
|
111
|
+
**CSS-only implementation notes:**
|
|
112
|
+
- `.psdk-narrow-wide-column`: `display: grid; grid-template-columns: 1fr 2fr; gap: 1rem`.
|
|
113
|
+
- `.psdk-narrow-column-column`: takes the first (narrower) grid column.
|
|
114
|
+
- `.psdk-wide-column-column`: takes the second (wider) grid column.
|
|
115
|
+
- On mobile: `grid-template-columns: 1fr` (stacks vertically).
|
|
116
|
+
|
|
117
|
+
## Edge Cases & Special Logic
|
|
118
|
+
|
|
119
|
+
- `NarrowWide` supports both `children` and `a`/`b` slot patterns — check `children` length first.
|
|
120
|
+
- `NarrowWideDetails` highlighted data grid uses `[4, 8]` column widths (narrow left, wide right for STACKED_LARGE_VAL fields).
|
|
121
|
+
- `NarrowWideDetails` reads `theName` from `propsToUse` (which merges inherited props) — the `label` prop alone may be overridden by inherited props.
|
|
122
|
+
- Icon cleanup in `NarrowWidePage`: strip `'pi pi-'` prefix from the icon string before passing to `NarrowWide`.
|
|
123
|
+
|
|
124
|
+
## Dependencies
|
|
125
|
+
|
|
126
|
+
- `NarrowWidePage`: `getComponentFromRegistry` from `@pega/sdk-react`
|
|
127
|
+
- `NarrowWideDetails`: `getComponentFromRegistry('FieldGroup')`, `PConnectComponent` from `@pega/sdk-react`
|
|
128
|
+
|
|
129
|
+
## Design System Mapping
|
|
130
|
+
|
|
131
|
+
**UI control type:** Asymmetric two-column layout (sidebar + main content).
|
|
132
|
+
|
|
133
|
+
Listed design systems are examples only.
|
|
134
|
+
|
|
135
|
+
| Design System | Recommended Component |
|
|
136
|
+
|---|---|
|
|
137
|
+
| Default (CSS only) | CSS Grid `grid-template-columns: 1fr 2fr; gap: 1rem` |
|
|
138
|
+
| MUI | `<Grid container><Grid size={{ xs: 12, md: 4 }}><Grid size={{ xs: 12, md: 8 }}>` |
|
|
139
|
+
| Ant Design | `<Row gutter={16}><Col xs={24} md={8}><Col xs={24} md={16}>` |
|
|
140
|
+
| Chakra UI | `<Grid templateColumns={{ base: '1fr', md: '1fr 2fr' }} gap={4}>` |
|
|
141
|
+
| Shadcn/ui | Tailwind `grid grid-cols-1 md:grid-cols-[1fr_2fr] gap-4` |
|
|
142
|
+
|
|
143
|
+
When implementing in a specific design system:
|
|
144
|
+
- Narrow column ≈ 33% width (1fr of 3fr total)
|
|
145
|
+
- Wide column ≈ 67% width (2fr of 3fr total)
|
|
146
|
+
- `NarrowWideDetails` always forces DISPLAY_ONLY + readOnly on children
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: OneColumn
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: OneColumn
|
|
7
|
+
|
|
8
|
+
Single-column layout template that stacks all children in a full-width column.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders all children stacked vertically in a single full-width column. Three closely related sub-variants:
|
|
17
|
+
|
|
18
|
+
- **`OneColumn`** — core layout with internal grid and column style
|
|
19
|
+
- **`OneColumnPage`** — thin wrapper that delegates to `OneColumn` via the component registry
|
|
20
|
+
- **`OneColumnTab`** — minimal pass-through wrapper for tab context (`<div id='OneColumnTab'>`)
|
|
21
|
+
|
|
22
|
+
## Pega Metadata
|
|
23
|
+
|
|
24
|
+
| Variant | Registration Key |
|
|
25
|
+
|---------|-----------------|
|
|
26
|
+
| OneColumn | `OneColumn` |
|
|
27
|
+
| OneColumnPage | `OneColumnPage` |
|
|
28
|
+
| OneColumnTab | `OneColumnTab` |
|
|
29
|
+
|
|
30
|
+
All extend `PConnProps`. Children are received as React `children`.
|
|
31
|
+
|
|
32
|
+
## Props
|
|
33
|
+
|
|
34
|
+
| Prop | Type | Required | Description |
|
|
35
|
+
|------|------|----------|-------------|
|
|
36
|
+
| `children` | `ReactNode[]` | Yes | One or more children to render in the single column |
|
|
37
|
+
|
|
38
|
+
## Sub-Variants
|
|
39
|
+
|
|
40
|
+
### OneColumnPage
|
|
41
|
+
|
|
42
|
+
Thin pass-through wrapper. Retrieves `OneColumn` from the component registry and renders with all props forwarded:
|
|
43
|
+
```typescript
|
|
44
|
+
const OneColumn = getComponentFromRegistry('OneColumn');
|
|
45
|
+
return <OneColumn {...props} />;
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### OneColumnTab
|
|
49
|
+
|
|
50
|
+
Minimal wrapper — renders children in a plain `<div>` with `id='OneColumnTab'`:
|
|
51
|
+
```typescript
|
|
52
|
+
return <div id='OneColumnTab'>{children}</div>;
|
|
53
|
+
```
|
|
54
|
+
No grid or column styles applied. Used purely as a slot container inside tab panels.
|
|
55
|
+
|
|
56
|
+
## Behavioral Contract
|
|
57
|
+
|
|
58
|
+
1. Render a Grid container with `spacing={2}`.
|
|
59
|
+
2. Render a single inner Grid at `size={{ xs: 12 }}` with `colStyles` applied.
|
|
60
|
+
3. Map over all `children` and render each child.
|
|
61
|
+
4. `OneColumnPage` delegates all rendering to `OneColumn` from the registry.
|
|
62
|
+
5. `OneColumnTab` renders children in a plain `<div>` — no Grid, no styles.
|
|
63
|
+
|
|
64
|
+
## Visual Specifications
|
|
65
|
+
|
|
66
|
+
Derived from `OneColumn.tsx` makeStyles:
|
|
67
|
+
|
|
68
|
+
### Column Style
|
|
69
|
+
|
|
70
|
+
| Property | Value |
|
|
71
|
+
|----------|-------|
|
|
72
|
+
| Display | grid |
|
|
73
|
+
| Gap | 1rem |
|
|
74
|
+
| Align content | baseline (children stack top-aligned) |
|
|
75
|
+
|
|
76
|
+
### Grid Spacing
|
|
77
|
+
|
|
78
|
+
| Property | Value |
|
|
79
|
+
|----------|-------|
|
|
80
|
+
| Container spacing | 2 (≈ 16px) |
|
|
81
|
+
|
|
82
|
+
**CSS-only implementation notes:**
|
|
83
|
+
- Column: `display: grid; gap: 1rem; align-content: baseline; width: 100%`.
|
|
84
|
+
- Outer container: `display: grid; grid-template-columns: 1fr; gap: 16px`.
|
|
85
|
+
- `OneColumnTab`: just `<div>` with no special styling.
|
|
86
|
+
|
|
87
|
+
## Edge Cases & Special Logic
|
|
88
|
+
|
|
89
|
+
- `OneColumn` maps over all children (not just first/second) — supports any number of children.
|
|
90
|
+
- `OneColumnPage` uses the registry — if an override exists for `OneColumn`, it will be used.
|
|
91
|
+
- `OneColumnTab` does NOT apply the `colStyles` grid — it is intentionally simpler.
|
|
92
|
+
|
|
93
|
+
## Dependencies
|
|
94
|
+
|
|
95
|
+
- `OneColumnPage`: `getComponentFromRegistry` from `@pega/sdk-react`
|
|
96
|
+
- `OneColumn` / `OneColumnTab`: no special dependencies
|
|
97
|
+
|
|
98
|
+
## Design System Mapping
|
|
99
|
+
|
|
100
|
+
**UI control type:** Single full-width column layout.
|
|
101
|
+
|
|
102
|
+
Listed design systems are examples only.
|
|
103
|
+
|
|
104
|
+
| Design System | Recommended Component |
|
|
105
|
+
|---|---|
|
|
106
|
+
| Default (CSS only) | `<div style="display:grid;gap:1rem;">` wrapping children |
|
|
107
|
+
| MUI | `<Grid container spacing={2}><Grid size={{ xs: 12 }}>` |
|
|
108
|
+
| Ant Design | `<Row><Col span={24}>` |
|
|
109
|
+
| Chakra UI | `<Stack spacing={4}>` or `<Grid templateColumns='1fr'>` |
|
|
110
|
+
| Shadcn/ui | Tailwind `flex flex-col gap-4` |
|
|
111
|
+
|
|
112
|
+
When implementing in a specific design system:
|
|
113
|
+
- All children render in a single column, top-aligned
|
|
114
|
+
- `OneColumnTab` variant is a minimal `<div>` container with no layout styling
|
package/templates/react-sdk-reference/.cursor/rules/skills/template-skills/PromotedFilters.mdrules
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Template component skill: PromotedFilters
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill: PromotedFilters
|
|
7
|
+
|
|
8
|
+
Promoted filters template. Renders a set of promoted filter fields above a `ListView`, allowing users to filter list data through a Clear/Search workflow using transient data.
|
|
9
|
+
|
|
10
|
+
> **Prerequisite skill:** [`template-components.md`](../template-components.md) — covers architecture, child rendering patterns, and registration conventions common to ALL template components.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Component Purpose
|
|
15
|
+
|
|
16
|
+
Renders promoted filter controls above a list view. Filter fields are created dynamically via `PCore.createPConnect` and managed as transient data. On search, filter values are formatted and passed to the `ListView` as a query payload. The component also handles the `ListView` rendering below the filters.
|
|
17
|
+
|
|
18
|
+
## Pega Metadata
|
|
19
|
+
|
|
20
|
+
- **Registration key:** `PromotedFilters` (in `component-map.ts`)
|
|
21
|
+
- **Category:** Search / Filter template
|
|
22
|
+
- **Extends:** `PConnProps`
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Required | Description |
|
|
27
|
+
|------|------|----------|-------------|
|
|
28
|
+
| `viewName` | `string` | Yes | Name of the promoted filters view — used as transient item ID |
|
|
29
|
+
| `dataPageName` | `string` | Yes | Data page name passed to `ListView` |
|
|
30
|
+
| `promotedFilters` | `array` | Yes | Array of filter field definitions `{ name, classID, ... }` |
|
|
31
|
+
| `payload` | `object` | No | Base query payload for the data page |
|
|
32
|
+
| `isSearchable` | `boolean` | No | Whether the ListView below shows a global search input |
|
|
33
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
34
|
+
|
|
35
|
+
## Behavioral Contract
|
|
36
|
+
|
|
37
|
+
### Transient Data Setup
|
|
38
|
+
|
|
39
|
+
On mount:
|
|
40
|
+
1. Build `filtersWithClassID`: add `classID` to each filter from `getPConnect().getContextName()` or metadata.
|
|
41
|
+
2. Call `PCore.getDataPageUtils().addTransientItem({ id: viewName, data: filtersWithClassID })`.
|
|
42
|
+
3. This creates a transient data context for the filter fields.
|
|
43
|
+
|
|
44
|
+
### Filters Sub-Component
|
|
45
|
+
|
|
46
|
+
The `<Filters>` inline sub-component:
|
|
47
|
+
1. Creates each filter field via `PCore.createPConnect({ ... filterFieldConfig, contextName: viewName + '.' + filter.name })`.
|
|
48
|
+
2. Renders each created pConnect as a field component via `createElement(PConnectComponent, { ...fieldConfig })`.
|
|
49
|
+
|
|
50
|
+
### Search
|
|
51
|
+
|
|
52
|
+
On Search button click:
|
|
53
|
+
1. Call `getFilterData(viewName, promotedFilters)`:
|
|
54
|
+
- For each filter, read current value from transient store.
|
|
55
|
+
- Build filter objects: `{ lhs: { field: filter.name }, comparator: 'EQ', rhs: { value: currentValue } }`.
|
|
56
|
+
- Skip filters with empty/null values.
|
|
57
|
+
2. Pass the resulting filter array to `ListView` as `payload.filters`.
|
|
58
|
+
3. `ListView` re-fetches with the filter payload.
|
|
59
|
+
|
|
60
|
+
### Clear
|
|
61
|
+
|
|
62
|
+
On Clear button click:
|
|
63
|
+
1. Call `clearFilterData(viewName, promotedFilters)`:
|
|
64
|
+
- For each filter, reset the transient value to `''` or `null`.
|
|
65
|
+
2. Reset `payload.filters` to `[]`.
|
|
66
|
+
3. `ListView` re-fetches without filters.
|
|
67
|
+
|
|
68
|
+
### Render Structure
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
<div className="psdk-promoted-filters">
|
|
72
|
+
<div className="psdk-promoted-filters-fields">
|
|
73
|
+
<Filters /> {/* filter fields */}
|
|
74
|
+
</div>
|
|
75
|
+
<div className="psdk-promoted-filters-actions">
|
|
76
|
+
<Button onClick={handleClear}>Clear</Button>
|
|
77
|
+
<Button onClick={handleSearch}>Search</Button>
|
|
78
|
+
</div>
|
|
79
|
+
<ListView bInForm={true} isSearchable={isSearchable} dataPageName={dataPageName} payload={activePayload} />
|
|
80
|
+
</div>
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Visual Specifications
|
|
84
|
+
|
|
85
|
+
| Element | Description |
|
|
86
|
+
|---------|-------------|
|
|
87
|
+
| Filter fields row | Horizontal flex row of filter field inputs |
|
|
88
|
+
| Action buttons | Clear + Search buttons, right-aligned |
|
|
89
|
+
| ListView | Below the filter row, full width |
|
|
90
|
+
|
|
91
|
+
**CSS-only implementation notes:**
|
|
92
|
+
- Outer container: `display: flex; flex-direction: column; gap: 1rem`.
|
|
93
|
+
- Filter fields row: `display: flex; flex-wrap: wrap; gap: 0.5rem; align-items: flex-end`.
|
|
94
|
+
- Action buttons row: `display: flex; gap: 0.5rem; justify-content: flex-end`.
|
|
95
|
+
|
|
96
|
+
## Edge Cases & Special Logic
|
|
97
|
+
|
|
98
|
+
- Transient item must be cleaned up on unmount: call `PCore.getDataPageUtils().removeTransientItem(viewName)`.
|
|
99
|
+
- `getFilterData` skips empty values — a filter with no input is not sent to the query.
|
|
100
|
+
- If all filters are empty, the Search returns unfiltered results.
|
|
101
|
+
- `PCore.createPConnect` creates new pConnect instances for each filter — these must be properly keyed and managed.
|
|
102
|
+
|
|
103
|
+
## Dependencies
|
|
104
|
+
|
|
105
|
+
- `getFilterData`, `clearFilterData` from `./utils`
|
|
106
|
+
- `PCore.getDataPageUtils().addTransientItem()` — transient context setup
|
|
107
|
+
- `PCore.createPConnect()` — creates pConnect instances for filter fields
|
|
108
|
+
- `ListView` — the list below the filters
|
|
109
|
+
- `PConnectComponent` from `@pega/sdk-react`
|
|
110
|
+
- MUI: `<Button>`
|
|
111
|
+
|
|
112
|
+
## Design System Mapping
|
|
113
|
+
|
|
114
|
+
**UI control type:** Filter bar above a list view — transient field inputs + Clear/Search actions.
|
|
115
|
+
|
|
116
|
+
Listed design systems are examples only.
|
|
117
|
+
|
|
118
|
+
| Design System | Filter Row | Action Buttons |
|
|
119
|
+
|---|---|---|
|
|
120
|
+
| Default (CSS only) | `display: flex; flex-wrap: wrap` inputs | `<button>` for Clear/Search |
|
|
121
|
+
| MUI | `<Box display='flex' flexWrap='wrap' gap={1}>` | `<Button>` variants |
|
|
122
|
+
| Ant Design | `<Space wrap>` | `<Button type='primary'>` for Search |
|
|
123
|
+
| Chakra UI | `<HStack wrap='wrap'>` | `<Button colorScheme='blue'>` |
|
|
124
|
+
| Shadcn/ui | Tailwind `flex flex-wrap gap-2` | `<Button>` variants |
|
|
125
|
+
|
|
126
|
+
When implementing in a specific design system:
|
|
127
|
+
- Transient data pattern is critical — each filter field must read/write to `PCore`'s transient store
|
|
128
|
+
- `getFilterData` builds the query filter payload — use it unchanged
|
|
129
|
+
- Transient item cleanup on unmount is required to avoid stale data
|