Row Detail

index

Demo

Description

A Row Detail allows you to open a detail panel which can contain extra and/or more detailed information about a row. For example, we have a user list but we want to display detailed information about this user (his full address, account info, last purchasers, ...) but we don't want to display this in the user grid (for performance and real estate reasons), so a Row Detail is perfect for this.

NOTE

There is currently a known problem with Row Detail when loading the Row Detail Components, it currently shows console warnings (see below), however these are just warnings and they don't show up in Production code. If anyone knows how to fix it please provide a Pull Request as a contribution (please note that the suggestion to use root.render() does NOT work as intended hence why we call createRoot() every time a row detail is rendered).

You are calling ReactDOMClient.createRoot() on a container that has already been passed to createRoot() before. Instead, call root.render() on the existing root instead if you want to update it.

Usage

Component

export class GridExample {
  reactGrid: SlickgridReactInstance;

  reactGridReady(reactGrid: SlickgridReactInstance) {
    this.reactGrid = reactGrid;
  }

  componentDidMount() {
    this.defineGrid();
  }

  defineGrid() {
    const columnDefinitions = this.getColumnsDefinition();
    const gridOptions = this.getGridOptions();

    this.setState((props: Props, state: any) => {
      return {
        ...state,
        columnDefinitions,
        gridOptions
      };
    });
  }

  getColumnsDefinition(): Column[] {
    return [ /*...*/ ];
  }

  getGridOptions(): GridOption {
    return {
      enableRowDetailView: true,
      rowSelectionOptions: {
        selectActiveRow: true
      },
      preRegisterExternalExtensions: (pubSubService) => {
        // Row Detail View is a special case because of its requirement to create extra column definition dynamically
        // so it must be pre-registered before SlickGrid is instantiated, we can do so via this option
        const rowDetail = new SlickRowDetailView(pubSubService as EventPubSubService);
        return [{ name: ExtensionName.rowDetailView, instance: rowDetail }];
      },
      rowDetailView: {
        // We can load the "process" asynchronously via Fetch, Promise, ...
        process: (item) => this.http.get(`api/item/${item.id}`),

        // load only once and reuse the same item detail without calling process method
        loadOnce: true,

        // limit expanded row to only 1 at a time
        singleRowExpand: false,

        // false by default, clicking anywhere on the row will open the detail view
        // when set to false, only the "+" icon would open the row detail
        // if you use editor or cell navigation you would want this flag set to false (default)
        useRowClick: true,

        // how many grid rows do we want to use for the row detail panel (this is only set once and will be used for all row detail)
        // also note that the detail view adds an extra 1 row for padding purposes
        // so if you choose 4 panelRows, the display will in fact use 5 rows
        panelRows: this.detailViewRowCount,

        // you can override the logic for showing (or not) the expand icon
        // for example, display the expand icon only on every 2nd row
        // expandableOverride: (row: number, dataContext: any, grid: any) => (dataContext.id % 2 === 1),

        // Preload View Template
        preloadComponent: Example19Preload,

        // ViewModel Template to load when row detail data is ready
        viewComponent: Example19DetailView,

        // Optionally pass your Parent Component reference to your Child Component (row detail component)
        parent: this
      }
    };
  }

  render() {
    return <SlickgridReact gridId="grid40"
          columnDefinitions={this.state.columnDefinitions}
          gridOptions={this.state.gridOptions}
          dataset={this.state.dataset}
          onReactGridCreated={$event => this.reactGridReady($event.detail)} />
  }
}

Changing Addon Options Dynamically

Row Detail is an addon (commonly known as a plugin and are opt-in addon), because this is not built-in SlickGrid and instead are opt-in, we need to get the instance of that addon object. Once we have the instance, we can use getOptions and setOptions to get/set any of the addon options, adding rowDetail with intellisense should give you this info.

Examples

Dynamically change the Detail View Row Count (how many grid rows do we want to use for the row detail panel)

changeDetailViewRowCount() {
  if (this.reactGrid?.extensionService) {
    const rowDetailInstance = this.reactGrid.extensionService.getExtensionInstanceByName(ExtensionName.rowDetailView);
    const options = rowDetailInstance.getOptions();
    options.panelRows = this.detailViewRowCount; // change number of rows dynamically
    rowDetailInstance.setOptions(options);
  }
}

Calling Addon Methods Dynamically

Same as previous paragraph, after we get the SlickGrid addon instance, we can call any of the addon methods, adding rowDetail with intellisense should give you this info.

Examples

Dynamically close all Row Detail Panels

closeAllRowDetail() {
  if (this.reactGrid && this.reactGrid.extensionService) {
    const rowDetailInstance = this.reactGrid.extensionService.getExtensionInstanceByName(ExtensionName.rowDetailView);
    rowDetailInstance.collapseAll();
  }
}

