@pega/dx-component-builder-sdk 0.1.0

package/src/tasks/create/templates/SDK-React/Field/Boolean/index.tsx.mustache

@@ -0,0 +1,109 @@
+/* eslint-disable react/no-unused-prop-types */
+import React, { useState, useEffect } from 'react';
+import {
+  Checkbox,
+  FormControl,
+  FormControlLabel,
+  FormGroup,
+  FormHelperText
+} from '@material-ui/core';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
+import PropTypes from 'prop-types';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// Duplicated runtime code from React SDK
+
+// 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
+export default function {{COMPONENT_CLASS_NAME}}(props: any) {
+  const {
+    getPConnect,
+    value = false,
+    readOnly,
+    testId,
+    required,
+    status,
+    helperText,
+    validatemessage
+  } = props;
+  const helperTextToDisplay = validatemessage || helperText;
+
+  const thePConn = getPConnect();
+  const theConfigProps = thePConn.getConfigProps();
+  const { caption } = theConfigProps;
+  const actionsApi = thePConn.getActionsApi();
+  const propName = thePConn.getStateProps().value;
+
+  const [checked, setChecked] = useState(false);
+  useEffect(() => {
+    // This update theSelectedButton which will update the UI to show the selected button correctly
+    setChecked(value);
+  }, [value]);
+
+  const handleChange = event => {
+    handleEvent(actionsApi, 'changeNblur', propName, event.target.checked);
+  };
+
+  const handleBlur = event => {
+    thePConn.getValidationApi().validate(event.target.checked);
+  };
+
+  let theCheckbox = <Checkbox color='primary' />;
+
+  if (readOnly) {
+    // Workaround for lack of InputProps readOnly from https://github.com/mui-org/material-ui/issues/17043
+    //  Also note that we need to turn off the onChange call in the FormControlLabel wrapper, too. See below!
+    theCheckbox = <Checkbox value={value || false} onChange={handleChange} readOnly={readOnly} />;
+  }
+
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <FormControl required={required} error={status === 'error'}>
+      <FormGroup>
+        <FormControlLabel
+          control={theCheckbox}
+          checked={checked}
+          onChange={!readOnly ? handleChange : undefined}
+          onBlur={handleBlur}
+          label={caption}
+          labelPlacement='end'
+          data-test-id={testId}
+        />
+      </FormGroup>
+      <FormHelperText>{helperTextToDisplay}</FormHelperText>
+    </FormControl>
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  validatemessage: "",
+  value: false,
+  label: "",
+  hideLabel: false,
+  helperText: "",
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: null,
+  additionalProps: {}
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  getPConnect: PropTypes.func.isRequired,
+  validatemessage: PropTypes.string,
+  label: PropTypes.string,
+  hideLabel: PropTypes.bool,
+  helperText: PropTypes.string,
+  value: PropTypes.bool,
+  caption: PropTypes.string.isRequired,
+  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  testId: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any)
+};

package/src/tasks/create/templates/SDK-React/Field/Boolean/styles.js.mustache

@@ -0,0 +1,7 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/src/tasks/create/templates/SDK-React/Field/Date/config.json.mustache

@@ -0,0 +1,133 @@
+{
+  "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-date-time-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "format": "LABEL",
+          "label": "Year range",
+          "variant": "secondary"
+        },
+        {
+          "format": "INLINE",
+          "elements": [
+            {
+              "key": "next",
+              "format": "LABEL",
+              "label": "Next",
+              "variant": "secondary"
+            },
+            {
+              "key": "nextYears",
+              "format": "NUMBER",
+              "label": "",
+              "name": "nextYearRange",
+              "min": 0
+            },
+            {
+              "key": "year",
+              "format": "LABEL",
+              "label": "years",
+              "variant": "secondary"
+            }
+          ]
+        },
+        {
+          "format": "INLINE",
+          "elements": [
+            {
+              "key": "previous",
+              "format": "LABEL",
+              "label": "Previous",
+              "variant": "secondary"
+            },
+            {
+              "key": "previousYears",
+              "format": "NUMBER",
+              "label": "",
+              "name": "previousYearRange",
+              "min": 0
+            },
+            {
+              "key": "year",
+              "format": "LABEL",
+              "label": "years",
+              "variant": "secondary"
+            }
+          ]
+        },
+        {
+          "name": "showWeekNumber",
+          "label": "Display week numbers on calendar",
+          "format": "BOOLEAN"
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "showAsFormattedText",
+          "label": "Show as formatted text",
+          "format": "BOOLEAN"
+        }
+      ]
+    },
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "required",
+          "label": "Required",
+          "format": "REQUIRED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "disabled",
+          "label": "Disabled",
+          "format": "DISABLED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/src/tasks/create/templates/SDK-React/Field/Date/demo.stories.jsx.mustache

