@egovernments/digit-ui-module-dss

digit-ui-module-dss

Install

npm install --save @egovernments/digit-ui-module-dss

Limitation

This Package is more specific to DIGIT-UI's can be used across mission's

Usage

After adding the dependency make sure you have this dependency in

frontend/micro-ui/web/package.json

"@egovernments/digit-ui-module-dss":"^1.5.0",

then navigate to App.js

 frontend/micro-ui/web/src/App.js

/** add this import **/

import { initDSSComponents } from "@egovernments/digit-ui-module-dss";

/** inside enabledModules add this new module key **/

const enabledModules = ["DSS"];

/** inside init Function call this function **/

const initDigitUI = () => {
  initDSSComponents();
};

Dynamic filter Usage

DSS UI

Digit-UI has a DSS module that displays multiple types of charts, and tables based on the configuration. In DSS there are some filters that are fixed for all the pages, they should be based on the configuration.

Example config

MasterDashboardConfig.json

{
  "name": "DSS_REPORT",
  "filter": "FilterComponent",
  "filterConfig": [
    {
      "id": "DATE_RANGE",
      "name": "ES_DSS_DATE_RANGE",
      "type": "DateRange",
      "props": {
        "maxNumberOfDays": 90
      }
    },
    {
      "id": "LOCALITY",
      "name": "ES_DSS_LOCALITY",
      "type": "Dropdown",
      "source": {
        "type": "request",
        "hostUrl": "https://works-dev.digit.org",
        "requestMethod": "POST",
        "requestUrl": "/egov-location/location/v11/boundarys/_search?hierarchyTypeCode=ADMIN&boundaryType=Locality&tenantId={$.tenantId}",
        "requestBody": "{\"criteria\":{\"tenantId\" : \"{$.tenantId}\" }}",
        "keyPath": "$.TenantBoundary[0].boundary.*.name",
        "valuesPath": "$.TenantBoundary[0].boundary.*.code"
      },
      "appliedFilterPath": "filters.locality",
      "placeholder": "ES_DSS_ALL_LOCALITY_SELECTED"
    },
{
      "id": "DISTRICT",
      "name": "ES_DSS_DDR",
      "type": "MultiSelectDropdown",
      "source": {
        "type": "request",
        "hostUrl": "https://works-dev.digit.org",
        "requestMethod": "POST",
        "requestUrl": "/egov-location/location/v11/boundarys/_search?hierarchyTypeCode=ADMIN&boundaryType=Locality&tenantId={$.tenantId}",
        "requestBody": "{\"criteria\":{\"tenantId\" : \"{$.tenantId}\" }}",
        "keyPath": "$.TenantBoundary[0].boundary.*.name",
        "valuesPath": "$.TenantBoundary[0].boundary.*.code"
      },
      "appliedFilterPath": "filters.locality",
      "placeholder": "ES_DSS_ALL_LOCALITY_SELECTED"
    },
    
    {
      "id": "PAYMENT_MODE",
      "name": "ES_DSS_PAYMENT_MODE",
      "type": "MultiSelectDropdown",
      "source": {
        "type": "list",
        "list": [
          {
            "key": "CASH",
            "value": "CASH"
          },
          {
            "key": "CARD",
            "value": "CARD"
          }
          {
            "key": "CHEQUE",
            "value": "CHEQUE"
          }
        ],
        "keyPath": "$.*.key",
        "valuesPath": "$.*.value",
        "sortBy": "name"
      },
      "appliedFilterPath": "filters.paymentMode",
      "placeholder": "ES_DSS_ALL_PAYMENT_SELECTED"
    }
  ],
  "visualizations": []
}

// add the following hooks to have a dynamic filter under dss ``Digit.Hooks.dss.useGetCustomFilterValues``
const useGetCustomFilterValues = (filterConfigs, config={}) => {
  return useQuery(`DSS_CUSTOM_FILTER_CONFIG_${JSON.stringify(filterConfigs)}`, () => DSSService.getFiltersConfigData(filterConfigs), config);
};


const useGetCustomFilterRequestValues = (filterConfigs, config={}) => {
  return useQuery(`DSS_CUSTOM_FILTER_REQUEST_VAL_${JSON.stringify(filterConfigs)}`, () => DSSService.getCustomFiltersDynamicValues(filterConfigs), config);
};

Changelog

1.8.0 workbench v1.0 release
1.8.0-beta workbench base version beta release
1.7.0 urban 2.9
1.6.0 urban 2.8
1.5.48 DSS fix for MUKTA fontsize of the line chart and making multilink dropdown clone on outside click
1.5.44 UI/UX Audit Fixes :: Refer PFM-4442(https://digit-discuss.atlassian.net/browse/PFM-4442)
1.5.43 Alignment fixes
1.5.39 Bug fixes = tooltip text not showing fully + Share whatsapp and email was not working
1.5.38 updated the readme content
1.5.37 Pie chart denomination and Horizontal bar white spaces fixes
1.5.36 Bug Fix::Multiple tooltips showing in Tables
1.5.35 Added the dynamic filter component 
1.5.34 Count config added for Metric chart
1.5.33 Horizontal Bar and Pie chart alignment fixes
1.5.32 Percentage symbol showing in Yaxis ticker and left alignment of label for FSM Capacity Utilization 
1.5.31 Horizontal Bar chart alignment fixes
1.5.30 Added enhancement for pie chart using variant flag according to new requirements. Refer CustomPieChart component.
1.5.29 DSS UI alignment fixes for Horizontal Metric and bar chart
1.5.28 added the support for the dynamic icon in the metric chart by adding flag iconName
1.5.27 Alignment fixes for Horizontal Metric Charts
1.5.26 Added a new version of horizontalBar chart, In chartConfig it makes use of this boolean key = horizontalBarv2
1.5.25 added the support for horizontal metric chart, In chartConfig it makes use of this boolean key = isHorizontalChart
1.5.24 added commonmaster module to support its localisation
1.5.23 updated the routes in the dss module to have dynamic base context path
1.5.22 updated the readme file
1.5.21 added the readme file
1.5.20 base version

Contributors

[jagankumar-egov] [nipunarora-eGov] [Tulika-eGov] [Ramkrishna-egov] [nabeelmd-eGov]

Documentation

Documentation Site (https://core.digit.org/guides/developer-guide/ui-developer-guide/digit-ui)

Maintainer

• jagankumar-egov

Published from DIGIT Frontend

DIGIT Frontend Repo (https://github.com/egovernments/Digit-Frontend/tree/master)