src/widgets/basic_table.ts

// Copyright (C) 2023 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use size file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import m from 'mithril';
import {scheduleFullRedraw} from './raf';

export interface ColumnDescriptor<T> {
  readonly title: m.Children;
  render: (row: T) => m.Children;
}

// This is a class to be able to perform runtime checks on `columns` below.
export class ReorderableColumns<T> {
  constructor(
    public columns: ColumnDescriptor<T>[],
    public reorder?: (from: number, to: number) => void,
  ) {}
}

export interface TableAttrs<T> {
  readonly data: ReadonlyArray<T>;
  readonly columns: ReadonlyArray<ColumnDescriptor<T> | ReorderableColumns<T>>;
}

export class BasicTable<T> implements m.ClassComponent<TableAttrs<T>> {
  view(vnode: m.Vnode<TableAttrs<T>>): m.Children {
    const attrs = vnode.attrs;
    const columnBlocks: ColumnBlock<T>[] = getColumns(attrs);

    const columns: {column: ColumnDescriptor<T>; extraClasses: string}[] = [];
    const headers: m.Children[] = [];
    for (const [blockIndex, block] of columnBlocks.entries()) {
      const currentColumns = block.columns.map((column, columnIndex) => ({
        column,
        extraClasses:
          columnIndex === 0 && blockIndex !== 0 ? '.has-left-border' : '',
      }));
      if (block.reorder === undefined) {
        for (const {column, extraClasses} of currentColumns) {
          headers.push(m(`td${extraClasses}`, column.title));
        }
      } else {
        headers.push(
          m(ReorderableCellGroup, {
            cells: currentColumns.map(({column, extraClasses}) => ({
              content: column.title,
              extraClasses,
            })),
            onReorder: block.reorder,
          }),
        );
      }
      columns.push(...currentColumns);
    }

    return m(
      'table.generic-table',
      {
        // TODO(altimin, stevegolton): this should be the default for
        // generic-table, but currently it is overriden by
        // .pf-details-shell .pf-content table, so specify this here for now.
        style: {
          'table-layout': 'auto',
        },
      },
      m('thead', m('tr.header', headers)),
      attrs.data.map((row) =>
        m(
          'tr',
          columns.map(({column, extraClasses}) =>
            m(`td${extraClasses}`, column.render(row)),
          ),
        ),
      ),
    );
  }
}

type ColumnBlock<T> = {
  columns: ColumnDescriptor<T>[];
  reorder?: (from: number, to: number) => void;
};

function getColumns<T>(attrs: TableAttrs<T>): ColumnBlock<T>[] {
  const result: ColumnBlock<T>[] = [];
  let current: ColumnBlock<T> = {columns: []};
  for (const col of attrs.columns) {
    if (col instanceof ReorderableColumns) {
      if (current.columns.length > 0) {
        result.push(current);
        current = {columns: []};
      }
      result.push(col);
    } else {
      current.columns.push(col);
    }
  }
  if (current.columns.length > 0) {
    result.push(current);
  }
  return result;
}

export interface ReorderableCellGroupAttrs {
  cells: {
    content: m.Children;
    extraClasses: string;
  }[];
  onReorder: (from: number, to: number) => void;
}

const placeholderElement = document.createElement('span');

// A component that renders a group of cells on the same row that can be
// reordered between each other by using drag'n'drop.
//
// On completed reorder, a callback is fired.
class ReorderableCellGroup
  implements m.ClassComponent<ReorderableCellGroupAttrs>
{
  private drag?: {
    from: number;
    to?: number;
  };

  private getClassForIndex(index: number): string {
    if (this.drag?.from === index) {
      return 'dragged';
    }
    if (this.drag?.to === index) {
      return 'highlight-left';
    }
    if (this.drag?.to === index + 1) {
      return 'highlight-right';
    }
    return '';
  }

  view(vnode: m.Vnode<ReorderableCellGroupAttrs>): m.Children {
    return vnode.attrs.cells.map((cell, index) =>
      m(
        `td.reorderable-cell${cell.extraClasses}`,
        {
          draggable: 'draggable',
          class: this.getClassForIndex(index),
          ondragstart: (e: DragEvent) => {
            this.drag = {
              from: index,
            };
            if (e.dataTransfer !== null) {
              e.dataTransfer.setDragImage(placeholderElement, 0, 0);
            }

            scheduleFullRedraw();
          },
          ondragover: (e: DragEvent) => {
            let target = e.target as HTMLElement;
            if (this.drag === undefined || this.drag?.from === index) {
              // Don't do anything when hovering on the same cell that's
              // been dragged, or when dragging something other than the
              // cell from the same group.
              return;
            }

            while (
              target.tagName.toLowerCase() !== 'td' &&
              target.parentElement !== null
            ) {
              target = target.parentElement;
            }

            // When hovering over cell on the right half, the cell will be
            // moved to the right of it, vice versa for the left side. This
            // is done such that it's possible to put dragged cell to every
            // possible position.
            const offset = e.clientX - target.getBoundingClientRect().x;
            const direction =
              offset > target.clientWidth / 2 ? 'right' : 'left';
            const dest = direction === 'left' ? index : index + 1;
            const adjustedDest =
              dest === this.drag.from || dest === this.drag.from + 1
                ? undefined
                : dest;
            if (adjustedDest !== this.drag.to) {
              this.drag.to = adjustedDest;
              scheduleFullRedraw();
            }
          },
          ondragleave: (e: DragEvent) => {
            if (this.drag?.to !== index) return;
            this.drag.to = undefined;
            scheduleFullRedraw();
            if (e.dataTransfer !== null) {
              e.dataTransfer.dropEffect = 'none';
            }
          },
          ondragend: () => {
            if (
              this.drag !== undefined &&
              this.drag.to !== undefined &&
              this.drag.from !== this.drag.to
            ) {
              vnode.attrs.onReorder(this.drag.from, this.drag.to);
            }

            this.drag = undefined;
            scheduleFullRedraw();
          },
        },
        cell.content,
      ),
    );
  }
}