refactor(docker/configs): implement table in react [EE-4664] (#8912)

app/docker/components/datatables/configs-datatable/configsDatatable.html

@@ -1,170 +0,0 @@
-<div class="datatable">
-  <rd-widget>
-    <rd-widget-body classes="no-padding">
-      <div class="toolBar">
-        <div class="toolBarTitle vertical-center">
-          <div class="widget-icon space-right">
-            <pr-icon icon="$ctrl.titleIcon"></pr-icon>
-          </div>
-          {{ $ctrl.titleText }}
-        </div>
-        <div class="searchBar vertical-center">
-          <pr-icon icon="'search'" class-name="'searchIcon'"></pr-icon>
-          <input
-            type="text"
-            class="searchInput"
-            ng-model="$ctrl.state.textFilter"
-            ng-change="$ctrl.onTextFilterChange()"
-            placeholder="Search for a config..."
-            auto-focus
-            ng-model-options="{ debounce: 300 }"
-            data-cy="config-searchInput"
-          />
-        </div>
-        <div class="actionBar !gap-3" authorization="DockerConfigDelete, DockerConfigCreate">
-          <button
-            type="button"
-            class="btn btn-sm btn-dangerlight vertical-center !ml-0 h-fit"
-            authorization="DockerConfigDelete"
-            ng-disabled="$ctrl.state.selectedItemCount === 0"
-            ng-click="$ctrl.removeAction($ctrl.state.selectedItems)"
-            data-cy="config-removeConfigButton"
-          >
-            <pr-icon icon="'trash-2'"></pr-icon>Remove
-          </button>
-          <button
-            type="button"
-            class="btn btn-sm btn-primary vertical-center !ml-0 h-fit"
-            ui-sref="docker.configs.new"
-            authorization="DockerConfigCreate"
-            data-cy="config-addConfigButton"
-          >
-            <pr-icon icon="'plus'"></pr-icon>Add config
-          </button>
-        </div>
-        <div class="settings">
-          <span class="setting" ng-class="{ 'setting-active': $ctrl.settings.open }" uib-dropdown dropdown-append-to-body auto-close="disabled" is-open="$ctrl.settings.open">
-            <span uib-dropdown-toggle aria-label="Settings">
-              <pr-icon icon="'more-vertical'"></pr-icon>
-            </span>
-            <div class="dropdown-menu dropdown-menu-right" uib-dropdown-menu>
-              <div class="tableMenu">
-                <div class="menuHeader"> Table settings </div>
-                <div class="menuContent">
-                  <div>
-                    <div class="md-checkbox">
-                      <input id="setting_auto_refresh" type="checkbox" ng-model="$ctrl.settings.repeater.autoRefresh" ng-change="$ctrl.onSettingsRepeaterChange()" />
-                      <label for="setting_auto_refresh">Auto refresh</label>
-                    </div>
-                    <div ng-if="$ctrl.settings.repeater.autoRefresh">
-                      <label for="settings_refresh_rate"> Refresh rate </label>
-                      <select id="settings_refresh_rate" ng-model="$ctrl.settings.repeater.refreshRate" ng-change="$ctrl.onSettingsRepeaterChange()" class="small-select">
-                        <option value="10">10s</option>
-                        <option value="30">30s</option>
-                        <option value="60">1min</option>
-                        <option value="120">2min</option>
-                        <option value="300">5min</option>
-                      </select>
-                      <span>
-                        <pr-icon id="refreshRateChange" icon="'check'" mode="'success'" style="display: none"></pr-icon>
-                      </span>
-                    </div>
-                  </div>
-                </div>
-                <div>
-                  <a type="button" class="btn btn-default btn-sm" ng-click="$ctrl.settings.open = false;">Close</a>
-                </div>
-              </div>
-            </div>
-          </span>
-        </div>
-      </div>
-      <div class="table-responsive">
-        <table class="table-hover nowrap-cells table">
-          <thead>
-            <tr>
-              <th>
-                <div class="flex flex-nowrap items-center">
-                  <span class="md-checkbox vertical-center" authorization="DockerConfigDelete, DockerConfigCreate">
-                    <input id="select_all" type="checkbox" ng-model="$ctrl.state.selectAll" ng-change="$ctrl.selectAll()" />
-                    <label for="select_all"></label>
-                  </span>
-                  <table-column-header
-                    col-title="'Name'"
-                    can-sort="true"
-                    is-sorted="$ctrl.state.orderBy === 'Name'"
-                    is-sorted-desc="$ctrl.state.orderBy === 'Name' && $ctrl.state.reverseOrder"
-                    ng-click="$ctrl.changeOrderBy('Name')"
-                  ></table-column-header>
-                </div>
-              </th>
-              <th>
-                <table-column-header
-                  col-title="'Creation Date'"
-                  can-sort="true"
-                  is-sorted="$ctrl.state.orderBy === 'CreatedAt'"
-                  is-sorted-desc="$ctrl.state.orderBy === 'CreatedAt' && $ctrl.state.reverseOrder"
-                  ng-click="$ctrl.changeOrderBy('CreatedAt')"
-                ></table-column-header>
-              </th>
-              <th>
-                <table-column-header
-                  col-title="'Ownership'"
-                  can-sort="true"
-                  is-sorted="$ctrl.state.orderBy === 'ResourceControl.Ownership'"
-                  is-sorted-desc="$ctrl.state.orderBy === 'ResourceControl.Ownership' && $ctrl.state.reverseOrder"
-                  ng-click="$ctrl.changeOrderBy('ResourceControl.Ownership')"
-                ></table-column-header>
-              </th>
-            </tr>
-          </thead>
-          <tbody>
-            <tr
-              dir-paginate="item in ($ctrl.state.filteredDataSet = ($ctrl.dataset | filter:$ctrl.state.textFilter | orderBy:$ctrl.state.orderBy:$ctrl.state.reverseOrder | itemsPerPage: $ctrl.state.paginatedItemLimit))"
-              ng-class="{ active: item.Checked }"
-            >
-              <td>
-                <span class="md-checkbox" authorization="DockerConfigDelete, DockerConfigCreate">
-                  <input id="select_{{ $index }}" type="checkbox" ng-model="item.Checked" ng-click="$ctrl.selectItem(item, $event)" />
-                  <label for="select_{{ $index }}"></label>
-                </span>
-                <a ui-sref="docker.configs.config({id: item.Id})">{{ item.Name }}</a>
-              </td>
-              <td>{{ item.CreatedAt | getisodate }}</td>
-              <td>
-                <span>
-                  <i ng-class="item.ResourceControl.Ownership | ownershipicon" aria-hidden="true"></i>
-                  {{ item.ResourceControl.Ownership ? item.ResourceControl.Ownership : item.ResourceControl.Ownership = $ctrl.RCO.ADMINISTRATORS }}
-                </span>
-              </td>
-            </tr>
-            <tr ng-if="!$ctrl.dataset">
-              <td colspan="3" class="text-muted text-center">Loading...</td>
-            </tr>
-            <tr ng-if="$ctrl.state.filteredDataSet.length === 0">
-              <td colspan="3" class="text-muted text-center">No config available.</td>
-            </tr>
-          </tbody>
-        </table>
-      </div>
-      <div class="footer" ng-if="$ctrl.dataset">
-        <div class="infoBar" ng-if="$ctrl.state.selectedItemCount !== 0"> {{ $ctrl.state.selectedItemCount }} item(s) selected </div>
-        <div class="paginationControls">
-          <form class="form-inline vertical-center">
-            <span class="limitSelector">
-              <span style="margin-right: 5px"> Items per page </span>
-              <select class="form-control" ng-model="$ctrl.state.paginatedItemLimit" ng-change="$ctrl.changePaginationLimit()" data-cy="component-paginationSelect">
-                <option value="0">All</option>
-                <option value="10">10</option>
-                <option value="25">25</option>
-                <option value="50">50</option>
-                <option value="100">100</option>
-              </select>
-            </span>
-            <dir-pagination-controls max-size="5"></dir-pagination-controls>
-          </form>
-        </div>
-      </div>
-    </rd-widget-body>
-  </rd-widget>
-</div>

app/docker/components/datatables/configs-datatable/configsDatatable.js

@@ -1,14 +0,0 @@
-angular.module('portainer.docker').component('configsDatatable', {
-  templateUrl: './configsDatatable.html',
-  controller: 'GenericDatatableController',
-  bindings: {
-    titleText: '@',
-    titleIcon: '@',
-    dataset: '<',
-    tableKey: '@',
-    orderBy: '@',
-    reverseOrder: '<',
-    removeAction: '<',
-    refreshCallback: '<',
-  },
-});

app/docker/react/components/index.ts

@@ -18,6 +18,7 @@ import { InsightsBox } from '@/react/components/InsightsBox';
 import { BetaAlert } from '@/react/portainer/environments/update-schedules/common/BetaAlert';
 import { ImagesDatatable } from '@/react/docker/images/ListView/ImagesDatatable/ImagesDatatable';
 import { EventsDatatable } from '@/react/docker/events/EventsDatatables';
+import { ConfigsDatatable } from '@/react/docker/configs/ListView/ConfigsDatatable';
 
 const ngModule = angular
   .module('portainer.docker.react.components', [])
@@ -82,6 +83,14 @@ const ngModule = angular
       'onRemove',
     ])
   )
