Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Data Views][Grid Layout] Adding semantics and basic keyboard navigation #59279

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from
Open

[Data Views][Grid Layout] Adding semantics and basic keyboard navigation #59279

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4363e9
Adding semantics to grid layout
Feb 22, 2024
5c63ecc
Merge branch 'trunk' into 59188/semantics
Mar 12, 2024
6831c19
Adding label and description to grid items
Mar 12, 2024
ce05e15
Refactoring row rendering to prevent layout changes
Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions packages/dataviews/src/style.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,24 +243,31 @@
}

.dataviews-view-grid {
margin-bottom: $grid-unit-30;
grid-template-columns: repeat(2, minmax(0, 1fr)) !important;
grid-template-rows: max-content;
padding: 0 $grid-unit-40;
margin: 0 $grid-unit-40 $grid-unit-30;
position: relative;

@include break-xlarge() {
grid-template-columns: repeat(3, minmax(0, 1fr)) !important; // Todo: eliminate !important dependency
.dataviews-view-grid__rows {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(17em, 1fr));
grid-template-rows: max-content;
gap: 1em;
}

@include break-huge() {
grid-template-columns: repeat(4, minmax(0, 1fr)) !important; // Todo: eliminate !important dependency
.dataviews-view-grid__row {
display: contents;
}

.dataviews-view-grid__card {
border-radius: $radius-block-ui * 2;
border: 1px solid $gray-200;
height: 100%;
justify-content: flex-start;
scroll-margin-top: 5em;
max-width: 26em;

&:focus-visible {
box-shadow: 0 0 0 var(--wp-admin-border-width-focus) var(--wp-admin-theme-color);
}

.dataviews-view-grid__title-actions {
padding: $grid-unit-05 $grid-unit $grid-unit-05 $grid-unit-05;
Expand Down
194 changes: 157 additions & 37 deletions packages/dataviews/src/view-grid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,123 @@ import classnames from 'classnames';
* WordPress dependencies
*/
import {
__experimentalGrid as Grid,
__experimentalHStack as HStack,
__experimentalVStack as VStack,
privateApis as componentsPrivateApis,
Tooltip,
} from '@wordpress/components';
import { __ } from '@wordpress/i18n';
import { useAsyncList } from '@wordpress/compose';
import { useState } from '@wordpress/element';
import {
useAsyncList,
useInstanceId,
useResizeObserver,
} from '@wordpress/compose';
import {
createContext,
useContext,
useEffect,
useMemo,
useRef,
useState,
} from '@wordpress/element';
import { __, isRTL } from '@wordpress/i18n';
import { isAppleOS } from '@wordpress/keycodes';

/**
* Internal dependencies
*/
import { unlock } from './lock-unlock';
import ItemActions from './item-actions';
import SingleSelectionCheckbox from './single-selection-checkbox';

const {
useCompositeStoreV2: useCompositeStore,
CompositeV2: Composite,
CompositeItemV2: CompositeItem,
CompositeRowV2: CompositeRow,
} = unlock( componentsPrivateApis );

const GridContext = createContext( {} );

function Grid( { id, children, ...gridProps } ) {
const baseId = useInstanceId( Grid, 'view-grid', id );
const gridRef = useRef( null );
const store = useCompositeStore( {
focusWrap: 'horizontal',
rtl: isRTL(),
} );
const context = useMemo(
() => ( { ...store, baseId } ),
[ store, baseId ]
);

return (
<Composite
id={ baseId }
ref={ gridRef }
role="grid"
store={ store }
{ ...gridProps }
>
<GridContext.Provider value={ context }>
<GridRows baseId={ baseId } gridRef={ gridRef }>
{ children }
</GridRows>
</GridContext.Provider>
</Composite>
);
}

function GridRows( { baseId, gridRef, children } ) {
const [ columnCount, setColumnCount ] = useState( children?.length || 1 );
const [ resizeListener, { width: totalWidth } ] = useResizeObserver();

const referenceCell =
gridRef?.current?.querySelector( '[role="gridcell"]' ) || {};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of querying the DOM, would it make sense to add a ref in Grid component and then do something like: getComputedStyle(gridRef.current)?.getPropertyValue('grid-template-columns')? Then we could derive the column count.

const { offsetWidth: columnWidth = totalWidth } = referenceCell;

useEffect( () => {
if ( columnWidth && totalWidth ) {
setColumnCount(
Math.max( 1, Math.floor( totalWidth / columnWidth ) )
);
}
}, [ columnWidth, totalWidth ] );

const rows = useMemo(
() =>
Array.from(
{ length: Math.ceil( children?.length / columnCount ) },
( _, index ) =>
children.slice(
index * columnCount,
( index + 1 ) * columnCount
)
),
[ children, columnCount ]
);

return useMemo(
() => (
<>
{ resizeListener }
<div className="dataviews-view-grid__rows">
{ rows.map( ( row, index ) => (
<CompositeRow
className="dataviews-view-grid__row"
role="row"
id={ `${ baseId }-row-${ index }` }
key={ `${ baseId }-row-${ index }` }
>
{ row }
</CompositeRow>
) ) }
</div>
</>
),
[ baseId, resizeListener, rows ]
);
}

function GridItem( {
selection,
data,
Expand All @@ -34,39 +136,63 @@ function GridItem( {
visibleFields,
} ) {
const [ hasNoPointerEvents, setHasNoPointerEvents ] = useState( false );
const id = getItemId( item );
const isSelected = selection.includes( id );
const itemRef = useRef( null );
const { baseId, move, next, previous, up, down } =
useContext( GridContext );
const itemId = getItemId( item );
const id = `${ baseId }-item-${ itemId }`;
const isSelected = selection.includes( itemId );
const rtl = isRTL();
const movementMap = useMemo(
() =>
new Map( [
[ 'ArrowUp', up ],
[ 'ArrowDown', down ],
[ 'ArrowLeft', rtl ? next : previous ],
[ 'ArrowRight', rtl ? previous : next ],
] ),
[ down, next, previous, rtl, up ]
);

return (
<VStack
<CompositeItem
ref={ itemRef }
render={ <VStack /> }
spacing={ 0 }
key={ id }
key={ itemId }
id={ id }
role="gridcell"
aria-label={ primaryField?.getValue( { item } ) }
className={ classnames( 'dataviews-view-grid__card', {
'is-selected': isSelected,
'has-no-pointer-events': hasNoPointerEvents,
} ) }
onMouseDown={ ( event ) => {
if ( event.ctrlKey || event.metaKey ) {
if ( event.defaultPrevented ) return;

if ( isAppleOS() ? event.ctrlKey : event.metaKey ) {
setHasNoPointerEvents( true );
if ( ! isSelected ) {
onSelectionChange(
data.filter( ( _item ) => {
const itemId = getItemId?.( _item );
return (
itemId === id ||
selection.includes( itemId )
);
} )
);
} else {
onSelectionChange(
data.filter( ( _item ) => {
const itemId = getItemId?.( _item );
return (
itemId !== id &&
selection.includes( itemId )
);
} )
);
const setAsSelected = ! isSelected;
const selectedData = data.filter( ( _item ) => {
const _itemId = getItemId?.( _item );
const currentlyIncluded = selection.includes( _itemId );
return setAsSelected
? itemId === _itemId || currentlyIncluded
: itemId !== _itemId && currentlyIncluded;
} );
onSelectionChange( selectedData );
}
} }
onKeyDown={ ( event ) => {
if ( event.defaultPrevented ) return;

const { target, currentTarget, key } = event;

if ( target !== currentTarget ) {
if ( movementMap.has( key ) ) {
move( movementMap.get( key )() || id );
} else if ( key === 'Escape' ) {
move( id );
}
}
} }
Expand Down Expand Up @@ -120,7 +246,7 @@ function GridItem( {
);
} ) }
</VStack>
</VStack>
</CompositeItem>
);
}

Expand Down Expand Up @@ -154,13 +280,7 @@ export default function ViewGrid( {
return (
<>
{ hasData && (
<Grid
gap={ 6 }
columns={ 2 }
alignment="top"
className="dataviews-view-grid"
aria-busy={ isLoading }
>
<Grid className="dataviews-view-grid" aria-busy={ isLoading }>
{ usedData.map( ( item ) => {
return (
<GridItem
Expand Down
Loading