Skip to content

feat(react-tabster): add unstable_hasDefault option on useArrowNavigationGroup #26732

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

Merged
YuanboXue-Amber merged 6 commits into from
Feb 7, 2023
Merged

feat(react-tabster): add unstable_hasDefault option on useArrowNavigationGroup #26732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9057764
hasDefault
YuanboXue-Amber Feb 7, 2023
6961b42
unstable
YuanboXue-Amber Feb 7, 2023
a2a1aee
test
YuanboXue-Amber Feb 7, 2023
ce8de68
Revert "test"
YuanboXue-Amber Feb 7, 2023
2dedf0c
update
YuanboXue-Amber Feb 7, 2023
44dcd19
add slash in comment
YuanboXue-Amber Feb 7, 2023
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
7 changes: 7 additions & 0 deletions change/@fluentui-react-tabster-8a739d1e-a76c-4604-90e3-5ddb2d3da5fa.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "feat: add `unstable_hasDefault` option in `useArrowNavigationGroup` that specifies the arrow navigation group has default focusable item",
"packageName": "@fluentui/react-tabster",
"email": "[email protected]",
"dependentChangeType": "patch"
}
1 change: 1 addition & 0 deletions packages/react-components/react-tabster/etc/react-tabster.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export interface UseArrowNavigationGroupOptions {
ignoreDefaultKeydown?: Types.FocusableProps['ignoreKeydown'];
memorizeCurrent?: boolean;
tabbable?: boolean;
unstable_hasDefault?: boolean;
}

// @public
Expand Down
22 changes: 19 additions & 3 deletions packages/react-components/react-tabster/src/hooks/useArrowNavigationGroup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,29 @@ export interface UseArrowNavigationGroupOptions {
* Tabster should ignore default handling of keydown events
*/
ignoreDefaultKeydown?: Types.FocusableProps['ignoreKeydown'];
/**
* The default focusable item in the group will be an element with Focusable.isDefault property.
* Note that there is no way in \@fluentui/react-tabster to set default focusable element,
* and this option is currently for internal testing purposes only.
*/
// eslint-disable-next-line @typescript-eslint/naming-convention
unstable_hasDefault?: boolean;
}

/**
* A hook that returns the necessary tabster attributes to support arrow key navigation
* @param options - Options to configure keyboard navigation
*/
export const useArrowNavigationGroup = (options: UseArrowNavigationGroupOptions = {}): Types.TabsterDOMAttribute => {
const { circular, axis, memorizeCurrent, tabbable, ignoreDefaultKeydown } = options;
const {
circular,
axis,
memorizeCurrent,
tabbable,
ignoreDefaultKeydown,
// eslint-disable-next-line @typescript-eslint/naming-convention
unstable_hasDefault,
} = options;
const tabster = useTabster();

if (tabster) {
Expand All @@ -43,8 +58,9 @@ export const useArrowNavigationGroup = (options: UseArrowNavigationGroupOptions
mover: {
cyclic: !!circular,
direction: axisToMoverDirection(axis ?? 'vertical'),
memorizeCurrent: memorizeCurrent,
tabbable: tabbable,
memorizeCurrent,
tabbable,
hasDefault: unstable_hasDefault,
},
...(ignoreDefaultKeydown && {
focusable: {
Expand Down