@patternfly/react-table 4.61.18 → 4.62.0

package/src/components/TableComposable/examples/ComposableTableStripedExpandable.tsx

@@ -0,0 +1,200 @@
+import React from 'react';
+import { TableComposable, Thead, Tr, Th, Tbody, Td, ExpandableRowContent } from '@patternfly/react-table';
+import { Checkbox } from '@patternfly/react-core';
+
+interface Repository {
+  name: string;
+  branches: string;
+  prs: string;
+  workspaces: string;
+  lastCommit: string;
+  details?: {
+    detail1?: string;
+    detail2?: string;
+    detail3?: string;
+    detailFormat: 0 | 1 | 2 | 3;
+  };
+}
+
+export const ComposableTableStripedExpandable: React.FunctionComponent = () => {
+  // In real usage, this data would come from some external source like an API via props.
+  const repositories: Repository[] = [
+    { name: 'one', branches: 'two', prs: 'a', workspaces: 'four', lastCommit: 'five' },
+    {
+      name: 'parent 1',
+      branches: 'two',
+      prs: 'k',
+      workspaces: 'four',
+      lastCommit: 'five',
+      // This `details` structure is just for this example. You can drive expanded content from any kind of data.
+      details: { detailFormat: 0, detail1: 'single cell' }
+    },
+    {
+      name: 'parent 2',
+      branches: 'two',
+      prs: 'b',
+      workspaces: 'four',
+      lastCommit: 'five',
+      details: { detailFormat: 1, detail1: 'single cell - fullWidth' }
+    },
+    {
+      name: 'parent 3',
+      branches: '2',
+      prs: 'b',
+      workspaces: 'four',
+      lastCommit: 'five',
+      details: { detailFormat: 2, detail1: 'single cell - noPadding' }
+    },
+    {
+      name: 'parent 4',
+      branches: '2',
+      prs: 'b',
+      workspaces: 'four',
+      lastCommit: 'five',
+      details: { detailFormat: 3, detail1: 'single cell - fullWidth & noPadding' }
+    },
+    {
+      name: 'parent 5',
+      branches: '2',
+      prs: 'b',
+      workspaces: 'four',
+      lastCommit: 'five',
+      details: {
+        detailFormat: 0,
+        detail1: "spans 'Repositories and 'Branches'",
+        detail2: "spans 'Pull requests' and 'Workspaces', and 'Last commit'"
+      }
+    },
+    {
+      name: 'parent 6',
+      branches: '2',
+      prs: 'b',
+      workspaces: 'four',
+      lastCommit: 'five',
+      details: {
+        detailFormat: 1,
+        detail1: "fullWidth, spans the collapsible column and 'Repositories'",
+        detail2: "fullWidth, spans 'Branches' and 'Pull requests'",
+        detail3: "fullWidth, spans 'Workspaces' and 'Last commit'"
+      }
+    }
+  ];
+
+  const columnNames = {
+    name: 'Repositories',
+    branches: 'Branches',
+    prs: 'Pull requests',
+    workspaces: 'Workspaces',
+    lastCommit: 'Last commit'
+  };
+
+  // In this example, expanded rows are tracked by the repo names from each row. This could be any unique identifier.
+  // This is to prevent state from being based on row order index in case we later add sorting.
+  // Note that this behavior is very similar to selection state.
+  const initialExpandedRepoNames = repositories.filter(repo => !!repo.details).map(repo => repo.name); // Default to all expanded
+  const [expandedRepoNames, setExpandedRepoNames] = React.useState<string[]>(initialExpandedRepoNames);
+  const setRepoExpanded = (repo: Repository, isExpanding = true) =>
+    setExpandedRepoNames(prevExpanded => {
+      const otherExpandedRepoNames = prevExpanded.filter(r => r !== repo.name);
+      return isExpanding ? [...otherExpandedRepoNames, repo.name] : otherExpandedRepoNames;
+    });
+  const isRepoExpanded = (repo: Repository) => expandedRepoNames.includes(repo.name);
+
+  const [isExampleCompact, setIsExampleCompact] = React.useState(true);
+
+  return (
+    <React.Fragment>
+      <Checkbox
+        label="Compact"
+        isChecked={isExampleCompact}
+        onChange={checked => setIsExampleCompact(checked)}
+        aria-label="toggle striped compact variation"
+        id="toggle-compact-striped"
+        name="toggle-compact-striped"
+      />
+      <TableComposable
+        aria-label="Expandable table"
+        variant={isExampleCompact ? 'compact' : undefined}
+        isStriped
+        isExpandable
+      >
+        <Thead>
+          <Tr>
+            <Th />
+            <Th>{columnNames.name}</Th>
+            <Th>{columnNames.branches}</Th>
+            <Th>{columnNames.prs}</Th>
+            <Th>{columnNames.workspaces}</Th>
+            <Th>{columnNames.lastCommit}</Th>
+          </Tr>
+        </Thead>
+        {repositories.map((repo, rowIndex) => {
+          // Some arbitrary examples of how you could customize the child row based on your needs
+          let childIsFullWidth = false;
+          let childHasNoPadding = false;
+          let detail1Colspan = 1;
+          let detail2Colspan = 1;
+          let detail3Colspan = 1;
+          if (repo.details) {
+            const { detail1, detail2, detail3, detailFormat } = repo.details;
+            const numColumns = 5;
+            childIsFullWidth = [1, 3].includes(detailFormat);
+            childHasNoPadding = [2, 3].includes(detailFormat);
+            if (detail1 && !detail2 && !detail3) {
+              detail1Colspan = childIsFullWidth ? numColumns : numColumns + 1; // Account for toggle column
+            } else if (detail1 && detail2 && !detail3) {
+              detail1Colspan = 2;
+              detail2Colspan = childIsFullWidth ? 3 : 4;
+            } else if (detail1 && detail2 && detail3) {
+              detail1Colspan = 2;
+              detail2Colspan = 2;
+              detail3Colspan = childIsFullWidth ? 1 : 2;
+            }
+          }
+          return (
+            <Tbody key={repo.name} isExpanded={isRepoExpanded(repo)}>
+              <Tr>
+                <Td
+                  expand={
+                    repo.details
+                      ? {
+                          rowIndex,
+                          isExpanded: isRepoExpanded(repo),
+                          onToggle: () => setRepoExpanded(repo, !isRepoExpanded(repo))
+                        }
+                      : undefined
+                  }
+                />
+                <Td dataLabel={columnNames.name}>{repo.name}</Td>
+                <Td dataLabel={columnNames.branches}>{repo.branches}</Td>
+                <Td dataLabel={columnNames.prs}>{repo.prs}</Td>
+                <Td dataLabel={columnNames.workspaces}>{repo.workspaces}</Td>
+                <Td dataLabel={columnNames.lastCommit}>{repo.lastCommit}</Td>
+              </Tr>
+              {repo.details ? (
+                <Tr isExpanded={isRepoExpanded(repo)}>
+                  {!childIsFullWidth ? <Td /> : null}
+                  {repo.details.detail1 ? (
+                    <Td dataLabel="Repo detail 1" noPadding={childHasNoPadding} colSpan={detail1Colspan}>
+                      <ExpandableRowContent>{repo.details.detail1}</ExpandableRowContent>
+                    </Td>
+                  ) : null}
+                  {repo.details.detail2 ? (
+                    <Td dataLabel="Repo detail 2" noPadding={childHasNoPadding} colSpan={detail2Colspan}>
+                      <ExpandableRowContent>{repo.details.detail2}</ExpandableRowContent>
+                    </Td>
+                  ) : null}
+                  {repo.details.detail3 ? (
+                    <Td dataLabel="Repo detail 3" noPadding={childHasNoPadding} colSpan={detail3Colspan}>
+                      <ExpandableRowContent>{repo.details.detail3}</ExpandableRowContent>
+                    </Td>
+                  ) : null}
+                </Tr>
+              ) : null}
+            </Tbody>
+          );
+        })}
+      </TableComposable>
+    </React.Fragment>
+  );
+};

