@descope/web-components-ui 1.0.348 → 1.0.350

package/dist/cjs/index.cjs.js

@@ -63,6 +63,14 @@ const compareArraysUnordered = (arr1, arr2) => {
   return true;
 };
 
+const toTitle = (str) =>
+  str
+    .replace(/([A-Z])/g, ' $1')
+    .trim()
+    .split(' ')
+    .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+    .join(' ');
+
 const observeAttributes = (ele, callback, { excludeAttrs = [], includeAttrs = [] }) => {
   // sync all attrs on init
   const filteredAttrs = Array.from(ele.attributes)
@@ -9880,6 +9888,58 @@ const isValidDataType = (data) => {
   return isValid;
 };
 
+const isPlainObject = (value) => value?.constructor === Object;
+
+const getValueType = (value) => {
+  if (isPlainObject(value)) return 'object';
+  if (Array.isArray(value)) return 'array';
+
+  return 'text';
+};
+
+const renderCodeSnippet = (value) =>
+  `<descope-code-snippet lang="json" class="row-details__value json">${JSON.stringify(
+    value,
+    null,
+    2
+  )}</descope-code-snippet>`;
+
+const renderText = (text) =>
+  `<div class="row-details__value text" title="${text}">${text}</div>`;
+
+const defaultRowDetailsValueRenderer = (value) => {
+  const valueType = getValueType(value);
+
+  if (valueType === 'object') {
+    return renderCodeSnippet(value);
+  }
+
+  if (valueType === 'array') {
+    if (value.some((v) => getValueType(v) === 'object')) {
+      return renderCodeSnippet(value);
+    }
+    return renderText(value.join(',\n'));
+  }
+
+  return renderText(value);
+};
+
+const defaultRowDetailsRenderer = (item, itemLabelsMapping) => {
+  return `
+  <div class="row-details">
+  ${Object.entries(item)
+    .map(
+      ([key, value]) =>
+        `<div class="row-details__item" >
+          <div class="row-details__label">${itemLabelsMapping[key] || toTitle(key)}</div>
+          ${defaultRowDetailsValueRenderer(value)}
+        </div>`
+    )
+    .join('\n')}
+</div>
+  `;
+};
+
 const componentName$f = getComponentName('grid');
 
 const GridMixin = (superclass) =>
@@ -9893,6 +9953,40 @@ const GridMixin = (superclass) =>
 
       // disable the grid sort
       this.baseElement._mapSorters = () => {};
+
+      this.baseElement.rowDetailsRenderer = this.#rowDetailsRenderer.bind(this);
+    }
+
+    // this renders the details panel content
+    // in order to open it, the descope-grid-item-details-column should be used
+    #rowDetailsRenderer = async (cell, _col, model) => {
+      // prevent details panel from being scrolled into view when clicked
+      cell.addEventListener('mousedown', (e) => e.stopImmediatePropagation(), true);
+
+      const template = this.getRowDetailsTemplate(model.item);
+
+      // eslint-disable-next-line no-param-reassign
+      cell.innerHTML = '';
+      cell.append(template.content.cloneNode(true));
+    };
+
+    getRowDetailsTemplate(item) {
+      const itemLabelsMapping = this.#columns.reduce(
+        (acc, { path, header }) => (!path || !header ? acc : { ...acc, [path]: header }),
+        {}
+      );
+      const template =
+        this.rowDetailsRenderer?.(item, itemLabelsMapping) ??
+        defaultRowDetailsRenderer(item, itemLabelsMapping);
+
+      switch (true) {
+        case template instanceof HTMLTemplateElement:
+          return template;
+        case typeof template === 'string':
+          return Object.assign(document.createElement('template'), { innerHTML: template });
+        default:
+          throw new Error('rowDetailsRenderer should return a string or a template');
+      }
     }
 
     forwardSelectedItemsChange() {
@@ -9986,9 +10080,20 @@ const GridMixin = (superclass) =>
       );
     }
 
