@bento-core/query-bar 1.0.0-c3dc.1 → 1.0.0-c3dc.3

package/CopyURL_README.md

@@ -0,0 +1,42 @@
+# DQB copy URL button Configuration
+
+```
+DashTemplateController.js
+
+export const setActiveFilterByPathQuery = (match) => {
+  const query = decodeURI(match.params.filterQuery || '');
+  const filterObject = JSON.parse(query);
+  const { autocomplete = [], upload = [], uploadMetadata } = filterObject;
+
+  const activeFilterValues = Object.keys(filterObject).reduce((curr, key) => {
+    if (Array.isArray(filterObject[key])) {
+      const activeFilters = filterObject[key].reduce((value, item) => ({
+        ...value,
+        [item]: true,
+      }), {});
+      return {
+        ...curr,
+        [key]: activeFilters,
+      };
+    }
+    return curr;
+  }, {});
+  store.dispatch(clearAllAndSelectFacet(activeFilterValues));
+  store.dispatch(updateAutocompleteData(autocomplete));
+  store.dispatch(updateUploadData(upload));
+  store.dispatch(updateUploadMetadata(uploadMetadata));
+};
+
+
+// redirect 
+if (match.params.filterQuery) {
+  setActiveFilterByPathQuery(match);
+  const redirectUrl = '/explore';
+  history.push(redirectUrl);
+}
+
+```
+
+# DQB copy URL button theme style
+
+``` https://github.com/CBIIT/bento-icdc-frontend/tree/v4.0.1/src/pages/dashboard/filterQueryBar```

package/README.md

@@ -60,6 +60,17 @@ const CONFIG = {
     maxItems: 2,
   },
 
