forked from apache/airflow
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated table component (apache#15805)
* use react-table for table data * add skeleton loader to table * refactor loading data * UI pagination * server-side pagination * componentize custom react table * fix placeholder switch * add test that errors are rendered * Update airflow/ui/src/interfaces/react-table-config.d.ts remove extraneous comment Co-authored-by: Ash Berlin-Taylor <[email protected]> * Update airflow/ui/src/components/Table.tsx Co-authored-by: Ryan Hamilton <[email protected]> * update sort icons and pagination display Co-authored-by: Ash Berlin-Taylor <[email protected]> Co-authored-by: Ryan Hamilton <[email protected]>
- Loading branch information
3 people
authored
May 27, 2021
1 parent
65519ab
commit 2c6b003
Showing
8 changed files
with
531 additions
and
125 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
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,187 @@ | ||
| /*! | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this 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. | ||
| */ | ||
|
|
||
| /* | ||
| * Custom wrapper of react-table using Chakra UI components | ||
| */ | ||
|
|
||
| import React, { useEffect } from 'react'; | ||
| import { | ||
| Flex, | ||
| Table as ChakraTable, | ||
| Thead, | ||
| Tbody, | ||
| Tr, | ||
| Th, | ||
| Td, | ||
| IconButton, | ||
| Text, | ||
| useColorModeValue, | ||
| } from '@chakra-ui/react'; | ||
| import { | ||
| useTable, useSortBy, Column, usePagination, SortingRule, | ||
| } from 'react-table'; | ||
| import { | ||
| MdKeyboardArrowLeft, MdKeyboardArrowRight, | ||
| } from 'react-icons/md'; | ||
| import { | ||
| TiArrowUnsorted, TiArrowSortedDown, TiArrowSortedUp, | ||
| } from 'react-icons/ti'; | ||
|
|
||
| interface Props { | ||
| data: any[]; | ||
| columns: Column<any>[]; | ||
| /* | ||
| * manualPagination is when you need to do server-side pagination. | ||
| * Leave blank for client-side only | ||
| */ | ||
| manualPagination?: { | ||
| offset: number; | ||
| setOffset: (off: number) => void; | ||
| totalEntries: number; | ||
| }; | ||
| /* | ||
| * setSortBy is for custom sorting such as server-side sorting | ||
| */ | ||
| setSortBy?: (sortBy: SortingRule<object>[]) => void; | ||
| pageSize?: number; | ||
| } | ||
|
|
||
| const Table: React.FC<Props> = ({ | ||
| data, columns, manualPagination, pageSize = 25, setSortBy, | ||
| }) => { | ||
| const { totalEntries, offset, setOffset } = manualPagination || {}; | ||
| const oddColor = useColorModeValue('gray.50', 'gray.900'); | ||
| const hoverColor = useColorModeValue('gray.100', 'gray.700'); | ||
|
|
||
| const pageCount = totalEntries ? (Math.ceil(totalEntries / pageSize) || 1) : data.length; | ||
|
|
||
| const lowerCount = (offset || 0) + 1; | ||
| const upperCount = lowerCount + data.length - 1; | ||
|
|
||
| const { | ||
| getTableProps, | ||
| getTableBodyProps, | ||
| allColumns, | ||
| prepareRow, | ||
| page, | ||
| canPreviousPage, | ||
| canNextPage, | ||
| nextPage, | ||
| previousPage, | ||
| state: { pageIndex, sortBy }, | ||
| } = useTable( | ||
| { | ||
| columns, | ||
| data, | ||
| pageCount, | ||
| manualPagination: !!manualPagination, | ||
| manualSortBy: !!setSortBy, | ||
| initialState: { | ||
| pageIndex: offset ? offset / pageSize : 0, | ||
| pageSize, | ||
| }, | ||
| }, | ||
| useSortBy, | ||
| usePagination, | ||
| ); | ||
|
|
||
| const handleNext = () => { | ||
| nextPage(); | ||
| if (setOffset) setOffset((pageIndex + 1) * pageSize); | ||
| }; | ||
|
|
||
| const handlePrevious = () => { | ||
| previousPage(); | ||
| if (setOffset) setOffset((pageIndex - 1 || 0) * pageSize); | ||
| }; | ||
|
|
||
| useEffect(() => { | ||
| if (setSortBy) setSortBy(sortBy); | ||
| }, [sortBy, setSortBy]); | ||
|
|
||
| return ( | ||
| <> | ||
| <ChakraTable {...getTableProps()}> | ||
| <Thead> | ||
| <Tr> | ||
| {allColumns.map((column) => ( | ||
| <Th | ||
| {...column.getHeaderProps(column.getSortByToggleProps())} | ||
| > | ||
| {column.render('Header')} | ||
| {column.isSorted && ( | ||
| column.isSortedDesc ? ( | ||
| <TiArrowSortedDown aria-label="sorted descending" style={{ display: 'inline' }} size="1em" /> | ||
| ) : ( | ||
| <TiArrowSortedUp aria-label="sorted ascending" style={{ display: 'inline' }} size="1em" /> | ||
| ) | ||
| )} | ||
| {(!column.isSorted && column.canSort) && (<TiArrowUnsorted aria-label="unsorted" style={{ display: 'inline' }} size="1em" />)} | ||
| </Th> | ||
| ))} | ||
| </Tr> | ||
| </Thead> | ||
| <Tbody {...getTableBodyProps()}> | ||
| {!data.length && ( | ||
| <Tr> | ||
| <Td colSpan={2}>No Data found.</Td> | ||
| </Tr> | ||
| )} | ||
| {page.map((row) => { | ||
| prepareRow(row); | ||
| return ( | ||
| <Tr | ||
| {...row.getRowProps()} | ||
| _odd={{ backgroundColor: oddColor }} | ||
| _hover={{ backgroundColor: hoverColor }} | ||
| > | ||
| {row.cells.map((cell) => ( | ||
| <Td | ||
| {...cell.getCellProps()} | ||
| py={3} | ||
| > | ||
| {cell.render('Cell')} | ||
| </Td> | ||
| ))} | ||
| </Tr> | ||
| ); | ||
| })} | ||
| </Tbody> | ||
| </ChakraTable> | ||
| <Flex alignItems="center" justifyContent="flex-start" my={4}> | ||
| <IconButton variant="ghost" onClick={handlePrevious} disabled={!canPreviousPage} aria-label="Previous Page"> | ||
| <MdKeyboardArrowLeft /> | ||
| </IconButton> | ||
| <IconButton variant="ghost" onClick={handleNext} disabled={!canNextPage} aria-label="Next Page"> | ||
| <MdKeyboardArrowRight /> | ||
| </IconButton> | ||
| <Text> | ||
| {lowerCount} | ||
| - | ||
| {upperCount} | ||
| {' of '} | ||
| {totalEntries} | ||
| </Text> | ||
| </Flex> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export default Table; |
Oops, something went wrong.