Table Column Resize via screen readers #3295
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -12,47 +12,52 @@ | |
|
|
||
| import {DOMAttributes} from '@react-types/shared'; | ||
| import {focusSafely} from '@react-aria/focus'; | ||
| import {focusWithoutScrolling, mergeProps, useGlobalListeners, useId} from '@react-aria/utils'; | ||
| import {getColumnHeaderId} from './utils'; | ||
| import {GridNode} from '@react-types/grid'; | ||
| // @ts-ignore | ||
| import intlMessages from '../intl/*.json'; | ||
| import React, {ChangeEvent, RefObject, useCallback, useRef} from 'react'; | ||
| import {TableColumnResizeState, TableState} from '@react-stately/table'; | ||
| import {useKeyboard, useMove} from '@react-aria/interactions'; | ||
| import {useLocale, useLocalizedStringFormatter} from '@react-aria/i18n'; | ||
|
|
||
| export interface TableColumnResizeAria { | ||
| inputProps: DOMAttributes, | ||
| resizerProps: DOMAttributes | ||
| } | ||
|
|
||
| export interface AriaTableColumnResizeProps<T> { | ||
| column: GridNode<T>, | ||
| label: string, | ||
| triggerRef: RefObject<HTMLDivElement> | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
LFDanLu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| export function useTableColumnResize<T>(props: AriaTableColumnResizeProps<T>, state: TableState<T>, columnState: TableColumnResizeState<T>, ref: RefObject<HTMLInputElement>): TableColumnResizeAria { | ||
| let {column: item, triggerRef} = props; | ||
| const stateRef = useRef<TableColumnResizeState<T>>(null); | ||
| // keep track of what the cursor on the body is so it can be restored back to that when done resizing | ||
| const cursor = useRef<string | null>(null); | ||
| stateRef.current = columnState; | ||
| const stringFormatter = useLocalizedStringFormatter(intlMessages); | ||
| let {addGlobalListener, removeGlobalListener} = useGlobalListeners(); | ||
| let id = useId(); | ||
|
|
||
| let {direction} = useLocale(); | ||
| let {keyboardProps} = useKeyboard({ | ||
| onKeyDown: (e) => { | ||
| if (e.key === 'Escape' || e.key === 'Enter' || e.key === ' ' || e.key === 'Tab') { | ||
| e.preventDefault(); | ||
| // switch focus back to the column header on anything that ends edit mode | ||
| focusSafely(triggerRef.current); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| const columnResizeWidthRef = useRef<number>(0); | ||
| const {moveProps} = useMove({ | ||
| onMoveStart() { | ||
| columnResizeWidthRef.current = stateRef.current.getColumnWidth(item.key); | ||
| cursor.current = document.body.style.cursor; | ||
| }, | ||
|
|
@@ -76,45 +81,109 @@ export function useTableColumnResize<T>(props: AriaTableColumnResizeProps<T>, st | |
| } | ||
| } | ||
| }, | ||
| onMoveEnd() { | ||
| columnResizeWidthRef.current = 0; | ||
| document.body.style.cursor = cursor.current; | ||
| } | ||
| }); | ||
| let min = Math.floor(stateRef.current.getColumnMinWidth(item.key)); | ||
| let max = Math.floor(stateRef.current.getColumnMaxWidth(item.key)); | ||
| if (max === Infinity) { | ||
| max = Number.MAX_SAFE_INTEGER; | ||
| } | ||
| let value = Math.floor(stateRef.current.getColumnWidth(item.key)); | ||
|
|
||
| let ariaProps = { | ||
| 'aria-label': props.label, | ||
| 'aria-orientation': 'horizontal' as 'horizontal', | ||
| 'aria-labelledby': `${id} ${getColumnHeaderId(state, item.key)}`, | ||
| 'aria-valuetext': stringFormatter.format('columnSize', {value}), | ||
| min, | ||
| max, | ||
| value | ||
| }; | ||
|
|
||
| const focusInput = useCallback(() => { | ||
| if (ref.current) { | ||
| focusWithoutScrolling(ref.current); | ||
| } | ||
| }, [ref]); | ||
|
|
||
| let onChange = (e: ChangeEvent<HTMLInputElement>) => { | ||
| let currentWidth = stateRef.current.getColumnWidth(item.key); | ||
| let nextValue = parseFloat(e.target.value); | ||
|
|
||
| if (nextValue > currentWidth) { | ||
| nextValue = currentWidth + 10; | ||
snowystinger marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } else { | ||
| nextValue = currentWidth - 10; | ||
|
|
||
snowystinger marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
| stateRef.current.onColumnResize(item, nextValue); | ||
| }; | ||
|
|
||
| let onDown = () => { | ||
| focusInput(); | ||
LFDanLu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| addGlobalListener(window, 'mouseup', onPointerUp, false); | ||
| addGlobalListener(window, 'touchend', onUp, false); | ||
| addGlobalListener(window, 'pointerup', onPointerUp, false); | ||
| }; | ||
|
|
||
| let onPointerUp = (e) => { | ||
| // don't hide the resizer for touch since it's harder to bring back | ||
| if (e.pointerType === 'touch') { | ||
| focusInput(); | ||
| } else { | ||
| focusSafely(triggerRef.current); | ||
| } | ||
| removeGlobalListener(window, 'mouseup', onPointerUp, false); | ||
| removeGlobalListener(window, 'touchend', onUp, false); | ||
| removeGlobalListener(window, 'pointerup', onPointerUp, false); | ||
| }; | ||
|
|
||
| let onUp = () => { | ||
| focusInput(); | ||
| removeGlobalListener(window, 'mouseup', onPointerUp, false); | ||
| removeGlobalListener(window, 'touchend', onUp, false); | ||
| removeGlobalListener(window, 'pointerup', onPointerUp, false); | ||
| }; | ||
|
|
||
| return { | ||
| resizerProps: mergeProps( | ||
| keyboardProps, | ||
| moveProps, | ||
| { | ||
| onMouseDown: (e: React.MouseEvent<HTMLElement>) => { | ||
| if (e.button !== 0 || e.altKey || e.ctrlKey || e.metaKey) { | ||
| return; | ||
| } | ||
| onDown(); | ||
|
||
| }, | ||
| onPointerDown: (e: React.PointerEvent<HTMLElement>) => { | ||
| if (e.button !== 0 || e.altKey || e.ctrlKey || e.metaKey) { | ||
| return; | ||
| } | ||
| onDown(); | ||
| }, | ||
| onTouchStart: () => {onDown();} | ||
| } | ||
| ), | ||
| inputProps: mergeProps( | ||
| { | ||
| id, | ||
| onFocus: () => { | ||
| // useMove calls onMoveStart for every keypress, but we want resize start to only be called when we start resize mode | ||
| // call instead during focus and blur | ||
| stateRef.current.onColumnResizeStart(item); | ||
| state.setKeyboardNavigationDisabled(true); | ||
| }, | ||
| onBlur: () => { | ||
| stateRef.current.onColumnResizeEnd(item); | ||
| state.setKeyboardNavigationDisabled(false); | ||
| }, | ||
| onChange | ||
| }, | ||
| ariaProps | ||
| ) | ||
| }; | ||
| } | ||
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.