index.js
181 lines
| 1 | import { useState } from 'react'; |
| 2 | import PropTypes from 'prop-types'; |
| 3 | import classNames from 'classnames'; |
| 4 | import { LoadingOverlay, Spinner } from '@givewp/components'; |
| 5 | |
| 6 | import styles from './style.module.scss'; |
| 7 | |
| 8 | const { __ } = wp.i18n; |
| 9 | |
| 10 | const Table = ( { title, columns, data, columnFilters, stripped, isLoading, isSorting, ...rest } ) => { |
| 11 | const [ state, setState ] = useState( {} ); |
| 12 | const [ cachedData, setCachedData ] = useState( [] ); |
| 13 | |
| 14 | Table.resetSortState = () => { |
| 15 | setState( {} ); |
| 16 | }; |
| 17 | |
| 18 | // Clear cache if data is empty |
| 19 | if ( ! isLoading && ! data.length && cachedData.length ) { |
| 20 | setCachedData( [] ); |
| 21 | } else if ( data.length && data !== cachedData ) { |
| 22 | // Cache data so we can show that under overlay while new data is fetching |
| 23 | setCachedData( data ); |
| 24 | } |
| 25 | |
| 26 | const visibleColumns = columns.filter( ( column ) => column.visible || column.visible === undefined ); |
| 27 | const allowedColumns = visibleColumns.map( ( column ) => column.key ); |
| 28 | // Get additional row columns added manually |
| 29 | const additionalColumns = visibleColumns |
| 30 | .filter( ( column ) => 'append' in column && column.append ) |
| 31 | .map( ( column ) => { |
| 32 | return { |
| 33 | [ column.key ]: column.defaultValue ?? '', |
| 34 | }; |
| 35 | } ); |
| 36 | |
| 37 | // Used when additional columns are added, but they not exist in the result row. |
| 38 | // So we have to sort result row to match columns order |
| 39 | const sortResults = ( order, object ) => { |
| 40 | const newObject = {}; |
| 41 | |
| 42 | order.forEach( ( key ) => { |
| 43 | newObject[ key ] = object[ key ]; |
| 44 | } ); |
| 45 | return newObject; |
| 46 | }; |
| 47 | |
| 48 | const handleItemSort = ( item ) => { |
| 49 | const direction = ( state[ item.label ] === 'desc' ) ? 'asc' : 'desc'; |
| 50 | |
| 51 | setState( { [ item.label ]: direction } ); |
| 52 | |
| 53 | return item.sortCallback( direction ); |
| 54 | }; |
| 55 | |
| 56 | const getItemSortDirectionIcon = ( item ) => { |
| 57 | if ( ! state[ item.label ] ) { |
| 58 | return <span className={ classNames( 'dashicons dashicons-sort', styles.sortIcons, styles.sortIconUndefined ) } />; |
| 59 | } |
| 60 | |
| 61 | const iconClasses = classNames( |
| 62 | 'dashicons', |
| 63 | styles.sortIcons, |
| 64 | { 'dashicons-arrow-down': state[ item.label ] === 'desc' }, |
| 65 | { 'dashicons-arrow-up': state[ item.label ] === 'asc' }, |
| 66 | ); |
| 67 | |
| 68 | return <span className={ iconClasses } />; |
| 69 | }; |
| 70 | |
| 71 | const getHeaderRow = () => { |
| 72 | return visibleColumns.map( ( item, index ) => { |
| 73 | const columnStyles = ( item.styles ) ? { style: item.styles } : null; |
| 74 | return ( |
| 75 | <div className={ styles.label } key={ index } { ...columnStyles }> |
| 76 | { item.label } |
| 77 | { item.sort && ( typeof item.sortCallback === 'function' ) && ( |
| 78 | <span onClick={ () => handleItemSort( item ) }> |
| 79 | { getItemSortDirectionIcon( item ) } |
| 80 | </span> |
| 81 | ) } |
| 82 | { isLoading && isSorting && state[ item.label ] !== undefined && ( |
| 83 | <Spinner size="tiny" style={ { marginLeft: 10 } } /> |
| 84 | ) } |
| 85 | </div> |
| 86 | ); |
| 87 | } ); |
| 88 | }; |
| 89 | |
| 90 | const getRows = () => { |
| 91 | if ( ! isLoading && data.length === 0 ) { |
| 92 | return ( |
| 93 | <div className={ styles.noData }> |
| 94 | { __( 'No data', 'give' ) } |
| 95 | </div> |
| 96 | ); |
| 97 | } |
| 98 | |
| 99 | if ( cachedData.length && isLoading ) { |
| 100 | data = cachedData; |
| 101 | } |
| 102 | |
| 103 | return data.map( ( row, index ) => { |
| 104 | // Add additional row columns and sort the result row |
| 105 | const result = ( additionalColumns.length > 0 ) ? sortResults( allowedColumns, Object.assign( row, ...additionalColumns ) ) : row; |
| 106 | const RowItems = Object.entries( result ) |
| 107 | // Display only provided columns |
| 108 | .filter( ( [ key ] ) => allowedColumns.includes( key ) ) |
| 109 | .map( ( [ key, value ] ) => { |
| 110 | if ( columnFilters[ key ] && typeof columnFilters[ key ] === 'function' ) { |
| 111 | value = columnFilters[ key ]( value, data[ index ] ); |
| 112 | } |
| 113 | |
| 114 | const currentColumn = visibleColumns.find( ( column ) => column.key === key ); |
| 115 | const columnStyles = ( currentColumn.styles ) ? { style: currentColumn.styles } : null; |
| 116 | |
| 117 | return ( |
| 118 | <div className={ styles.item } key={ key } { ...columnStyles }> |
| 119 | { value } |
| 120 | </div> |
| 121 | ); |
| 122 | } ); |
| 123 | |
| 124 | const rowClasses = classNames( |
| 125 | 'give-table-row', |
| 126 | { [ styles.rowStripped ]: stripped }, |
| 127 | { [ styles.row ]: ! stripped }, |
| 128 | ); |
| 129 | |
| 130 | return ( |
| 131 | <div className={ rowClasses } key={ index }> |
| 132 | { RowItems } |
| 133 | </div> |
| 134 | ); |
| 135 | } ); |
| 136 | }; |
| 137 | |
| 138 | return ( |
| 139 | <> |
| 140 | { isLoading && ! isSorting && ( |
| 141 | <LoadingOverlay spinnerSize="small" /> |
| 142 | ) } |
| 143 | { title && ( <div className={ styles.title }> |
| 144 | { title } |
| 145 | </div> ) } |
| 146 | <div className={ styles.table } { ...rest }> |
| 147 | <div className={ classNames( styles.header, { [ styles.headerStripped ]: stripped } ) }> |
| 148 | { getHeaderRow() } |
| 149 | </div> |
| 150 | { getRows() } |
| 151 | </div> |
| 152 | </> |
| 153 | ); |
| 154 | }; |
| 155 | |
| 156 | Table.propTypes = { |
| 157 | // Table title |
| 158 | title: PropTypes.string, |
| 159 | // Columns to display |
| 160 | columns: PropTypes.array.isRequired, |
| 161 | // Table data rows |
| 162 | data: PropTypes.array.isRequired, |
| 163 | // Column filters |
| 164 | columnFilters: PropTypes.object, |
| 165 | // Stripped rows |
| 166 | stripped: PropTypes.bool, |
| 167 | // Show spinner if data is loading |
| 168 | isLoading: PropTypes.bool, |
| 169 | }; |
| 170 | |
| 171 | Table.defaultProps = { |
| 172 | title: null, |
| 173 | columns: [], |
| 174 | data: [], |
| 175 | columnFilters: {}, |
| 176 | stripped: true, |
| 177 | isLoading: false, |
| 178 | }; |
| 179 | |
| 180 | export default Table; |
| 181 |