@pega/custom-dx-components 0.0.1 → 0.23.1

package/src/tasks/create/templates/Constellation/Field/Decimal-Percentage/index.jsx.mustache

@@ -0,0 +1,281 @@
+import { useState, useEffect, useRef } from 'react';
+import {
+  NumberInput,
+  NumberDisplay,
+  CurrencyDisplay,
+  FieldValueList,
+  Text
+} from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+// includes in bundle
+import handleEvent from './event-utils';
+import { suggestionsHandler } from './suggestions-handler';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// Duplicated runtime code from Constellation Design System Component
+
+// 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
+const {{COMPONENT_CLASS_NAME}} = props => {
+  const {
+    getPConnect,
+    value,
+    placeholder,
+    validatemessage,
+    label,
+    hideLabel,
+    helperText,
+    testId,
+    decimalPrecision,
+    additionalProps,
+    displayMode,
+    variant,
+    formatter,
+    isTableFormatter,
+    hasSuggestions
+  } = props;
+  let { showGroupSeparators } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+  const [percentageValue, setPercentageValue] = useState(value?.toString());
+  const hasValueChange = useRef(false);
+
+  let { readOnly, required, disabled } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions]);
+
+  let numberOfDecimals = parseInt(decimalPrecision, 10);
+  if (Number.isNaN(numberOfDecimals)) {
+    numberOfDecimals = decimalPrecision === '' ? undefined : 2;
+  }
+
+  useEffect(() => {
+    setPercentageValue(value?.toString());
+  }, [value]);
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
+    let unit = 'percent';
+    let displayComp = null;
+
+    if (isTableFormatter) {
+      switch (formatter) {
+        case 'Integer': {
+          numberOfDecimals = 0;
+          showGroupSeparators = true;
+          unit = '';
+          break;
+        }
+        case 'Decimal': {
+          showGroupSeparators = true;
+          unit = '';
+          break;
+        }
+        case 'Decimal-Auto': {
+          numberOfDecimals = Number.isInteger(percentageValue) ? 0 : 2;
+          showGroupSeparators = true;
+          unit = '';
+          break;
+        }
+        default: {
+          showGroupSeparators = false;
+          break;
+        }
+      }
+    }
+
+    {{! pick new delimiteres for mustache }}
+    {{=<% %>=}}
+
+    displayComp = (
+      <NumberDisplay
+        value={percentageValue}
+        formattingOptions={{
+          fractionDigits: numberOfDecimals,
+          groupSeparators: showGroupSeparators
+        }}
+        unit={unit}
+      />
+    );
+    if (isTableFormatter && (formatter === 'Currency' || formatter === 'Currency-Code')) {
+      const { currencyISOCode } = props;
+      let showIsoCode = true;
+      if (formatter === 'Currency') {
+        showIsoCode = false;
+      }
+      displayComp = (
+        <CurrencyDisplay
+          value={percentageValue}
+          currencyISOCode={currencyISOCode}
+          formattingOptions={{
+            groupSeparators: showGroupSeparators,
+            currency: showIsoCode ? 'code' : 'symbol'
+          }}
+        />
+      );
+    }
+
+    <%={{ }}=%>     {{! revert delimiteres for mustache }}
+
+    return displayMode === 'DISPLAY_ONLY' ? (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      displayComp
+      </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    ) : (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      <FieldValueList
+        variant={hideLabel ? 'stacked' : variant}
+        data-testid={testId}
+        fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+      />
+      </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    );
+  }
+
+  {{! pick new delimiteres for mustache }}
+  {{=<% %>=}}
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    const displayComp = (
+      <NumberDisplay
+        value={percentageValue}
+        formattingOptions={{
+          fractionDigits: numberOfDecimals,
+          groupSeparators: showGroupSeparators
+        }}
+        unit='percent'
+      />
+    );
+
+  <%={{ }}=%>     {{! revert delimiteres for mustache }}
+
+    return (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      <FieldValueList
+        variant='stacked'
+        data-testid={testId}
+        fields={[
+          {
+            id: '2',
+            name: hideLabel ? '' : label,
+            value: (
+              <Text variant='h1' as='span'>
+                {displayComp}
+              </Text>
+            )
+          }
+        ]}
+      />
+      </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <NumberInput
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      value={percentageValue}
+      status={status}
+      placeholder={placeholder}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      numberOfDecimals={numberOfDecimals}
+      showGroupSeparators={showGroupSeparators}
+      unit='percent'
+      data-testid={testId}
+      onChange={(enteredValue) => {
+        if (hasSuggestions) {
+          setStatus(undefined);
+        }
+        setPercentageValue(enteredValue);
+        if (value !== enteredValue) {
+          handleEvent(actions, 'change', propName, enteredValue);
+          hasValueChange.current = true;
+        }
+      }}
+      onBlur={() => {
+        const parsedValue = percentageValue !== '' ? Number(percentageValue) : '';
+        if (!value || hasValueChange.current) {
+          handleEvent(actions, 'blur', propName, parsedValue);
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion();
+          }
+          hasValueChange.current = false;
+        }
+      }}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: '',
+  placeholder: '',
+  validatemessage: '',
+  helperText: '',
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: null,
+  decimalPrecision: '',
+  showGroupSeparators: false,
+  additionalProps: {},
+  displayMode: null,
+  variant: 'inline',
+  currencyISOCode: 'USD',
+  formatter: '',
+  isTableFormatter: false,
+  hasSuggestions: false
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  value: PropTypes.string,
+  placeholder: 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,
+  decimalPrecision: PropTypes.string,
+  showGroupSeparators: PropTypes.bool,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  displayMode: PropTypes.string,
+  variant: PropTypes.string,
+  formatter: PropTypes.string,
+  currencyISOCode: PropTypes.string,
+  isTableFormatter: PropTypes.bool,
+  hasSuggestions: PropTypes.bool
+};
+
+export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/Decimal-Percentage/mock.stories.js.mustache

