@pega/custom-dx-components 0.24.7 → 0.24.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.24.7",
+  "version": "0.24.9",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/constants.js

@@ -139,6 +139,10 @@ export const COMPONENT_SCHEMA = {
         name: 'URL',
         value: 'Text-URL'
       },
+      {
+        name: 'Icon Button URL',
+        value: 'Icon-Button-URL'
+      },
       {
         name: 'Integer',
         value: 'Integer'

package/src/tasks/create/index.js

@@ -73,6 +73,9 @@ const compileMustacheTemplates = async (
       case 'Picklist-RadioButtons':
         mustacheSubType = 'Picklist';
         break;
+      case 'Icon-Button-URL':
+        mustacheSubType = 'Text-URL';
+        break;
     }
   }
 

package/src/tasks/create/templates/Constellation/Field/Icon-Button-URL/PConnProps.d.ts.mustache

@@ -0,0 +1,46 @@
+import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+
+// PConnProps.d.ts
+// This gives us a place to have each component (which is most DX Components) that is
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [key: string]: any;
+}
+
+
+// PConnFieldProps extends PConnProps to bring in the common properties that are
+// associated with most field components (ex: Dropdown, TextInput, etc.) in the
+//  components/field directory
+export interface PConnFieldProps extends PConnProps {
+  label: string,
+  required: boolean,
+  disabled: boolean,
+  value: any,
+  validatemessage: string,
+  status?: string,
+  onChange?: any,
+  onBlur?: any,
+  readOnly: boolean,
+  testId: string,
+  helperText: string,
+  displayMode?: string,
+  hideLabel: boolean,
+  placeholder?: string,
+  fieldMetadata?: any,
+  additionalProps?: any
+}

package/src/tasks/create/templates/Constellation/Field/Icon-Button-URL/config.json.mustache