Dynamically close a single Row Detail by it's grid index This requires a bit more work, you can call the method collapseDetailView(item) but it requires to pass the row item object (data context) and it feasible but it's just more work as can be seen below.

closeRowDetail(gridRowIndex: number) {
  if (this.reactGrid && this.reactGrid.extensionService) {
    const rowDetailInstance = this.reactGrid.extensionService.getExtensionInstanceByName(ExtensionName.rowDetailView);
    const item = this.reactGrid.gridService.getDataItemByRowIndex(gridRowIndex);
    rowDetailInstance.collapseDetailView(item);
  }
}

Row Detail - Preload Component (loading spinner)

Most of the time we would get data asynchronously, during that time we can show a loading spinner to the user via the preloadComponent grid option. We could use this simple Preload Component example as shown below

Preload Component

import { forwardRef } from 'react';

export const Example19Preload = forwardRef((props: any, ref: any) => {
  return (
    <div ref={ref} className="container-fluid" style={{ marginTop: '10px' }}>
      <h4>
        <i className="mdi mdi-sync mdi-spin mdi-50px"></i>
        Loading...
      </h4>
    </div>
  );
});

Row Detail - ViewModel

Same concept as the preload, we pass a React Component to the viewComponent that will be used to render our Row Detail.

Row Detail Component

import React from 'react';
import type { SlickDataView, SlickGrid, SlickRowDetailView } from 'slickgrid-react';

import './example19-detail-view.scss';

interface Props {
  model: {
    duration: Date;
    percentComplete: number;
    // ...
  };
  addon: SlickRowDetailView;
  grid: SlickGrid;
  dataView: SlickDataView;
  parent: any;
}
interface State { assignee: string; }

export class Example19DetailView extends React.Component<Props, State> {
  constructor(public readonly props: Props) {
    super(props);
    this.state = {
      assignee: props.model?.assignee || ''
    }
  }

  // ...
  // 

  render() {
    return (
      <div className="container-fluid" style={{ marginTop: '10px' }}>
        <h3>{this.props.model.title}</h3>
        <div className="row">
          <div className="col-3 detail-label"><label>Assignee:</label> <input className="form-control" value={this.state.assignee} onInput={($event) => this.assigneeChanged(($event.target as HTMLInputElement).value)} /></div>
          <div className="col-3 detail-label"><label>Reporter:</label> <span>{this.props.model.reporter}</span></div>
          <div className="col-3 detail-label"><label>Duration:</label> <span>{this.props.model.duration?.toISOString?.()}</span></div>
          <div className="col-3 detail-label"><label>% Complete:</label> <span>{this.props.model.percentComplete}</span></div>
        </div>

        <div className="row">
          <div className="col-3 detail-label"><label>Start:</label> <span>{this.props.model.start?.toISOString()}</span></div>
          <div className="col-3 detail-label"><label>Finish:</label> <span>{this.props.model.finish?.toISOString()}</span></div>
          <div className="col-3 detail-label"><label>Effort Driven:</label> <i className={this.props.model.effortDriven ? 'mdi mdi-check' : ''}></i>
          </div>
        </div>

        <hr />

        <div className="col-sm-8">
          <h4>
            Find out who is the Assignee
            <small>
              <button className="btn btn-primary btn-sm" onClick={() => this.alertAssignee(this.props.model.assignee)} data-test="assignee-btn">
                Click Me
              </button>
            </small>
          </h4>
        </div>

        <div className="col-sm-4">
          <button className="btn btn-primary btn-danger btn-sm" onClick={() => this.deleteRow(this.props.model)} data-test="delete-btn">
            Delete Row
          </button>
          <button className="btn btn-outline-secondary btn-sm" onClick={() => this.callParentMethod(this.props.model)} data-test="parent-btn">
            Call Parent Method
          </button>
        </div>
      </div>
    );
  }
}

Grid Definition

export class GridExample {
  // ...

  getGridOptions(): GridOption {
    return {
      enableRowDetailView: true,
      preRegisterExternalExtensions: (pubSubService) => {
        // Row Detail View is a special case because of its requirement to create extra column definition dynamically
        // so it must be pre-registered before SlickGrid is instantiated, we can do so via this option
        const rowDetail = new SlickRowDetailView(pubSubService as EventPubSubService);
        return [{ name: ExtensionName.rowDetailView, instance: rowDetail }];
      },
      rowDetailView: {
        // We can load the "process" asynchronously via Fetch, Promise, ...
        process: (item) => this.http.get(`api/item/${item.id}`),

        // ...
        
        // Preload Component
        preloadComponent: Example19Preload,

        // Row Detail Component to load when row detail data is ready
        viewComponent: Example19DetailView,

        // Optionally pass your Parent Component reference to your Child Component (row detail component)
        parent: this
      }
    };
  }