@@ -0,0 +1,21 @@
+export const configProps = {
+  value: '',
+  label: 'Percentage Sample',
+  showGroupSeparators: true,
+  placeholder: 'Percentage Placeholder',
+  helperText: 'Percentage Helper Text',
+  testId: 'percentage-12345678',
+  hasSuggestions: false
+};
+
+export const stateProps = {
+  value: '.PercentageSample',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Decimal',
+  displayAs: 'pxPercentage',
+  label: 'Percentage sample'
+};

package/src/tasks/create/templates/Constellation/Field/Decimal-Percentage/styles.js.mustache

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

package/src/tasks/create/templates/Constellation/Field/Decimal-Percentage/suggestions-handler.js

@@ -0,0 +1,10 @@
+/* eslint-disable import/prefer-default-export */
+export const suggestionsHandler = (accepted, pConn, setStatus) => {
+  if (accepted) {
+    pConn.acceptSuggestion();
+    setStatus('success');
+  } else {
+    pConn.ignoreSuggestion();
+    setStatus(undefined);
+  }
+};

package/src/tasks/create/templates/Constellation/Field/Integer/config.json.mustache

@@ -0,0 +1,347 @@
+{
+  "name": "{{COMPONENT_KEY}}",
+  "label": "{{COMPONENT_LABEL}}",
+  "description": "{{DESCRIPTION}}",
+  "organization": "{{ORGANIZATION}}",
+  "version": "{{VERSION}}",
+  "library": "{{LIBRARY}}",
+  "allowedApplications": {{{ALLOWEDAPPS}}},
+  "componentKey": "{{COMPONENT_KEY}}",
+  "type": "{{TYPE}}",
+  "subtype": {{{SUB_TYPE}}},
+  {{#IS_TEMPLATE}}
+  "icon": "images/pz-integer-active.svg",
+  {{/IS_TEMPLATE}}
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "name": "showGroupSeparators",
+      "label": "Show thousands separator",
+      "format": "BOOLEAN",
+      "visibility": "(!displayAs = slider)"
+    },
+    {
+      "label": "Column settings",
+      "format": "GROUP",
+      "visibility": "@VIEWTYPE == 'MultiRecordDisplayAsTable'",
+      "properties": [
+        {
+          "name": "columnWidth",
+          "label": "Column width",
+          "format": "SELECT",
+          "source": [
+            {
+              "key": "auto",
+              "value": "Auto"
+            },
+            {
+              "key": "custom",
+              "value": "Custom"
+            }
+          ]
+        },
+        {
+          "name": "width",
+          "label": "Width (px)",
+          "format": "NUMBER",
+          "visibility": "$this.columnWidth == 'custom'"
+        }
+      ]
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "name": "displayAs",
+          "label": "Display as",
+          "format": "SELECT",
+          "defaultValue": "input",
+          "source": [
+            {
+              "key": "input",
+              "value": "Input"
+            },
+            {
+              "key": "stepper",
+              "value": "Stepper"
+            },
+            {
+              "key": "slider",
+              "value": "Slider"
+            }
+          ]
+        },
+        {
+          "name": "min",
+          "label": "Min value",
+          "format": "NUMBER",
+          "defaultValue": "0",
+          "required": true,
+          "visibility": "(displayAs = slider)"
+        },
+        {
+          "name": "max",
+          "label": "Max value",
+          "format": "NUMBER",
+          "defaultValue": "100",
+          "required": true,
+          "visibility": "(displayAs = slider)"
+        },
+        {
+          "name": "defaultValue",
+          "label": "Default value",
+          "format": "NUMBER",
+          "visibility": "(displayAs = slider)"
+        },
+        {
+          "name": "step",
+          "label": "Increment",
+          "format": "NUMBER",
+          "defaultValue": "1",
+          "min": 1,
+          "visibility": "(displayAs = slider)"
+        },
+        {
+          "name": "placeholder",
+          "label": "Placeholder",
+          "format": "TEXT",
+          "visibility": "(!displayAs = slider && !displayAs = stepper)"
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        },
+        {
+          "name": "showInput",
+          "label": "Show numeric input",
+          "format": "BOOLEAN",
+          "defaultValue": true,
+          "visibility": "(displayAs = slider)"
+        },
+        {
+          "name": "showTicks",
+          "label": "Show ticks",
+          "format": "BOOLEAN",
+          "defaultValue": true,
+          "visibility": "(displayAs = slider)"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "formatter",
+          "label": "Format",
+          "defaultValue": "defaultInteger",
+          "source": [
+            {
+              "key": "defaultInteger",
+              "value": "Default"
+            },
+            {
+              "key": "Decimal",
+              "value": "Decimal"
+            },
+            {
+              "key": "Currency",
+              "value": "Currency"
+            },
+            {
+              "key": "Percentage",
+              "value": "Percentage"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "format": "CASCADE",
+      "visibility": "(formatter = Currency)",
+      "source": {
+        "format": "SELECT",
+        "label": "ISO Code Selection",
+        "name": "isoCodeSelection",
+        "defaultValue": "constant",
+        "source": [
+          {
+            "key": "constant",
+            "value": "Constant"
+          },
+          {
+            "key": "propertyRef",
+            "value": "Property Reference"
+          }
+        ]
+      },
+      "cascadeElements": [
+        {
+          "key": "currencyISOCode",
+          "format": "TEXT",
+          "name": "currencyISOCode",
+          "label": "Currency ISO Code",
+          "defaultValue": "USD",
+          "match": "constant"
+        },
+        {
+          "key": "currencyISOCode",
+          "format": "PROPERTY",
+          "name": "currencyISOCode",
+          "label": "Currency ISO Code",
+          "match": "propertyRef"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDisplay",
+      "label": "Currency display",
+      "visibility": "(formatter = Currency)",
+      "defaultValue": "symbol",
+      "source": [
+        {
+          "key": "symbol",
+          "value": "Auto"
+        },
+        {
+          "key": "code",
+          "value": "Code"
+        },
+        {
+          "key": "name",
+          "value": "Name"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "negative",
+      "label": "Negative number display",
+      "visibility": "(formatter = Currency)",
+      "defaultValue": "minus-sign",
+      "source": [
+        {
+          "key": "minus-sign",
+          "value": "Standard"
+        },
+        {
+          "key": "parentheses",
+          "value": "Accounting"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "notation",
+      "label": "Notation",
+      "visibility": "(!negative = parentheses)&&(!formatter = Percentage)",
+      "defaultValue": "standard",
+      "source": [
+        {
+          "key": "standard",
+          "value": "Standard"
+        },
+        {
+          "key": "compact",
+          "value": "Compact"
+        }
+      ]
+    },
+    {
+      "name": "decimalPrecision",
+      "label": "Decimal places",
+      "format": "NUMBER",
+      "visibility": "(formatter = Decimal)||(formatter = Percentage)",
+      "min": 0,
+      "max": 20
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDecimalPrecision",
+      "label": "Decimal places shown",
+      "visibility": "(formatter = Currency)",
+      "defaultValue": "auto",
+      "source": [
+        {
+          "key": "auto",
+          "value": "Auto"
+        },
+        {
+          "key": "0",
+          "value": "None"
+        },
+        {
+          "key": "1",
+          "value": "1"
+        },
+        {
+          "key": "2",
+          "value": "2"
+        },
+        {
+          "key": "3",
+          "value": "3"
+        },
+        {
+          "key": "4",
+          "value": "4"
+        }
+      ]
+    },
+    {
+      "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"
+        }
+      ]
+    },
+    {
+      "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"
+  }
+}