+  /**
+   * set root path for copy url (COPYURL_README)
+   * @var {boolean}
+   */
+  rootPath: `${window.location.href}/`,
+  /**
+   * display copy url button (COPYURL_README)
+   * @var {boolean}
+   */
+  viewQueryURL: true,
+
   /* Component Helper Functions */
   functions: {
     /**

package/dist/assets/CopyIcon.svg

@@ -0,0 +1,3 @@
+<svg width="16" height="19" viewBox="0 0 16 19" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M13 9.75715C13 10.0452 12.78 10.2714 12.5 10.2714H7.5C7.22 10.2714 7 10.0452 7 9.75715C7 9.46915 7.22 9.24287 7.5 9.24287H12.5C12.78 9.24287 13 9.46915 13 9.75715ZM12.5 11.3H7.5C7.22 11.3 7 11.5263 7 11.8143C7 12.1023 7.22 12.3286 7.5 12.3286H12.5C12.78 12.3286 13 12.1023 13 11.8143C13 11.5263 12.78 11.3 12.5 11.3ZM12.5 13.3572H7.5C7.22 13.3572 7 13.5834 7 13.8714C7 14.1594 7.22 14.3857 7.5 14.3857H12.5C12.78 14.3857 13 14.1594 13 13.8714C13 13.5834 12.78 13.3572 12.5 13.3572ZM16 8.21429V16.4429C16 17.5743 15.1 18.5 14 18.5H6C4.9 18.5 4 17.5743 4 16.4429V15.4143H2C0.9 15.4143 0 14.4886 0 13.3572V4.10001C0 2.96858 0.9 2.04286 2 2.04286H4.5C4.5 1.18915 5.17 0.500008 6 0.500008C6.83 0.500008 7.5 1.18915 7.5 2.04286H10C11.1 2.04286 12 2.96858 12 4.10001V6.15715H14C15.1 6.15715 16 7.08287 16 8.21429ZM6 6.15715H11V4.10001C11 3.53429 10.55 3.07144 10 3.07144H9V4.10001H3V3.07144H2C1.45 3.07144 1 3.53429 1 4.10001V13.3572C1 13.9229 1.45 14.3857 2 14.3857H4V8.21429C4 7.08287 4.9 6.15715 6 6.15715ZM15 8.21429C15 7.64858 14.55 7.18572 14 7.18572H6C5.45 7.18572 5 7.64858 5 8.21429V16.4429C5 17.0086 5.45 17.4714 6 17.4714H14C14.55 17.4714 15 17.0086 15 16.4429V8.21429Z" fill="#142D64"/>
+</svg>

package/dist/components/QueryUrl.js

@@ -0,0 +1,143 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _clsx = _interopRequireDefault(require("clsx"));
+var _core = require("@material-ui/core");
+var _CopyIcon = _interopRequireDefault(require("../assets/CopyIcon.svg"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+const QueryUrl = _ref => {
+  let {
+    classes,
+    filterItems,
+    localFind = {},
+    rootPath
+  } = _ref;
+  const [display, setDisplay] = (0, _react.useState)(false);
+  const toggleDisplay = () => setDisplay(prevDisplay => !prevDisplay);
+  const [open, setOpen] = (0, _react.useState)(false);
+  const toggleOpen = () => setOpen(prevOpen => !prevOpen);
+  const pathFilterParams = filterItems.reduce((acc, item) => {
+    const {
+      datafield,
+      items = []
+    } = item;
+    acc[datafield] = items;
+    return acc;
+  }, {});
+  const query = JSON.stringify(_objectSpread(_objectSpread({}, pathFilterParams), localFind));
+  const url = rootPath.concat(encodeURIComponent(query));
+  const copyUrl = async () => {
+    toggleOpen();
+    await navigator.clipboard.writeText(url);
+  };
+  const queryRef = (0, _react.useRef)(null);
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("div", {
+    ref: queryRef,
+    className: classes.urlContainer
+  }, /*#__PURE__*/_react.default.createElement(_core.Button, {
+    onClick: toggleDisplay,
+    className: classes.viewLinkToggleBtn
+  }, display ? 'Hide Query URL' : 'Show Query URL'), display && /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("div", {
+    type: "button",
+    className: (0, _clsx.default)(classes.viewLink)
+  }, url), /*#__PURE__*/_react.default.createElement(_core.Tooltip, {
+    arrow: true,
+    title: "Copy to Clipboard"
+  }, /*#__PURE__*/_react.default.createElement(_core.IconButton, {
+    onClick: copyUrl,
+    className: classes.copyIconBtn
+  }, /*#__PURE__*/_react.default.createElement("img", {
+    src: _CopyIcon.default,
+    alt: "copy icon"
+  }))))), /*#__PURE__*/_react.default.createElement(_core.Dialog, {
+    open: open,
+    onClose: () => toggleOpen(),
+    "aria-labelledby": "alert-dialog-title",
+    "aria-describedby": "alert-dialog-description",
+    className: (0, _clsx.default)(classes.dialogBox, 'dialogBox')
+  }, /*#__PURE__*/_react.default.createElement(_core.DialogContent, {
+    className: classes.okText
+  }, /*#__PURE__*/_react.default.createElement(_core.DialogContentText, {
+    id: "alert-dialog-description"
+  }, "Your query URL has been copied!")), /*#__PURE__*/_react.default.createElement(_core.DialogActions, null, /*#__PURE__*/_react.default.createElement(_core.Button, {
+    onClick: () => toggleOpen()
+  }, "OK"))));
+};
+const styles = () => ({
+  urlContainer: {
+    display: 'flex',
+    marginTop: '3px',
+    minHeight: '10px'
+  },
+  viewLink: {
+    overflow: 'hidden',
+    textOverflow: 'ellipsis',
+    fontFamily: 'Nunito',
+    fontSize: '12px',
+    fontWeight: '500',
+    lineHeight: '16px',
+    letterSpacing: '0em',
+    padding: '2px 5px',
+    borderRadius: '5px',
+    float: 'left',
+    color: '#1D79A8',
+    backgroundColor: '#fff',
+    margin: '0',
+    whiteSpace: 'nowrap',
+    wordBreak: 'break-all',
+    '@media (max-width: 2560px)': {
+      maxWidth: '1800px'
+    },
+    '@media (max-width: 2000px)': {
+      maxWidth: '1500px'
+    },
+    '@media (max-width: 1600px)': {
+      maxWidth: '1100px'
+    },
+    '@media (max-width: 1300px)': {
+      maxWidth: '900px'
+    }
+  },
+  urlViewBtn: {
+    cursor: 'pointer'
+  },
+  viewLinkToggleBtn: {
+    padding: '5px 10px 5px 10px',
+    height: '20px',
+    fontFamily: 'Nunito',
+    fontSize: '12px',
+    fontWeight: '500',
+    lineHeight: '16px',
+    letterSpacing: '0em',
+    textAlign: 'left',
+    backgroundColor: '#1D79A8',
+    textTransform: 'none',
+    color: '#fff',
+    float: 'left',
+    margin: '0px 10px 0px 0px',
+    whiteSpace: 'nowrap',
+    '&:hover': {
+      backgroundColor: '#1D79A8',
+      color: '#fff'
+    }
+  },
+  copyIconBtn: {
+    padding: '0px',
+    height: '20px',
+    marginLeft: '10px',
+    float: 'left'
+  }
+});
+var _default = (0, _core.withStyles)(styles)(QueryUrl);
+exports.default = _default;