+  .component(
+    'dockerConfigsDatatable',
+    r2a(withUIRouter(ConfigsDatatable), [
+      'dataset',
+      'onRemoveClick',
+      'onRefresh',
+    ])
+  )
   .component('dockerEventsDatatable', r2a(EventsDatatable, ['dataset']));
 
 export const componentsModule = ngModule.name;

app/docker/views/configs/configs.html

@@ -1,15 +1,3 @@
 <page-header title="'Configs list'" breadcrumbs="['Configs']" reload="true"> </page-header>
 
-<div class="row">
-  <div class="col-sm-12">
-    <configs-datatable
-      title-text="Configs"
-      title-icon="clipboard"
-      dataset="ctrl.configs"
-      table-key="configs"
-      order-by="Name"
-      remove-action="ctrl.removeAction"
-      refresh-callback="ctrl.getConfigs"
-    ></configs-datatable>
-  </div>
-</div>
+<docker-configs-datatable dataset="ctrl.configs" on-remove-click="(ctrl.removeAction)" on-refresh="(ctrl.getConfigs)"></docker-configs-datatable>

app/react/docker/configs/ListView/ConfigsDatatable/ConfigsDatatable.tsx

@@ -0,0 +1,62 @@
+import { Clipboard, Plus, Trash2 } from 'lucide-react';
+
+import { Datatable, TableSettingsMenu } from '@@/datatables';
+import { TableSettingsMenuAutoRefresh } from '@@/datatables/TableSettingsMenuAutoRefresh';
+import { useRepeater } from '@@/datatables/useRepeater';
+import { Button } from '@@/buttons';
+import { Link } from '@@/Link';
+import { useTableState } from '@@/datatables/useTableState';
+
+import { DockerConfig } from '../../types';
+
+import { columns } from './columns';
+import { createStore } from './store';
+
+interface Props {
+  dataset: Array<DockerConfig>;
+  onRemoveClick: (configs: Array<DockerConfig>) => void;
+  onRefresh: () => Promise<void>;
+}
+
+const storageKey = 'docker_configs';
+const settingsStore = createStore(storageKey);
+
+export function ConfigsDatatable({ dataset, onRefresh, onRemoveClick }: Props) {
+  const tableState = useTableState(settingsStore, storageKey);
+
+  useRepeater(tableState.autoRefreshRate, onRefresh);
+
+  return (
+    <Datatable
+      dataset={dataset}
+      columns={columns}
+      settingsManager={tableState}
+      title="Configs"
+      titleIcon={Clipboard}
+      emptyContentLabel="No config available."
+      renderTableSettings={() => (
+        <TableSettingsMenu>
+          <TableSettingsMenuAutoRefresh
+            value={tableState.autoRefreshRate}
+            onChange={(value) => tableState.setAutoRefreshRate(value)}
+          />
+        </TableSettingsMenu>
+      )}
+      renderTableActions={(selectedRows) => (
+        <div className="flex items-center gap-3">
+          <Button
+            icon={Trash2}
+            color="dangerlight"
+            onClick={() => onRemoveClick(selectedRows)}
+            disabled={selectedRows.length === 0}
+          >
+            Remove
+          </Button>
+          <Button icon={Plus} as={Link} props={{ to: 'docker.configs.new' }}>
+            Add config
+          </Button>
+        </div>
+      )}
+    />
+  );
+}