@@ -0,0 +1,64 @@
+{
+  "name": "{{COMPONENT_KEY}}",
+  "label": "{{COMPONENT_LABEL}}",
+  "description": "{{DESCRIPTION}}",
+  "organization": "{{ORGANIZATION}}",
+  "version": "{{VERSION}}",
+  "library": "{{LIBRARY}}",
+  "allowedApplications": {{{ALLOWEDAPPS}}},
+  "componentKey": "{{COMPONENT_KEY}}",
+  "type": "{{TYPE}}",
+  "subtype": {{{SUB_TYPE}}},
+  "icon": "images/pz-url-active.svg",
+  "properties": [
+    {
+      "format": "SELECT",
+      "name": "countryCode",
+      "label": "Country code",
+      "defaultValue": "USA",
+      "source": [
+        {
+          "key": "USA",
+          "value": "United States"
+        },
+        {
+          "key": "CAN",
+          "value": "Canada"
+        },
+        {
+          "key": "AUS",
+          "value": "Australia"
+        },
+        {
+          "key": "JPN",
+          "value": "Japan"
+        },
+        {
+          "key": "IND",
+          "value": "India"
+        },
+        {
+          "key": "TUR",
+          "value": "Turkey"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/src/tasks/create/templates/Constellation/Field/Icon-Button-URL/demo.stories.tsx.mustache

@@ -0,0 +1,99 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import type { Meta, StoryObj } from '@storybook/react';
+
+import {{COMPONENT_CLASS_NAME}} from './index';
+import { stateProps, configProps } from './mock';
+
+const meta: Meta<typeof {{COMPONENT_CLASS_NAME}}> = {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  component: {{COMPONENT_CLASS_NAME}},
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+const statelistData = {
+  data: [
+    {
+      pyLabel: 'Massachusetts',
+      pyStateCode: 'MA'
+    },
+    {
+      pyLabel: 'Rhode Island',
+      pyStateCode: 'RI'
+    },
+    {
+      pyLabel: 'Connecticut',
+      pyStateCode: 'CT'
+    }
+  ]
+};
+
+window.PCore.getDataPageUtils = () => {
+  return {
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(statelistData);
+      });
+    }
+  };
+};
+
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
+
+  const props = {
+    countryCode: configProps.countryCode,
+    getPConnect: () => {
+      return {
+        getValue: value => {
+          return value;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: value => {
+          return value;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {
+              /* nothing */
+            },
+            triggerFieldChange: () => {
+              /* nothing */
+            }
+          };
+        },
+        ignoreSuggestion: () => {
+          /* nothing */
+        },
+        acceptSuggestion: () => {
+          /* nothing */
+        },
+        setInheritedProps: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} {...args} />
+    </>
+  );
+};
+
+Base{{COMPONENT_CLASS_NAME}}.args = {
+  countryCode: configProps.countryCode
+};

package/src/tasks/create/templates/Constellation/Field/Icon-Button-URL/index.tsx.mustache

@@ -0,0 +1,145 @@
+import { useEffect, useState } from 'react';
+import {
+  Icon,
+  Button,
+  withConfiguration,
+  registerIcon,
+  Table,
+  Label
+} from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+// IMPORTANT
+// To use Icons, need to individually import the icon file form @pega/cosmos-react-core (see path below)
+// Icons filename is kabab case (file-name), where as the icon you import is camel case (fileName)
+// Icons need to be registered (camel case), and then used (kabab case)
+import * as listNumber from '@pega/cosmos-react-core/lib/components/Icon/icons/list-number.icon';
+import * as arrowRight from '@pega/cosmos-react-core/lib/components/Icon/icons/arrow-right.icon';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  countryCode: string;
+}
+
+// *************
+// This component is meant to be an example of usage (Icon, Button, etc.) and NOT meant to be
+// used "as is"
+//
+// In this example, Icon is shown on its own and inside a Button
+// Though an Icon can have an "onClick" event is it recommended if you want to click on it,
+// to put it in a Button (shown below), so you can have a tooltip and hover style
+//
+// In this example, the click will get a list of states for a given country and display in a
+// table below.  The table dispaly will toggle with the click of the button icon.
+//
+// NOTE: because icons have to be imported and registered, you can NOT put the icon name
+// inside the config.json and let the user pick it, if it is not already part of your
+// import and registration (can't be done on the fly)
+// **************
+
+// props passed in combination of props from property panel (config.json) and run time props from Constellation
+// any default values in config.pros should be set in defaultProps at bottom of this file
+function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
+  const { countryCode = 'USA', getPConnect } = props;
+  const [statelist, setStatelist] = useState([]);
+  const [showTable, setShowTable] = useState(false);
+  const PConnect = getPConnect();
+
+  // IMPORTANT: need to register icons used in camel case
+  registerIcon(listNumber, arrowRight);
+
+
+   // setting up columns for the work list table
+  const columns = [
+    { renderer: 'stateName', label: PConnect.getLocalizedValue('State name', '', '') },
+    { renderer: 'stateCode', label: PConnect.getLocalizedValue('State code', '', '') }
+  ];
+
+  // toggle showing table and getting table data
+  function showHideTable() {
+    setShowTable(prevShowTable => !prevShowTable);
+  }
+
+  // going to get data for worklist to put into a table
+  // data comes from calling a PCore function to get
+  // get data from a data page and a PConnect function
+  // to get getContextName
+  useEffect(() => {
+    const dataViewName = 'D_pyStateList';
+    const context = PConnect.getContextName();
+    const params = { pyCountry: countryCode };
+
+    // only retrieve table data if table is shown
+    if (showTable) {
+      PCore.getDataPageUtils()
+        .getDataAsync(dataViewName, context, params, null, null)
+        // @ts-ignore
+        .then((response: any) => {
+          // table requires an index or will get setExtraStackFrame error
+          setStatelist(
+            response.data.map((entry: any, index: number) => {
+              // mapping the data into the column names
+              // MUST have an id/index or will get a setExtraStackFrame error
+              // put a key in the table
+              return {
+                stateName: entry.pyLabel,
+                stateCode: entry.pyStateCode,
+                id: index
+              };
+            })
+          );
+        })
+        .catch((error: any) => {
+          console.log(error);
+        });
+    }
+  }, [PConnect, countryCode, showTable]);
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+{{! pick new delimiters for mustache }}
+{{=<% %>=}}
+      <Icon
+        style={{ height: '1.5rem', width: '1.5rem' }}
+        // icon name is kabab case
+        name='arrow-right'
+        role='img'
+        aria-label='arrow right'
+      />
+      <Label>
+        {' '}
+        {PConnect.getLocalizedValue('State list for', '', '')}{' '}
+        {PConnect.getLocalizedValue(`${countryCode}`, '', '')}{' '}
+      </Label>
+      <Button
+        icon
+        label={PConnect.getLocalizedValue('Click to show/hide state list', '', '')}
+        variant='link'
+        compact={false}
+        onClick={showHideTable}
+      >
+        <Icon
+          style={{ height: '1.5rem', width: '1.5rem' }}
+          // icon name is kabab case
+          name='list-number'
+          role='img'
+          aria-label='numbered list'
+        />
+      </Button>
+      {showTable && (
+        <Table
+          title={PConnect.getLocalizedValue('State list', '', '')}
+          columns={columns}
+          data={statelist}
+        />
+      )}
+<%={{ }}=%>     {{! revert delimiters for mustache }}
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+
+export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Constellation/Field/Icon-Button-URL/mock.ts.mustache

@@ -0,0 +1,5 @@
+
+// @ts-nocheck
+export const configProps = {
+  countryCode: 'USA'
+};

package/src/tasks/create/templates/Constellation/Field/Icon-Button-URL/styles.ts.mustache

@@ -0,0 +1,8 @@
+// individual style, comment out above, and uncomment here and add styles
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/src/tasks/create/templates/Constellation/Widget/PAGE/index.tsx.mustache

@@ -48,7 +48,7 @@ function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
     const context = PConnect.getContextName();
 
     PCore.getDataPageUtils()
-      .getDataAsync(dataViewName, context)
+      .getDataAsync(dataViewName, context, {}, null, null)
       // @ts-ignore
       .then((response: any) => {
         // table requires an index or will get setExtraStackFrame error

package/src/tasks/create-all/index.js

@@ -82,6 +82,9 @@ export const compileMustacheTemplates = async (
       case 'Picklist-RadioButtons':
         mustacheSubType = 'Picklist';
         break;
+      case 'Icon-Button-URL':
+        mustacheSubType = 'Text-URL';
+        break;
     }
   }
 

package/src/tasks/init/template/package.json.mustache

@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.6.0",
-    "@pega/custom-dx-components": "0.24.7",
+    "@pega/custom-dx-components": "0.24.9",
     "@pega/pcore-pconnect-typedefs": "~3.0.0",
     "@storybook/addon-actions": "^7.6.7",
     "@storybook/addon-essentials": "^7.6.7",

package/src/tasks/validator/index.js

@@ -350,7 +350,13 @@ export default async (option) => {
   }
 
   //const data = JSON.parse(fs.readFileSync(path.resolve(configFile), 'utf8'));
-  const data = JSON.parse(configData);
+  let data;
+  try {
+    data = JSON.parse(configData);
+  }
+  catch (er) {
+    throw new Error(`Invalid schema json in config.json: ${er}`);
+  }
 
   const valid = validateSchema(data);
 

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/PConnProps.d.ts

@@ -0,0 +1,46 @@
+import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+
+// PConnProps.d.ts
+// This gives us a place to have each component (which is most DX Components) that is
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [key: string]: any;
+}
+
+
+// PConnFieldProps extends PConnProps to bring in the common properties that are
+// associated with most field components (ex: Dropdown, TextInput, etc.) in the
+//  components/field directory
+export interface PConnFieldProps extends PConnProps {
+  label: string,
+  required: boolean,
+  disabled: boolean,
+  value: any,
+  validatemessage: string,
+  status?: string,
+  onChange?: any,
+  onBlur?: any,
+  readOnly: boolean,
+  testId: string,
+  helperText: string,
+  displayMode?: string,
+  hideLabel: boolean,
+  placeholder?: string,
+  fieldMetadata?: any,
+  additionalProps?: any
+}

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/config.json

@@ -0,0 +1,64 @@
+{
+  "name": "Pega_DXIL_MyIconButtonURL",
+  "label": "My Icon Button URL",
+  "description": "My Icon Button URL",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyIconButtonURL",
+  "type": "Field",
+  "subtype": "Text-URL",
+  "icon": "images/pz-url-active.svg",
+  "properties": [
+    {
+      "format": "SELECT",
+      "name": "countryCode",
+      "label": "Country code",
+      "defaultValue": "USA",
+      "source": [
+        {
+          "key": "USA",
+          "value": "United States"
+        },
+        {
+          "key": "CAN",
+          "value": "Canada"
+        },
+        {
+          "key": "AUS",
+          "value": "Australia"
+        },
+        {
+          "key": "JPN",
+          "value": "Japan"
+        },
+        {
+          "key": "IND",
+          "value": "India"
+        },
+        {
+          "key": "TUR",
+          "value": "Turkey"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/demo.stories.tsx

@@ -0,0 +1,99 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import type { Meta, StoryObj } from '@storybook/react';
+
+import PegaDxilMyIconButtonUrl from './index';
+import { stateProps, configProps } from './mock';
+
+const meta: Meta<typeof PegaDxilMyIconButtonUrl> = {
+  title: 'PegaDxilMyIconButtonUrl',
+  component: PegaDxilMyIconButtonUrl,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyIconButtonUrl>;
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+const statelistData = {
+  data: [
+    {
+      pyLabel: 'Massachusetts',
+      pyStateCode: 'MA'
+    },
+    {
+      pyLabel: 'Rhode Island',
+      pyStateCode: 'RI'
+    },
+    {
+      pyLabel: 'Connecticut',
+      pyStateCode: 'CT'
+    }
+  ]
+};
+
+window.PCore.getDataPageUtils = () => {
+  return {
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(statelistData);
+      });
+    }
+  };
+};
+
+export const BasePegaDxilMyIconButtonUrl: Story = args => {
+
+  const props = {
+    countryCode: configProps.countryCode,
+    getPConnect: () => {
+      return {
+        getValue: value => {
+          return value;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: value => {
+          return value;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {
+              /* nothing */
+            },
+            triggerFieldChange: () => {
+              /* nothing */
+            }
+          };
+        },
+        ignoreSuggestion: () => {
+          /* nothing */
+        },
+        acceptSuggestion: () => {
+          /* nothing */
+        },
+        setInheritedProps: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyIconButtonUrl {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMyIconButtonUrl.args = {
+  countryCode: configProps.countryCode
+};

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/index.tsx

@@ -0,0 +1,142 @@
+import { useEffect, useState } from 'react';
+import {
+  Icon,
+  Button,
+  withConfiguration,
+  registerIcon,
+  Table,
+  Label
+} from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+// IMPORTANT
+// To use Icons, need to individually import the icon file form @pega/cosmos-react-core (see path below)
+// Icons filename is kabab case (file-name), where as the icon you import is camel case (fileName)
+// Icons need to be registered (camel case), and then used (kabab case)
+import * as listNumber from '@pega/cosmos-react-core/lib/components/Icon/icons/list-number.icon';
+import * as arrowRight from '@pega/cosmos-react-core/lib/components/Icon/icons/arrow-right.icon';
+
+import StyledPegaDxilMyIconButtonUrlWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyIconButtonUrlProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  countryCode: string;
+}
+
+// *************
+// This component is meant to be an example of usage (Icon, Button, etc.) and NOT meant to be
+// used "as is"
+//
+// In this example, Icon is shown on its own and inside a Button
+// Though an Icon can have an "onClick" event is it recommended if you want to click on it,
+// to put it in a Button (shown below), so you can have a tooltip and hover style
+//
+// In this example, the click will get a list of states for a given country and display in a
+// table below.  The table dispaly will toggle with the click of the button icon.
+//
+// NOTE: because icons have to be imported and registered, you can NOT put the icon name
+// inside the config.json and let the user pick it, if it is not already part of your
+// import and registration (can't be done on the fly)
+// **************
+
+// props passed in combination of props from property panel (config.json) and run time props from Constellation
+// any default values in config.pros should be set in defaultProps at bottom of this file
+function PegaDxilMyIconButtonUrl(props: PegaDxilMyIconButtonUrlProps) {
+  const { countryCode = 'USA', getPConnect } = props;
+  const [statelist, setStatelist] = useState([]);
+  const [showTable, setShowTable] = useState(false);
+  const PConnect = getPConnect();
+
+  // IMPORTANT: need to register icons used in camel case
+  registerIcon(listNumber, arrowRight);
+
+
+   // setting up columns for the work list table
+  const columns = [
+    { renderer: 'stateName', label: PConnect.getLocalizedValue('State name', '', '') },
+    { renderer: 'stateCode', label: PConnect.getLocalizedValue('State code', '', '') }
+  ];
+
+  // toggle showing table and getting table data
+  function showHideTable() {
+    setShowTable(prevShowTable => !prevShowTable);
+  }
+
+  // going to get data for worklist to put into a table
+  // data comes from calling a PCore function to get
+  // get data from a data page and a PConnect function
+  // to get getContextName
+  useEffect(() => {
+    const dataViewName = 'D_pyStateList';
+    const context = PConnect.getContextName();
+    const params = { pyCountry: countryCode };
+
+    // only retrieve table data if table is shown
+    if (showTable) {
+      PCore.getDataPageUtils()
+        .getDataAsync(dataViewName, context, params, null, null)
+        // @ts-ignore
+        .then((response: any) => {
+          // table requires an index or will get setExtraStackFrame error
+          setStatelist(
+            response.data.map((entry: any, index: number) => {
+              // mapping the data into the column names
+              // MUST have an id/index or will get a setExtraStackFrame error
+              // put a key in the table
+              return {
+                stateName: entry.pyLabel,
+                stateCode: entry.pyStateCode,
+                id: index
+              };
+            })
+          );
+        })
+        .catch((error: any) => {
+          console.log(error);
+        });
+    }
+  }, [PConnect, countryCode, showTable]);
+
+  return (
+    <StyledPegaDxilMyIconButtonUrlWrapper>
+      <Icon
+        style={{ height: '1.5rem', width: '1.5rem' }}
+        // icon name is kabab case
+        name='arrow-right'
+        role='img'
+        aria-label='arrow right'
+      />
+      <Label>
+        {' '}
+        {PConnect.getLocalizedValue('State list for', '', '')}{' '}
+        {PConnect.getLocalizedValue(`${countryCode}`, '', '')}{' '}
+      </Label>
+      <Button
+        icon
+        label={PConnect.getLocalizedValue('Click to show/hide state list', '', '')}
+        variant='link'
+        compact={false}
+        onClick={showHideTable}
+      >
+        <Icon
+          style={{ height: '1.5rem', width: '1.5rem' }}
+          // icon name is kabab case
+          name='list-number'
+          role='img'
+          aria-label='numbered list'
+        />
+      </Button>
+      {showTable && (
+        <Table
+          title={PConnect.getLocalizedValue('State list', '', '')}
+          columns={columns}
+          data={statelist}
+        />
+      )}
+    </StyledPegaDxilMyIconButtonUrlWrapper>
+  );
+}
+
+
+export default withConfiguration(PegaDxilMyIconButtonUrl);

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/mock.ts

@@ -0,0 +1,5 @@
+
+// @ts-nocheck
+export const configProps = {
+  countryCode: 'USA'
+};

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/styles.ts

@@ -0,0 +1,8 @@
+// individual style, comment out above, and uncomment here and add styles
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPageWidget/index.tsx

@@ -48,7 +48,7 @@ function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
     const context = PConnect.getContextName();
 
     PCore.getDataPageUtils()
-      .getDataAsync(dataViewName, context)
+      .getDataAsync(dataViewName, context, {}, null, null)
       // @ts-ignore
       .then((response: any) => {
         // table requires an index or will get setExtraStackFrame error

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/PConnProps.d.ts

@@ -0,0 +1,46 @@
+import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+
+// PConnProps.d.ts
+// This gives us a place to have each component (which is most DX Components) that is
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [key: string]: any;
+}
+
+
+// PConnFieldProps extends PConnProps to bring in the common properties that are
+// associated with most field components (ex: Dropdown, TextInput, etc.) in the
+//  components/field directory
+export interface PConnFieldProps extends PConnProps {
+  label: string,
+  required: boolean,
+  disabled: boolean,
+  value: any,
+  validatemessage: string,
+  status?: string,
+  onChange?: any,
+  onBlur?: any,
+  readOnly: boolean,
+  testId: string,
+  helperText: string,
+  displayMode?: string,
+  hideLabel: boolean,
+  placeholder?: string,
+  fieldMetadata?: any,
+  additionalProps?: any
+}

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/config.json

@@ -0,0 +1,64 @@
+{
+  "name": "Pega_DXIL_MyIconButtonURL",
+  "label": "My Icon Button URL",
+  "description": "My Icon Button URL",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyIconButtonURL",
+  "type": "Field",
+  "subtype": "Text-URL",
+  "icon": "images/pz-url-active.svg",
+  "properties": [
+    {
+      "format": "SELECT",
+      "name": "countryCode",
+      "label": "Country code",
+      "defaultValue": "USA",
+      "source": [
+        {
+          "key": "USA",
+          "value": "United States"
+        },
+        {
+          "key": "CAN",
+          "value": "Canada"
+        },
+        {
+          "key": "AUS",
+          "value": "Australia"
+        },
+        {
+          "key": "JPN",
+          "value": "Japan"
+        },
+        {
+          "key": "IND",
+          "value": "India"
+        },
+        {
+          "key": "TUR",
+          "value": "Turkey"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/demo.stories.tsx

@@ -0,0 +1,99 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import type { Meta, StoryObj } from '@storybook/react';
+
+import PegaDxilMyIconButtonUrl from './index';
+import { stateProps, configProps } from './mock';
+
+const meta: Meta<typeof PegaDxilMyIconButtonUrl> = {
+  title: 'PegaDxilMyIconButtonUrl',
+  component: PegaDxilMyIconButtonUrl,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyIconButtonUrl>;
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+const statelistData = {
+  data: [
+    {
+      pyLabel: 'Massachusetts',
+      pyStateCode: 'MA'
+    },
+    {
+      pyLabel: 'Rhode Island',
+      pyStateCode: 'RI'
+    },
+    {
+      pyLabel: 'Connecticut',
+      pyStateCode: 'CT'
+    }
+  ]
+};
+
+window.PCore.getDataPageUtils = () => {
+  return {
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(statelistData);
+      });
+    }
+  };
+};
+
+export const BasePegaDxilMyIconButtonUrl: Story = args => {
+
+  const props = {
+    countryCode: configProps.countryCode,
+    getPConnect: () => {
+      return {
+        getValue: value => {
+          return value;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: value => {
+          return value;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {
+              /* nothing */
+            },
+            triggerFieldChange: () => {
+              /* nothing */
+            }
+          };
+        },
+        ignoreSuggestion: () => {
+          /* nothing */
+        },
+        acceptSuggestion: () => {
+          /* nothing */
+        },
+        setInheritedProps: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyIconButtonUrl {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMyIconButtonUrl.args = {
+  countryCode: configProps.countryCode
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/index.tsx

@@ -0,0 +1,142 @@
+import { useEffect, useState } from 'react';
+import {
+  Icon,
+  Button,
+  withConfiguration,
+  registerIcon,
+  Table,
+  Label
+} from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+// IMPORTANT
+// To use Icons, need to individually import the icon file form @pega/cosmos-react-core (see path below)
+// Icons filename is kabab case (file-name), where as the icon you import is camel case (fileName)
+// Icons need to be registered (camel case), and then used (kabab case)
+import * as listNumber from '@pega/cosmos-react-core/lib/components/Icon/icons/list-number.icon';
+import * as arrowRight from '@pega/cosmos-react-core/lib/components/Icon/icons/arrow-right.icon';
+
+import StyledPegaDxilMyIconButtonUrlWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyIconButtonUrlProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  countryCode: string;
+}
+
+// *************
+// This component is meant to be an example of usage (Icon, Button, etc.) and NOT meant to be
+// used "as is"
+//
+// In this example, Icon is shown on its own and inside a Button
+// Though an Icon can have an "onClick" event is it recommended if you want to click on it,
+// to put it in a Button (shown below), so you can have a tooltip and hover style
+//
+// In this example, the click will get a list of states for a given country and display in a
+// table below.  The table dispaly will toggle with the click of the button icon.
+//
+// NOTE: because icons have to be imported and registered, you can NOT put the icon name
+// inside the config.json and let the user pick it, if it is not already part of your
+// import and registration (can't be done on the fly)
+// **************
+
+// props passed in combination of props from property panel (config.json) and run time props from Constellation
+// any default values in config.pros should be set in defaultProps at bottom of this file
+function PegaDxilMyIconButtonUrl(props: PegaDxilMyIconButtonUrlProps) {
+  const { countryCode = 'USA', getPConnect } = props;
+  const [statelist, setStatelist] = useState([]);
+  const [showTable, setShowTable] = useState(false);
+  const PConnect = getPConnect();
+
+  // IMPORTANT: need to register icons used in camel case
+  registerIcon(listNumber, arrowRight);
+
+
+   // setting up columns for the work list table
+  const columns = [
+    { renderer: 'stateName', label: PConnect.getLocalizedValue('State name', '', '') },
+    { renderer: 'stateCode', label: PConnect.getLocalizedValue('State code', '', '') }
+  ];
+
+  // toggle showing table and getting table data
+  function showHideTable() {
+    setShowTable(prevShowTable => !prevShowTable);
+  }
+
+  // going to get data for worklist to put into a table
+  // data comes from calling a PCore function to get
+  // get data from a data page and a PConnect function
+  // to get getContextName
+  useEffect(() => {
+    const dataViewName = 'D_pyStateList';
+    const context = PConnect.getContextName();
+    const params = { pyCountry: countryCode };
+
+    // only retrieve table data if table is shown
+    if (showTable) {
+      PCore.getDataPageUtils()
+        .getDataAsync(dataViewName, context, params, null, null)
+        // @ts-ignore
+        .then((response: any) => {
+          // table requires an index or will get setExtraStackFrame error
+          setStatelist(
+            response.data.map((entry: any, index: number) => {
+              // mapping the data into the column names
+              // MUST have an id/index or will get a setExtraStackFrame error
+              // put a key in the table
+              return {
+                stateName: entry.pyLabel,
+                stateCode: entry.pyStateCode,
+                id: index
+              };
+            })
+          );
+        })
+        .catch((error: any) => {
+          console.log(error);
+        });
+    }
+  }, [PConnect, countryCode, showTable]);
+
+  return (
+    <StyledPegaDxilMyIconButtonUrlWrapper>
+      <Icon
+        style={{ height: '1.5rem', width: '1.5rem' }}
+        // icon name is kabab case
+        name='arrow-right'
+        role='img'
+        aria-label='arrow right'
+      />
+      <Label>
+        {' '}
+        {PConnect.getLocalizedValue('State list for', '', '')}{' '}
+        {PConnect.getLocalizedValue(`${countryCode}`, '', '')}{' '}
+      </Label>
+      <Button
+        icon
+        label={PConnect.getLocalizedValue('Click to show/hide state list', '', '')}
+        variant='link'
+        compact={false}
+        onClick={showHideTable}
+      >
+        <Icon
+          style={{ height: '1.5rem', width: '1.5rem' }}
+          // icon name is kabab case
+          name='list-number'
+          role='img'
+          aria-label='numbered list'
+        />
+      </Button>
+      {showTable && (
+        <Table
+          title={PConnect.getLocalizedValue('State list', '', '')}
+          columns={columns}
+          data={statelist}
+        />
+      )}
+    </StyledPegaDxilMyIconButtonUrlWrapper>
+  );
+}
+
+
+export default withConfiguration(PegaDxilMyIconButtonUrl);

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/mock.ts

@@ -0,0 +1,5 @@
+
+// @ts-nocheck
+export const configProps = {
+  countryCode: 'USA'
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/styles.ts

@@ -0,0 +1,8 @@
+// individual style, comment out above, and uncomment here and add styles
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPageWidget/index.tsx

@@ -48,7 +48,7 @@ function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
     const context = PConnect.getContextName();
 
     PCore.getDataPageUtils()
-      .getDataAsync(dataViewName, context)
+      .getDataAsync(dataViewName, context, {}, null, null)
       // @ts-ignore
       .then((response: any) => {
         // table requires an index or will get setExtraStackFrame error