package/dist/generators/QueryBarGenerator.js

@@ -9,6 +9,7 @@ var _core = require("@material-ui/core");
 var _facetFilter = require("@bento-core/facet-filter");
 var _clsx = _interopRequireDefault(require("clsx"));
 var _FilterMap = require("../components/FilterMap");
+var _QueryUrl = _interopRequireDefault(require("../components/QueryUrl"));
 var _styles = _interopRequireDefault(require("./styles"));
 var _config = _interopRequireDefault(require("./config"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -34,6 +35,8 @@ const QueryBarGenerator = function QueryBarGenerator() {
     CHECKBOX
   } = _facetFilter.InputTypes;
   const maxItems = config && typeof config.maxItems === 'number' ? config.maxItems : _config.default.config.maxItems;
+  const queryURLRootPath = config && typeof config.rootPath === 'string' ? config.rootPath : _config.default.config.rootPath;
+  const viewQueryURL = config && typeof config.viewQueryURL === 'boolean' ? config.viewQueryURL : _config.default.config.viewQueryURL;
   const clearAll = functions && typeof functions.clearAll === 'function' ? functions.clearAll : _config.default.functions.clearAll;
   const clearUpload = functions && typeof functions.clearUpload === 'function' ? functions.clearUpload : _config.default.functions.clearUpload;
   const clearAutocomplete = functions && typeof functions.clearAutocomplete === 'function' ? functions.clearAutocomplete : _config.default.functions.clearAutocomplete;
@@ -121,7 +124,12 @@ const QueryBarGenerator = function QueryBarGenerator() {
         classes: classes,
         onSectionClick: filter.type === CHECKBOX ? resetFacetSection : resetFacetSlider,
         onItemClick: filter.type === CHECKBOX ? resetFacetCheckbox : resetFacetSlider
-      }))));
+      }))), viewQueryURL && queryURLRootPath && /*#__PURE__*/_react.default.createElement(_QueryUrl.default, {
+        classes: classes,
+        localFind: localFind,
+        filterItems: mappedInputs,
+        rootPath: queryURLRootPath
+      }));
     })
   };
 };

package/dist/generators/config.js

@@ -14,6 +14,16 @@ var _default = {
      */
     maxItems: 2
   },