@@ -0,0 +1,44 @@
+import { useState } from 'react';
+import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+
+import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  decorators: [withKnobs],
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
+  const [value, setValue] = useState('test value');
+
+  const props = {
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, theValue) => {
+              setValue(theValue);
+            }
+          };
+        },
+        getStateProps: () => {
+          return { value: '.name' };
+        }
+      };
+    },
+    value,
+    placeholder: text('Placeholder', 'Test placeholder'),
+    disabled: boolean('Disabled', false),
+    readOnly: boolean('Disabled', false),
+    required: boolean('Disabled', false),
+    label: text('Label', 'Sample Label'),
+    testId: text('Test id', 'text-12344566')
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};

package/src/tasks/create/templates/SDK-React/Field/Date/index.tsx.mustache

@@ -0,0 +1,122 @@
+/* eslint-disable react/no-unused-prop-types */
+import React from 'react';
+import { KeyboardDatePicker } from '@material-ui/pickers';
+import TextInput from '@pega/react-sdk-components/lib/components/forms/TextInput';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
+import FieldValueList from '@pega/react-sdk-components/lib/components/designSystemExtensions/FieldValueList';
+import PropTypes from 'prop-types';
+
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// Duplicated runtime code from React SDK
+
+// 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
+export default function {{COMPONENT_CLASS_NAME}}(props: any) {
+  const {
+    getPConnect,
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    onChange,
+    onBlur,
+    readOnly,
+    testId,
+    helperText,
+    displayMode
+  } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+  const helperTextToDisplay = validatemessage || helperText;
+
+  if(displayMode === 'LABELS_LEFT'){
+    const field = {
+      [label]: value
+    };
+    return <FieldValueList item={field}/>
+  }
+
+  if (readOnly) {
+    // const theReadOnlyComp = <TextInput props />
+    return <TextInput {...props} />;
+  }
+
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
+  const handleChange = date => {
+    const changeValue = date && date.isValid() ? date.toISOString() : null;
+    onChange({ value: changeValue });
+  };
+
+  const handleAccept = date => {
+    const changeValue = date && date.isValid() ? date.toISOString() : null;
+    handleEvent(actions, 'changeNblur', propName, changeValue);
+  };
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <KeyboardDatePicker
+      disableToolbar
+      variant='inline'
+      inputVariant='outlined'
+      placeholder='mm/dd/yyyy'
+      fullWidth
+      autoOk
+      required={required}
+      disabled={disabled}
+      format='MM/DD/YYYY'
+      mask='__/__/____'
+      error={status === 'error'}
+      helperText={helperTextToDisplay}
+      size='small'
+      label={label}
+      value={value || null}
+      onChange={handleChange}
+      onBlur={onBlur}
+      onAccept={handleAccept}
+{{! pick new delimiteres for mustache }}
+{{=<% %>=}}
+      InputProps={{ ...testProp }}
+<%={{ }}=%>     {{! revert delimiteres for mustache }}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: undefined,
+  validatemessage: "",
+  helperText: "",
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: null,
+  displayMode: null,
+  variant: "inline"
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  value: PropTypes.string,
+  label: PropTypes.string.isRequired,
+  hideLabel: PropTypes.bool,
+  getPConnect: PropTypes.func.isRequired,
+  validatemessage: PropTypes.string,
+  helperText: PropTypes.string,
+  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  testId: PropTypes.string,
+  displayMode: PropTypes.string,
+  variant: PropTypes.string
+};