app/react/docker/configs/ListView/ConfigsDatatable/columns.tsx

@@ -0,0 +1,22 @@
+import { createColumnHelper } from '@tanstack/react-table';
+
+import { isoDate } from '@/portainer/filters/filters';
+import { createOwnershipColumn } from '@/react/docker/components/datatable-helpers/createOwnershipColumn';
+
+import { buildNameColumn } from '@@/datatables/NameCell';
+
+import { DockerConfig } from '../../types';
+
+const columnHelper = createColumnHelper<DockerConfig>();
+
+export const columns = [
+  buildNameColumn<DockerConfig>('Name', 'Id', 'docker.configs.config'),
+  columnHelper.accessor('CreatedAt', {
+    header: 'Creation Date',
+    cell: ({ getValue }) => {
+      const date = getValue();
+      return <time dateTime={date}>{isoDate(date)}</time>;
+    },
+  }),
+  createOwnershipColumn<DockerConfig>(),
+];

app/react/docker/configs/ListView/ConfigsDatatable/index.ts

@@ -0,0 +1 @@
+export { ConfigsDatatable } from './ConfigsDatatable';

app/react/docker/configs/ListView/ConfigsDatatable/store.ts

@@ -0,0 +1,16 @@
+import {
+  BasicTableSettings,
+  createPersistedStore,
+  refreshableSettings,
+  RefreshableTableSettings,
+} from '@@/datatables/types';
+
+export interface TableSettings
+  extends BasicTableSettings,
+    RefreshableTableSettings {}
+
+export function createStore(storageKey: string) {
+  return createPersistedStore<TableSettings>(storageKey, 'name', (set) => ({
+    ...refreshableSettings(set),
+  }));
+}

app/react/docker/configs/types.ts

@@ -0,0 +1,8 @@
+import { ResourceControlViewModel } from '@/react/portainer/access-control/models/ResourceControlViewModel';
+
+export type DockerConfig = {
+  Id: string;
+  Name: string;
+  CreatedAt: string;
+  ResourceControl?: ResourceControlViewModel;
+};