-
Notifications
You must be signed in to change notification settings - Fork 156
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Table grid navigation (no integration) (#1389)
- Loading branch information
Showing
19 changed files
with
1,424 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,273 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| import React, { useContext, useMemo, useRef, useState } from 'react'; | ||
| import SpaceBetween from '~components/space-between'; | ||
| import { | ||
| AppLayout, | ||
| Button, | ||
| ColumnLayout, | ||
| Container, | ||
| ContentLayout, | ||
| FormField, | ||
| Header, | ||
| HelpPanel, | ||
| Icon, | ||
| Input, | ||
| Link, | ||
| SegmentedControl, | ||
| } from '~components'; | ||
| import styles from './styles.scss'; | ||
| import { id as generateId, generateItems, Instance } from '../table/generate-data'; | ||
| import AppContext, { AppContextType } from '../app/app-context'; | ||
| import { | ||
| getTableCellRoleProps, | ||
| getTableColHeaderRoleProps, | ||
| getTableHeaderRowRoleProps, | ||
| getTableRoleProps, | ||
| getTableRowRoleProps, | ||
| getTableWrapperRoleProps, | ||
| useGridNavigation, | ||
| } from '~components/table/table-role'; | ||
| import { orderBy } from 'lodash'; | ||
| import appLayoutLabels from '../app-layout/utils/labels'; | ||
|
|
||
| type PageContext = React.Context< | ||
| AppContextType<{ | ||
| pageSize: number; | ||
| }> | ||
| >; | ||
|
|
||
| const createColumnDefinitions = ({ | ||
| onDelete, | ||
| onDuplicate, | ||
| onUpdate, | ||
| }: { | ||
| onDelete: (id: string) => void; | ||
| onDuplicate: (id: string) => void; | ||
| onUpdate: (id: string) => void; | ||
| }) => [ | ||
| { | ||
| key: 'id', | ||
| label: 'ID', | ||
| render: (item: Instance) => item.id, | ||
| }, | ||
| { | ||
| key: 'actions', | ||
| label: 'Actions', | ||
| render: (item: Instance) => ( | ||
| <div style={{ display: 'flex', gap: '8px', flexWrap: 'nowrap' }}> | ||
| <Button variant="inline-icon" iconName="remove" ariaLabel="Delete item" onClick={() => onDelete(item.id)} /> | ||
| <Button variant="inline-icon" iconName="copy" ariaLabel="Duplicate item" onClick={() => onDuplicate(item.id)} /> | ||
| <Button variant="inline-icon" iconName="refresh" ariaLabel="Update item" onClick={() => onUpdate(item.id)} /> | ||
| </div> | ||
| ), | ||
| }, | ||
| { | ||
| key: 'state', | ||
| label: 'State', | ||
| render: (item: Instance) => item.state, | ||
| }, | ||
| { | ||
| key: 'imageId', | ||
| label: 'Image ID', | ||
| render: (item: Instance) => <Link>{item.imageId}</Link>, | ||
| }, | ||
| { | ||
| key: 'state-toggle', | ||
| label: 'State toggle', | ||
| render: (item: Instance) => ( | ||
| <SegmentedControl | ||
| selectedId={item.state === 'RUNNING' || item.state === 'STOPPING' ? 'On' : 'Off'} | ||
| onChange={event => alert(`Changed item state to "${event.detail.selectedId}"`)} | ||
| label="Instance state" | ||
| options={[ | ||
| { text: 'On', id: 'On' }, | ||
| { text: 'Off', id: 'Off' }, | ||
| ]} | ||
| /> | ||
| ), | ||
| isWidget: true, | ||
| }, | ||
| { key: 'dnsName', label: 'DNS name', render: (item: Instance) => item.dnsName ?? '?' }, | ||
| { key: 'dnsName2', label: 'DNS name 2', render: (item: Instance) => (item.dnsName ?? '?') + ':2' }, | ||
| { key: 'dnsName3', label: 'DNS name 3', render: (item: Instance) => (item.dnsName ?? '?') + ':3' }, | ||
| { key: 'type', label: 'Type', render: (item: Instance) => item.type }, | ||
| ]; | ||
|
|
||
| export default function Page() { | ||
| const [toolsOpen, setToolsOpen] = useState(false); | ||
| const { urlParams, setUrlParams } = useContext(AppContext as PageContext); | ||
| const pageSize = urlParams.pageSize ?? 10; | ||
|
|
||
| const [items, setItems] = useState(generateItems(25)); | ||
| const columnDefinitions = useMemo( | ||
| () => | ||
| createColumnDefinitions({ | ||
| onDelete: (id: string) => setItems(prev => prev.filter(item => item.id !== id)), | ||
| onDuplicate: (id: string) => | ||
| setItems(prev => prev.flatMap(item => (item.id !== id ? [item] : [item, { ...item, id: generateId() }]))), | ||
| onUpdate: (id: string) => | ||
| setItems(prev => prev.map(item => (item.id !== id ? item : { ...item, id: generateId() }))), | ||
| }), | ||
| [] | ||
| ); | ||
|
|
||
| const [sortingKey, setSortingKey] = useState<null | string>(null); | ||
| const [sortingDirection, setSortingDirection] = useState<1 | -1>(1); | ||
|
|
||
| const tableRef = useRef<HTMLTableElement>(null); | ||
|
|
||
| const tableRole = 'grid'; | ||
| useGridNavigation({ tableRole, pageSize, getTable: () => tableRef.current }); | ||
|
|
||
| const sortedItems = useMemo(() => { | ||
| if (!sortingKey) { | ||
| return items; | ||
| } | ||
| return orderBy(items, [sortingKey], [sortingDirection === -1 ? 'desc' : 'asc']); | ||
| }, [items, sortingKey, sortingDirection]); | ||
|
|
||
| return ( | ||
| <AppLayout | ||
| ariaLabels={appLayoutLabels} | ||
| contentType="table" | ||
| navigationHide={true} | ||
| toolsOpen={toolsOpen} | ||
| onToolsChange={event => setToolsOpen(event.detail.open)} | ||
| tools={<GridNavigationHelpPanel />} | ||
| content={ | ||
| <ContentLayout header={<Header variant="h1">Grid navigation with a custom table grid</Header>}> | ||
| <Container | ||
| disableContentPaddings={true} | ||
| header={ | ||
| <SpaceBetween size="m"> | ||
| <ColumnLayout columns={3}> | ||
| <FormField label="Page size"> | ||
| <Input | ||
| type="number" | ||
| value={pageSize.toString()} | ||
| onChange={event => setUrlParams({ pageSize: parseInt(event.detail.value) })} | ||
| /> | ||
| </FormField> | ||
| </ColumnLayout> | ||
|
|
||
| <Link onFollow={() => setToolsOpen(true)} data-testid="link-before"> | ||
| How to use grid navigation? | ||
| </Link> | ||
| </SpaceBetween> | ||
| } | ||
| footer={ | ||
| <Link onFollow={() => setToolsOpen(true)} data-testid="link-after"> | ||
| How to use grid navigation? | ||
| </Link> | ||
| } | ||
| > | ||
| <div className={styles['custom-table']} {...getTableWrapperRoleProps({ tableRole, isScrollable: false })}> | ||
| <table | ||
| ref={tableRef} | ||
| className={styles['custom-table-table']} | ||
| {...getTableRoleProps({ tableRole, totalItemsCount: items.length })} | ||
| > | ||
| <thead> | ||
| <tr {...getTableHeaderRowRoleProps({ tableRole })}> | ||
| {columnDefinitions.map((column, colIndex) => ( | ||
| <th | ||
| key={column.key} | ||
| className={styles['custom-table-cell']} | ||
| {...getTableColHeaderRoleProps({ tableRole, colIndex })} | ||
| > | ||
| <div style={{ display: 'flex', gap: '8px', flexWrap: 'nowrap' }}> | ||
| <button | ||
| className={styles['custom-table-sorting-header']} | ||
| onClick={() => { | ||
| if (sortingKey !== column.key) { | ||
| setSortingKey(column.key); | ||
| setSortingDirection(-1); | ||
| } else { | ||
| setSortingDirection(prev => (prev === 1 ? -1 : 1)); | ||
| } | ||
| }} | ||
| > | ||
| {column.label} | ||
| </button> | ||
| {sortingKey === column.key && sortingDirection === -1 && <Icon name="angle-down" />} | ||
| {sortingKey === column.key && sortingDirection === 1 && <Icon name="angle-up" />} | ||
| </div> | ||
| </th> | ||
| ))} | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| {sortedItems.map((item, rowIndex) => ( | ||
| <tr key={item.id} {...getTableRowRoleProps({ tableRole, rowIndex, firstIndex: 0 })}> | ||
| {columnDefinitions.map((column, colIndex) => ( | ||
| <td | ||
| key={column.key} | ||
| className={styles['custom-table-cell']} | ||
| {...getTableCellRoleProps({ tableRole, colIndex })} | ||
| data-widget-cell={column.isWidget} | ||
| > | ||
| {column.render(item)} | ||
| </td> | ||
| ))} | ||
| </tr> | ||
| ))} | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| </Container> | ||
| </ContentLayout> | ||
| } | ||
| /> | ||
| ); | ||
| } | ||
|
|
||
| function GridNavigationHelpPanel() { | ||
| return ( | ||
| <HelpPanel header={<Header variant="h2">Grid navigation</Header>}> | ||
| <p> | ||
| Grid tables offer better efficient navigation for keyboard users. The navigation intercepts keyboard commands to | ||
| focus table cells and focusable cell content using arrow keys and other key combinations. Here is the full list | ||
| of commands to move item focus: | ||
| </p> | ||
| <ul> | ||
| <li> | ||
| <b>Arrow Up</b> (one item up) | ||
| </li> | ||
| <li> | ||
| <b>Arrow Down</b> (one item down) | ||
| </li> | ||
| <li> | ||
| <b>Arrow Left</b> (one item to the left) | ||
| </li> | ||
| <li> | ||
| <b>Arrow Right</b> (one item to the right) | ||
| </li> | ||
| <li> | ||
| <b>Page Up</b> (one page up) | ||
| </li> | ||
| <li> | ||
| <b>Page Down</b> (one page down) | ||
| </li> | ||
| <li> | ||
| <b>Home</b> (to the first item in the row) | ||
| </li> | ||
| <li> | ||
| <b>End</b> (to the last item in the row) | ||
| </li> | ||
| <li> | ||
| <b>Control+Home</b> (to the first item in the grid) | ||
| </li> | ||
| <li> | ||
| <b>Control+End</b> (to the last item in the grid) | ||
| </li> | ||
| <li> | ||
| <b>Enter</b> (to move focus inside widget cell) | ||
| </li> | ||
| <li> | ||
| <b>Escape</b> (to move widget focus back to cell) | ||
| </li> | ||
| </ul> | ||
| </HelpPanel> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.