  render() {
    return <SlickgridReact gridId="grid40"
          columnDefinitions={this.state.columnDefinitions}
          gridOptions={this.state.gridOptions}
          dataset={this.state.dataset}
          onReactGridCreated={$event => this.reactGridReady($event.detail)} />
  }
}

Access Parent Component (grid) from the Child Component (row detail)

The Row Detail provides you access to the following references (SlickGrid, DataView, Parent Component and the Addon (3rd party plugin)), however please note that all of these references are available from the start except the Parent Component instance, for that one you need to reference it inside your Row Detail Grid Options like so:

export class GridExample {
  // Parent Component (grid)
  getGridOptions(): GridOption {
    return {
      enableRowDetailView: true,
      preRegisterExternalExtensions: (pubSubService) => {
        // Row Detail View is a special case because of its requirement to create extra column definition dynamically
        // so it must be pre-registered before SlickGrid is instantiated, we can do so via this option
        const rowDetail = new SlickRowDetailView(pubSubService as EventPubSubService);
        return [{ name: ExtensionName.rowDetailView, instance: rowDetail }];
      },
      rowDetailView: {
        // ...
        // ViewComponent Template to load when row detail data is ready
        viewComponent: CustomDetailView,

        // Optionally pass your Parent Component reference to your Child Component (row detail component)
        parent: this  // <-- THIS REFERENCE
      }
    }
  }

  // a Parent Method that we want to access
  showFlashMessage(message: string, alertType = 'info') {
    this.setState((props, state) => {
      return { ...state, message, flashAlertType: alertType }
    });
  }
}

Then in our Child Component, we can do some action on the Grid, the DataView or even call a method form the Parent Component (the showFlashMessage in our demo), with that in mind, here is the code of the Child Component

View

<div class="container-fluid">
  <h3>{this.props.model.title}</h3>

    <-- delete a row using the DataView & SlickGrid objects -->
    <button class="btn btn-primary btn-danger btn-sm" onClick={this.deleteRow(this.props.model)} data-test="delete-btn">
      Delete Row
    </button>

    <!-- calling a Parent Component method -->
    <button class="btn btn-default btn-sm" onClick={this.callParentMethod(this.props.model)} data-test="parent-btn">
      Call Parent Method
    </button>
</div>

Component

import React from 'react';
import type { SlickDataView, SlickGrid, SlickRowDetailView } from 'slickgrid-react';

import './example19-detail-view.scss';

interface Props {
  model: {
    duration: Date;
    percentComplete: number;
    // ...
  };
  addon: SlickRowDetailView;
  grid: SlickGrid;
  dataView: SlickDataView;
  parent: any;
}
interface State { assignee: string; }

export class Example19DetailView extends React.Component<Props, State> {
  constructor(public readonly props: Props) {
    super(props);
    this.state = {
      assignee: props.model?.assignee || ''
    }
  }

  assigneeChanged(newAssignee: string) {
    this.setState((props: Props, state: State) => {
      return { ...state, assignee: newAssignee }
    });
  }

  alertAssignee(name: string) {
    if (typeof name === 'string') {
      alert(`Assignee on this task is: ${name.toUpperCase()}`);
    } else {
      alert('No one is assigned to this task.');
    }
  }

  deleteRow(model: any) {
    if (confirm(`Are you sure that you want to delete ${model.title}?`)) {
      // you first need to collapse all rows (via the 3rd party addon instance)
      this.props.addon.collapseAll();

      // then you can delete the item from the dataView
      this.props.dataView.deleteItem(model.rowId);

      this.props.parent!.showFlashMessage(`Deleted row with ${model.title}`, 'danger');
    }
  }

  callParentMethod(model: any) {
    this.props.parent!.showFlashMessage(`We just called Parent Method from the Row Detail Child Component on ${model.title}`);
  }

  render() {
    // ...
  }
}

Troubleshooting

Adding a Column dynamically is removing the Row Selection, why is that?

The reason is because the Row Selection (checkbox) plugin is a special column and Slickgrid-React is adding an extra column dynamically for the Row Selection checkbox and that is not reflected in your local copy of columnDefinitions. To address this issue, you need to get the Slickgrid-React internal copy of all columns (including the extra columns), you can get it via getAllColumnDefinitions() from the Grid Service and then you can use to that array and that will work.

reactGridReady(reactGrid: SlickgridReactInstance) {
  this.reactGrid = reactGrid;
}

addNewColumn() {
  const newColumn = { /*...*/ };

  const allColumns = this.reactGrid.gridService.getAllColumnDefinitions();
  allColumns.push(newColumn);
  this.setState((props, state) => {
    return {
      ...state,
      columnDefinitions: allColumns.slice(); // or use spread operator [...cols]
    };
  }
}

PreviousProviding data to the grid NextRow Selection

Last updated 1 month ago