+    // there is an issue in vaadin-grid, when rowDetailsRenderer is set, it renders an empty details panel
+    reassignRowDetailsRenderer() {
+      this.baseElement.rowDetailsRenderer = null;
+      setTimeout(() => {
+        this.baseElement.rowDetailsRenderer = this.#rowDetailsRenderer.bind(this);
+      }, 0);
+    }
+
     renderColumns() {
       const template = this.getColumnsTemplate();
-      if (template) this.innerHTML = template;
+      if (template) {
+        this.reassignRowDetailsRenderer();
+        this.innerHTML = template;
+      }
     }
 
     get grid() {
@@ -10050,17 +10155,35 @@ const {
   selectedRow,
   rowSeparator,
   resizeHandle,
+  toggleDetailsPanelButton,
+  toggleDetailsPanelButtonOpened,
+  toggleDetailsPanelButtonClosed,
+  detailsPanel,
+  detailsPanelLabels,
+  selectedRowCell,
+  detailsPanelContent,
 } = {
   host: { selector: () => 'vaadin-grid' },
   headerRow: { selector: () => '::part(header-cell)' },
   headerRowCell: { selector: () => 'vaadin-grid::part(header-cell)' },
   contentRow: { selector: () => '::part(cell)' },
   firstRow: { selector: () => '::part(first-header-row-cell)' },
-  selectedRow: { selector: () => '::part(selected-row-cell)' },
+  selectedRow: { selector: () => '::part(selected-row)' },
+  selectedRowCell: { selector: () => '::part(selected-row-cell)' },
   sortIndicators: { selector: () => 'vaadin-grid-sorter::part(indicators)' },
   activeSortIndicator: { selector: () => 'vaadin-grid-sorter[direction]' },
   rowSeparator: { selector: () => 'vaadin-grid::part(body-cell)' },
   resizeHandle: { selector: () => '::part(resize-handle)' },
+  toggleDetailsPanelButton: { selector: () => 'vaadin-grid vaadin-icon.toggle-details-button' },
+  toggleDetailsPanelButtonOpened: {
+    selector: () => 'vaadin-grid vaadin-icon.toggle-details-button.opened',
+  },
+  toggleDetailsPanelButtonClosed: {
+    selector: () => 'vaadin-grid vaadin-icon.toggle-details-button.closed',
+  },
+  detailsPanel: { selector: () => 'vaadin-grid::part(details-cell)' },
+  detailsPanelLabels: { selector: () => 'vaadin-grid .row-details__label' },
+  detailsPanelContent: { selector: () => 'vaadin-grid .row-details' },
 };
 
 const GridClass = compose(
@@ -10084,7 +10207,10 @@ const GridClass = compose(
       borderWidth: { ...host$6, property: 'border-width' },
       borderStyle: { ...host$6, property: 'border-style' },
       borderRadius: { ...host$6, property: 'border-radius' },
-      selectedBackgroundColor: { ...selectedRow, property: 'background-color' },
+      selectedBackgroundColor: [
+        { ...selectedRow, property: 'background-color' },
+        { ...selectedRowCell, property: 'background-color' },
+      ],
       headerRowTextColor: { ...headerRowCell, property: 'color' },
       separatorColor: [
         { ...firstRow, property: 'border-bottom-color' },
@@ -10092,6 +10218,19 @@ const GridClass = compose(
       ],
       resizeHandleColor: { ...resizeHandle, property: 'background-color' },
       hostDirection: { ...host$6, property: 'direction', fallback: 'ltr' },
+      toggleDetailsPanelButtonSize: [
+        { ...toggleDetailsPanelButton, property: 'width' },
+        { ...toggleDetailsPanelButton, property: 'height' },
+      ],
+      toggleDetailsPanelButtonOpenedColor: { ...toggleDetailsPanelButtonOpened, property: 'color' },
+      toggleDetailsPanelButtonClosedColor: { ...toggleDetailsPanelButtonClosed, property: 'color' },
+      toggleDetailsPanelButtonCursor: { ...toggleDetailsPanelButton, property: 'cursor' },
+      detailsPanelBackgroundColor: { ...detailsPanel, property: 'background-color' },
+      detailsPanelBorderTopColor: { ...detailsPanel, property: 'border-top-color' },
+      detailsPanelLabelsColor: { ...detailsPanelLabels, property: 'color' },
+      detailsPanelLabelsFontSize: { ...detailsPanelLabels, property: 'font-size' },
+      detailsPanelItemsGap: { ...detailsPanelContent, property: 'grid-gap' },
+      detailsPanelPadding: { ...detailsPanelContent, property: 'padding' },
     },
   }),
   draggableMixin,
@@ -10103,6 +10242,7 @@ const GridClass = compose(
     slots: [''],
     wrappedEleName: 'vaadin-grid',
     style: () => `
+      /*css*/
       vaadin-grid {
         overflow: hidden;
         height: 100%;
@@ -10114,7 +10254,36 @@ const GridClass = compose(
       vaadin-grid::part(selected-row-cell) {
         background-image: none;
         box-shadow: none;
+        background-color: inherit;
+      }
+      vaadin-grid::part(details-cell) {
+        border-top-style: dashed;
+        border-top-width: 1px;
+      }
+      vaadin-grid .row-details {
+        display: grid;
+        grid-template-columns: repeat(auto-fit, minmax(max(200px, calc(100%/4 - var(${GridClass.cssVarList.detailsPanelItemsGap}))), 1fr));
+        width: 100%;
+      }
+      vaadin-grid .row-details__item:has(.row-details__value.json) {
+        grid-column: 1 / -1;
+        order: 2;
       }
+      vaadin-grid .row-details__value.text {
+        overflow: hidden;
+        text-overflow: ellipsis;
+        white-space: pre;
+      }
+      vaadin-grid .row-details__value.json {
+        margin-top: 5px;
+        max-height: 120px;
+        overflow: scroll;
+        font-size: 0.85em;
+      }
+      vaadin-grid vaadin-icon.toggle-details-button {
+        margin: auto;
+      }
+    /*!css*/
 		`,
     excludeAttrsSync: ['columns', 'tabindex'],
     componentName: componentName$f,
@@ -10150,6 +10319,17 @@ const grid = {
   [vars$e.selectedBackgroundColor]: globalRefs$b.colors.surface.highlight,
   [vars$e.hostDirection]: globalRefs$b.direction,
 
+  [vars$e.toggleDetailsPanelButtonSize]: '1em',
+  [vars$e.toggleDetailsPanelButtonOpenedColor]: globalRefs$b.colors.surface.contrast,
+  [vars$e.toggleDetailsPanelButtonClosedColor]: globalRefs$b.colors.surface.light,
+  [vars$e.toggleDetailsPanelButtonCursor]: 'pointer',
+  [vars$e.detailsPanelBackgroundColor]: globalRefs$b.colors.surface.highlight,
+  [vars$e.detailsPanelBorderTopColor]: globalRefs$b.colors.surface.light,
+  [vars$e.detailsPanelLabelsColor]: globalRefs$b.colors.surface.dark,
+  [vars$e.detailsPanelLabelsFontSize]: '0.8em',
+  [vars$e.detailsPanelItemsGap]: '2em',
+  [vars$e.detailsPanelPadding]: '12px 0',
+
   _bordered: {
     [vars$e.borderColor]: refs.borderColor,
   },