package/src/tasks/create/templates/SDK-React/Field/Date/styles.js.mustache

@@ -0,0 +1,7 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/src/tasks/create/templates/SDK-React/Field/DateTime/config.json.mustache

@@ -0,0 +1,190 @@
+{
+  "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-date-time-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "format": "SELECT",
+      "name": "clockFormat",
+      "label": "Clock",
+      "defaultValue": "use locale",
+      "source": [
+        {
+          "key": 0,
+          "value": "use locale"
+        },
+        {
+          "key": 12,
+          "value": "12 hours"
+        },
+        {
+          "key": 24,
+          "value": "24 hours"
+        }
+      ]
+    },
+    {
+      "name": "withSeconds",
+      "label": "Display Seconds",
+      "format": "BOOLEAN"
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "format": "LABEL",
+          "label": "Year range",
+          "variant": "secondary"
+        },
+        {
+          "format": "INLINE",
+          "elements": [
+            {
+              "key": "next",
+              "format": "LABEL",
+              "label": "Next",
+              "variant": "secondary"
+            },
+            {
+              "key": "nextYears",
+              "format": "NUMBER",
+              "label": "",
+              "name": "nextYearRange",
+              "min": 0
+            },
+            {
+              "key": "year",
+              "format": "LABEL",
+              "label": "years",
+              "variant": "secondary"
+            }
+          ]
+        },
+        {
+          "format": "INLINE",
+          "elements": [
+            {
+              "key": "previous",
+              "format": "LABEL",
+              "label": "Previous",
+              "variant": "secondary"
+            },
+            {
+              "key": "previousYears",
+              "format": "NUMBER",
+              "label": "",
+              "name": "previousYearRange",
+              "min": 0
+            },
+            {
+              "key": "year",
+              "format": "LABEL",
+              "label": "years",
+              "variant": "secondary"
+            }
+          ]
+        },
+        {
+          "name": "showWeekNumber",
+          "label": "Display week numbers on calendar",
+          "format": "BOOLEAN"
+        },
+        {
+          "format": "SELECT",
+          "name": "pickerInterval",
+          "label": "Time picker",
+          "defaultValue": "30",
+          "source": [
+            {
+              "key": "5",
+              "value": "5 min"
+            },
+            {
+              "key": "10",
+              "value": "10 min"
+            },
+            {
+              "key": "15",
+              "value": "15 min"
+            },
+            {
+              "key": "20",
+              "value": "20 min"
+            },
+            {
+              "key": "30",
+              "value": "30 min"
+            },
+            {
+              "key": "60",
+              "value": "1 hr"
+            }
+          ]
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "showAsFormattedText",
+          "label": "Show as formatted text",
+          "format": "BOOLEAN"
+        }
+      ]
+    },
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "required",
+          "label": "Required",
+          "format": "REQUIRED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "disabled",
+          "label": "Disabled",
+          "format": "DISABLED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/src/tasks/create/templates/SDK-React/Field/DateTime/demo.stories.jsx.mustache

@@ -0,0 +1,44 @@
+import { useState } from 'react';
+import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+
+import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  decorators: [withKnobs],
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
+  const [value, setValue] = useState('test value');
+
+  const props = {
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, theValue) => {
+              setValue(theValue);
+            }
+          };
+        },
+        getStateProps: () => {
+          return { value: '.name' };
+        }
+      };
+    },
+    value,
+    placeholder: text('Placeholder', 'Test placeholder'),
+    disabled: boolean('Disabled', false),
+    readOnly: boolean('Disabled', false),
+    required: boolean('Disabled', false),
+    label: text('Label', 'Sample Label'),
+    testId: text('Test id', 'text-12344566')
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};