package/src/components/TableComposable/examples/ComposableTableStripedMultipleTbody.tsx

@@ -0,0 +1,120 @@
+import React from 'react';
+import { TableComposable, Caption, Thead, Tr, Th, Tbody, Td } from '@patternfly/react-table';
+
+interface Repository {
+  name: string;
+  branches: number;
+  description?: string;
+  prs: number;
+  workspaces: number;
+  lastCommit: string;
+}
+
+export const ComposableTableStripedMultipleTbody: React.FunctionComponent = () => {
+  // In real usage, this data would come from some external source like an API via props.
+  const repositories1: Repository[] = [
+    {
+      name: 'tbody 1 - Repository 1',
+      description: '(odd rows striped)',
+      branches: 10,
+      prs: 25,
+      workspaces: 5,
+      lastCommit: '2 days ago'
+    },
+    { name: 'tbody 1 - Repository 2', branches: 10, prs: 25, workspaces: 5, lastCommit: '2 days ago' },
+    {
+      name: 'tbody 1 - Repository 3',
+      description: '(odd rows striped)',
+      branches: 10,
+      prs: 25,
+      workspaces: 5,
+      lastCommit: '2 days ago'
+    }
+  ];
+
+  const repositories2: Repository[] = [
+    { name: 'tbody 2 - Repository 4', branches: 10, prs: 25, workspaces: 5, lastCommit: '2 days ago' },
+    {
+      name: 'tbody 2 - Repository 5',
+      description: '(even rows striped)',
+      branches: 10,
+      prs: 25,
+      workspaces: 5,
+      lastCommit: '2 days ago'
+    },
+    { name: 'tbody 2 - Repository 6', branches: 10, prs: 25, workspaces: 5, lastCommit: '2 days ago' },
+    {
+      name: 'tbody 2 - Repository 7',
+      description: '(even rows striped)',
+      branches: 10,
+      prs: 25,
+      workspaces: 5,
+      lastCommit: '2 days ago'
+    }
+  ];
+
+  const columnNames = {
+    name: 'Repositories',
+    branches: 'Branches',
+    prs: 'Pull requests',
+    workspaces: 'Workspaces',
+    lastCommit: 'Last commit'
+  };
+
+  return (
+    <TableComposable aria-label="Simple table">
+      <Caption>Striped table using multiple tbody components</Caption>
+      <Thead>
+        <Tr>
+          <Th>{columnNames.name}</Th>
+          <Th>{columnNames.branches}</Th>
+          <Th>{columnNames.prs}</Th>
+          <Th>{columnNames.workspaces}</Th>
+          <Th>{columnNames.lastCommit}</Th>
+        </Tr>
+      </Thead>
+      <Tbody isOddStriped>
+        {repositories1.map(repo => (
+          <Tr key={repo.name}>
+            <Td dataLabel={columnNames.name}>
+              {repo.description ? (
+                <React.Fragment>
+                  {repo.name}
+                  <br />
+                  <small>{repo.description}</small>
+                </React.Fragment>
+              ) : (
+                repo.name
+              )}
+            </Td>
+            <Td dataLabel={columnNames.branches}>{repo.branches}</Td>
+            <Td dataLabel={columnNames.prs}>{repo.prs}</Td>
+            <Td dataLabel={columnNames.workspaces}>{repo.workspaces}</Td>
+            <Td dataLabel={columnNames.lastCommit}>{repo.lastCommit}</Td>
+          </Tr>
+        ))}
+      </Tbody>
+      <Tbody isEvenStriped>
+        {repositories2.map(repo => (
+          <Tr key={repo.name}>
+            <Td dataLabel={columnNames.name}>
+              {repo.description ? (
+                <React.Fragment>
+                  {repo.name}
+                  <br />
+                  <small>{repo.description}</small>
+                </React.Fragment>
+              ) : (
+                repo.name
+              )}
+            </Td>
+            <Td dataLabel={columnNames.branches}>{repo.branches}</Td>
+            <Td dataLabel={columnNames.prs}>{repo.prs}</Td>
+            <Td dataLabel={columnNames.workspaces}>{repo.workspaces}</Td>
+            <Td dataLabel={columnNames.lastCommit}>{repo.lastCommit}</Td>
+          </Tr>
+        ))}
+      </Tbody>
+    </TableComposable>
+  );
+};