+  /**
+   * set root path for copy url
+   * @var {boolean}
+   */
+  rootPath: "".concat(window.location.href, "/"),
+  /**
+   * display copy url button
+   * @var {boolean}
+   */
+  viewQueryURL: false,
   /* Component Helper Functions */
   functions: {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bento-core/query-bar",
-  "version": "1.0.0-c3dc.1",
+  "version": "1.0.0-c3dc.3",
   "description": "This package provides the Query Bar component that displays the current Facet Search and Local Find filters on the Dashboard/Explore page. It also provides the direct ability to reset all or some of the filters with the click of a button. It is designed to be implemented directly with the:",
   "main": "dist/index.js",
   "scripts": {

package/src/assets/CopyIcon.svg

@@ -0,0 +1,3 @@
+<svg width="16" height="19" viewBox="0 0 16 19" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M13 9.75715C13 10.0452 12.78 10.2714 12.5 10.2714H7.5C7.22 10.2714 7 10.0452 7 9.75715C7 9.46915 7.22 9.24287 7.5 9.24287H12.5C12.78 9.24287 13 9.46915 13 9.75715ZM12.5 11.3H7.5C7.22 11.3 7 11.5263 7 11.8143C7 12.1023 7.22 12.3286 7.5 12.3286H12.5C12.78 12.3286 13 12.1023 13 11.8143C13 11.5263 12.78 11.3 12.5 11.3ZM12.5 13.3572H7.5C7.22 13.3572 7 13.5834 7 13.8714C7 14.1594 7.22 14.3857 7.5 14.3857H12.5C12.78 14.3857 13 14.1594 13 13.8714C13 13.5834 12.78 13.3572 12.5 13.3572ZM16 8.21429V16.4429C16 17.5743 15.1 18.5 14 18.5H6C4.9 18.5 4 17.5743 4 16.4429V15.4143H2C0.9 15.4143 0 14.4886 0 13.3572V4.10001C0 2.96858 0.9 2.04286 2 2.04286H4.5C4.5 1.18915 5.17 0.500008 6 0.500008C6.83 0.500008 7.5 1.18915 7.5 2.04286H10C11.1 2.04286 12 2.96858 12 4.10001V6.15715H14C15.1 6.15715 16 7.08287 16 8.21429ZM6 6.15715H11V4.10001C11 3.53429 10.55 3.07144 10 3.07144H9V4.10001H3V3.07144H2C1.45 3.07144 1 3.53429 1 4.10001V13.3572C1 13.9229 1.45 14.3857 2 14.3857H4V8.21429C4 7.08287 4.9 6.15715 6 6.15715ZM15 8.21429C15 7.64858 14.55 7.18572 14 7.18572H6C5.45 7.18572 5 7.64858 5 8.21429V16.4429C5 17.0086 5.45 17.4714 6 17.4714H14C14.55 17.4714 15 17.0086 15 16.4429V8.21429Z" fill="#142D64"/>
+</svg>

package/src/components/QueryUrl.js

@@ -0,0 +1,164 @@
+import React, { useState, useRef } from 'react';
+import clsx from 'clsx';
+import {
+  Button,
+  IconButton,
+  Tooltip,
+  Dialog,
+  DialogActions,
+  DialogContent,
+  DialogContentText,
+  withStyles,
+} from '@material-ui/core';
+import CopyIcon from '../assets/CopyIcon.svg';
+
+const QueryUrl = ({
+  classes,
+  filterItems,
+  localFind = {},
+  rootPath,
+}) => {
+  const [display, setDisplay] = useState(false);
+  const toggleDisplay = () => setDisplay((prevDisplay) => !prevDisplay);
+
+  const [open, setOpen] = useState(false);
+  const toggleOpen = () => setOpen((prevOpen) => !prevOpen);
+
+  const pathFilterParams = filterItems.reduce((acc, item) => {
+    const { datafield, items = [] } = item;
+    acc[datafield] = items;
+    return acc;
+  }, {});
+
+  const query = JSON.stringify({
+    ...pathFilterParams,
+    ...localFind,
+  });
+  const url = rootPath.concat(encodeURIComponent(query));
+
+  const copyUrl = async () => {
+    toggleOpen();
+    await navigator.clipboard.writeText(url);
+  };
+
+  const queryRef = useRef(null);
+
+  return (
+    <>
+      <div ref={queryRef} className={classes.urlContainer}>
+        <Button
+          onClick={toggleDisplay}
+          className={classes.viewLinkToggleBtn}
+        >
+          { (display) ? 'Hide Query URL' : 'Show Query URL'}
+        </Button>
+        {
+          (display) && (
+            <>
+              <div
+                type="button"
+                className={clsx(classes.viewLink)}
+              >
+                {url}
+              </div>
+              <Tooltip
+                arrow
+                title="Copy to Clipboard"
+              >
+                <IconButton onClick={copyUrl} className={classes.copyIconBtn}>
+                  <img src={CopyIcon} alt="copy icon" />
+                </IconButton>
+              </Tooltip>
+            </>
+          )
+        }
+      </div>
+      <Dialog
+        open={open}
+        onClose={() => toggleOpen()}
+        aria-labelledby="alert-dialog-title"
+        aria-describedby="alert-dialog-description"
+        className={clsx(classes.dialogBox, 'dialogBox')}
+      >
+        <DialogContent className={classes.okText}>
+          <DialogContentText id="alert-dialog-description">
+            Your query URL has been copied!
+          </DialogContentText>
+        </DialogContent>
+        <DialogActions>
+          <Button onClick={() => toggleOpen()}>
+            OK
+          </Button>
+        </DialogActions>
+      </Dialog>
+    </>
+  );
+};
+
+const styles = () => ({
+  urlContainer: {
+    display: 'flex',
+    marginTop: '3px',
+    minHeight: '10px',
+  },
+  viewLink: {
+    overflow: 'hidden',
+    textOverflow: 'ellipsis',
+    fontFamily: 'Nunito',
+    fontSize: '12px',
+    fontWeight: '500',
+    lineHeight: '16px',
+    letterSpacing: '0em',
+    padding: '2px 5px',
+    borderRadius: '5px',
+    float: 'left',
+    color: '#1D79A8',
+    backgroundColor: '#fff',
+    margin: '0',
+    whiteSpace: 'nowrap',
+    wordBreak: 'break-all',
+    '@media (max-width: 2560px)': {
+      maxWidth: '1800px',
+    },
+    '@media (max-width: 2000px)': {
+      maxWidth: '1500px',
+    },
+    '@media (max-width: 1600px)': {
+      maxWidth: '1100px',
+    },
+    '@media (max-width: 1300px)': {
+      maxWidth: '900px',
+    },
+  },
+  urlViewBtn: {
+    cursor: 'pointer',
+  },
+  viewLinkToggleBtn: {
+    padding: '5px 10px 5px 10px',
+    height: '20px',
+    fontFamily: 'Nunito',
+    fontSize: '12px',
+    fontWeight: '500',
+    lineHeight: '16px',
+    letterSpacing: '0em',
+    textAlign: 'left',
+    backgroundColor: '#1D79A8',
+    textTransform: 'none',
+    color: '#fff',
+    float: 'left',
+    margin: '0px 10px 0px 0px',
+    whiteSpace: 'nowrap',
+    '&:hover': {
+      backgroundColor: '#1D79A8',
+      color: '#fff',
+    },
+  },
+  copyIconBtn: {
+    padding: '0px',
+    height: '20px',
+    marginLeft: '10px',
+    float: 'left',
+  },
+});
+
+export default withStyles(styles)(QueryUrl);

package/src/generators/QueryBarGenerator.js

@@ -3,6 +3,7 @@ import { withStyles, Button } from '@material-ui/core';
 import { InputTypes } from '@bento-core/facet-filter';
 import clsx from 'clsx';
 import { Filter } from '../components/FilterMap';
+import QueryUrl from '../components/QueryUrl';
 import DEFAULT_STYLES from './styles';
 import DEFAULT_CONFIG from './config';
 
@@ -20,6 +21,14 @@ export const QueryBarGenerator = (uiConfig = DEFAULT_CONFIG) => {
     ? config.maxItems
     : DEFAULT_CONFIG.config.maxItems;
 
+  const queryURLRootPath = config && typeof config.rootPath === 'string'
+    ? config.rootPath
+    : DEFAULT_CONFIG.config.rootPath;
+
+  const viewQueryURL = config && typeof config.viewQueryURL === 'boolean'
+    ? config.viewQueryURL
+    : DEFAULT_CONFIG.config.viewQueryURL;
+
   const clearAll = functions && typeof functions.clearAll === 'function'
     ? functions.clearAll
     : DEFAULT_CONFIG.functions.clearAll;
@@ -179,6 +188,16 @@ export const QueryBarGenerator = (uiConfig = DEFAULT_CONFIG) => {
               />
             ))}
           </span>
+          {
+            (viewQueryURL && queryURLRootPath) && (
+              <QueryUrl
+                classes={classes}
+                localFind={localFind}
+                filterItems={mappedInputs}
+                rootPath={queryURLRootPath}
+              />
+            )
+          }
         </div>
       );
     }),

package/src/generators/config.js

@@ -9,6 +9,17 @@ export default {
     maxItems: 2,
   },
 
+  /**
+   * set root path for copy url
+   * @var {boolean}
+   */
+  rootPath: `${window.location.href}/`,
+  /**
+   * display copy url button
+   * @var {boolean}
+   */
+  viewQueryURL: false,
+
   /* Component Helper Functions */
   functions: {
     /**