85 lines
3.1 KiB
Plaintext
85 lines
3.1 KiB
Plaintext
/*
|
|
* Copyright 2020 Adobe. All rights reserved.
|
|
* This file is licensed 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 REPRESENTATIONS
|
|
* OF ANY KIND, either express or implied. See the License for the specific language
|
|
* governing permissions and limitations under the License.
|
|
*/
|
|
|
|
import {chain} from '@react-aria/utils';
|
|
import {DOMAttributes, FocusableElement, RefObject} from '@react-types/shared';
|
|
import {GridCollection, GridNode} from '@react-types/grid';
|
|
import {gridMap} from './utils';
|
|
import {GridState} from '@react-stately/grid';
|
|
import {SelectableItemStates, useSelectableItem} from '@react-aria/selection';
|
|
|
|
export interface GridRowProps<T> {
|
|
/** An object representing the grid row. Contains all the relevant information that makes up the grid row. */
|
|
node: GridNode<T>,
|
|
/** Whether the grid row is contained in a virtual scroller. */
|
|
isVirtualized?: boolean,
|
|
/** Whether selection should occur on press up instead of press down. */
|
|
shouldSelectOnPressUp?: boolean,
|
|
/**
|
|
* Handler that is called when a user performs an action on the row.
|
|
* Please use onCellAction at the collection level instead.
|
|
* @deprecated
|
|
**/
|
|
onAction?: () => void
|
|
}
|
|
|
|
export interface GridRowAria extends SelectableItemStates {
|
|
/** Props for the grid row element. */
|
|
rowProps: DOMAttributes,
|
|
/** Whether the row is currently in a pressed state. */
|
|
isPressed: boolean
|
|
}
|
|
|
|
/**
|
|
* Provides the behavior and accessibility implementation for a row in a grid.
|
|
* @param props - Props for the row.
|
|
* @param state - State of the parent grid, as returned by `useGridState`.
|
|
*/
|
|
export function useGridRow<T, C extends GridCollection<T>, S extends GridState<T, C>>(props: GridRowProps<T>, state: S, ref: RefObject<FocusableElement | null>): GridRowAria {
|
|
let {
|
|
node,
|
|
isVirtualized,
|
|
shouldSelectOnPressUp,
|
|
onAction
|
|
} = props;
|
|
|
|
let {actions, shouldSelectOnPressUp: gridShouldSelectOnPressUp} = gridMap.get(state)!;
|
|
let onRowAction = actions.onRowAction ? () => actions.onRowAction?.(node.key) : onAction;
|
|
let {itemProps, ...states} = useSelectableItem({
|
|
selectionManager: state.selectionManager,
|
|
key: node.key,
|
|
ref,
|
|
isVirtualized,
|
|
shouldSelectOnPressUp: gridShouldSelectOnPressUp || shouldSelectOnPressUp,
|
|
onAction: onRowAction || node?.props?.onAction ? chain(node?.props?.onAction, onRowAction) : undefined,
|
|
isDisabled: state.collection.size === 0
|
|
});
|
|
|
|
let isSelected = state.selectionManager.isSelected(node.key);
|
|
|
|
let rowProps: DOMAttributes = {
|
|
role: 'row',
|
|
'aria-selected': state.selectionManager.selectionMode !== 'none' ? isSelected : undefined,
|
|
'aria-disabled': states.isDisabled || undefined,
|
|
...itemProps
|
|
};
|
|
|
|
if (isVirtualized) {
|
|
rowProps['aria-rowindex'] = node.index + 1; // aria-rowindex is 1 based
|
|
}
|
|
|
|
return {
|
|
rowProps,
|
|
...states
|
|
};
|
|
}
|