package/src/components/TableComposable/examples/ComposableTableStripedTr.tsx

@@ -0,0 +1,54 @@
+import React from 'react';
+import { TableComposable, Caption, Thead, Tr, Th, Tbody, Td } from '@patternfly/react-table';
+
+interface Repository {
+  name: string;
+  branches: number;
+  prs: number;
+  workspaces: number;
+  lastCommit: string;
+}
+
+export const ComposableTableStripedTr: React.FunctionComponent = () => {
+  // In real usage, this data would come from some external source like an API via props.
+  const repositories: Repository[] = [
+    { name: 'Repository 1', branches: 10, prs: 25, workspaces: 5, lastCommit: '2 days ago' },
+    { name: 'Repository 2', branches: 10, prs: 25, workspaces: 5, lastCommit: '2 days ago' },
+    { name: 'Repository 3', branches: 10, prs: 25, workspaces: 5, lastCommit: '2 days ago' },
+    { name: 'Repository 4', branches: 10, prs: 25, workspaces: 5, lastCommit: '2 days ago' }
+  ];
+
+  const columnNames = {
+    name: 'Repositories',
+    branches: 'Branches',
+    prs: 'Pull requests',
+    workspaces: 'Workspaces',
+    lastCommit: 'Last commit'
+  };
+
+  return (
+    <TableComposable aria-label="Simple table">
+      <Caption>Manually striped table using composable components</Caption>
+      <Thead>
+        <Tr>
+          <Th>{columnNames.name}</Th>
+          <Th>{columnNames.branches}</Th>
+          <Th>{columnNames.prs}</Th>
+          <Th>{columnNames.workspaces}</Th>
+          <Th>{columnNames.lastCommit}</Th>
+        </Tr>
+      </Thead>
+      <Tbody>
+        {repositories.map((repo, index) => (
+          <Tr key={repo.name} {...(index % 2 === 0 && { isStriped: true })}>
+            <Td dataLabel={columnNames.name}>{repo.name}</Td>
+            <Td dataLabel={columnNames.branches}>{repo.branches}</Td>
+            <Td dataLabel={columnNames.prs}>{repo.prs}</Td>
+            <Td dataLabel={columnNames.workspaces}>{repo.workspaces}</Td>
+            <Td dataLabel={columnNames.lastCommit}>{repo.lastCommit}</Td>
+          </Tr>
+        ))}
+      </Tbody>
+    </TableComposable>
+  );
+};

package/src/demos/Table.md

@@ -2234,11 +2234,11 @@ class FilterTableDemo extends React.Component {
         }
       ];
     }
-
+    const onSelect = loading || filteredRows.length === 0 ? null : this.onRowSelect; // To remove the select box when there are no rows
     return (
       <React.Fragment>
         {this.renderToolbar()}
-        <Table cells={columns} rows={tableRows} onSelect={this.onRowSelect} aria-label="Filterable Table Demo">
+        <Table cells={columns} rows={tableRows} onSelect={onSelect} aria-label="Filterable Table Demo">
           <TableHeader />
           <TableBody />
         </Table>