Skip to content

feat: add helper types to assist DOM element handling #24722

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
bsunderhus merged 1 commit into from
Sep 9, 2022
Merged

feat: add helper types to assist DOM element handling #24722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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-aria-4fd3fe1f-3f59-48b1-acab-2e459a62c03d.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 helper types to assist DOM element handling",
"packageName": "@fluentui/react-aria",
"email": "bernardo.sunderhus@gmail.com",
"dependentChangeType": "patch"
}
6 changes: 6 additions & 0 deletions packages/react-components/react-aria/etc/react-aria.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ import * as React_2 from 'react';
import type { ResolveShorthandFunction } from '@fluentui/react-utilities';
import type { Slot } from '@fluentui/react-utilities';

// @internal (undocumented)
export type ARIAButtonElement<AlternateAs extends 'a' | 'div' = 'a' | 'div'> = HTMLButtonElement | (AlternateAs extends 'a' ? HTMLAnchorElement : never) | (AlternateAs extends 'div' ? HTMLDivElement : never);

// @internal (undocumented)
export type ARIAButtonElementIntersection<AlternateAs extends 'a' | 'div' = 'a' | 'div'> = UnionToIntersection<ARIAButtonElement<AlternateAs>>;

// @public
export type ARIAButtonProps<Type extends ARIAButtonType = ARIAButtonType> = React_2.PropsWithRef<JSX.IntrinsicElements[Type]> & {
disabled?: boolean;
Expand Down
19 changes: 17 additions & 2 deletions packages/react-components/react-aria/src/hooks/useARIAButton/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
import type { ExtractSlotProps, Slot } from '@fluentui/react-utilities';
import * as React from 'react';

type UnionToIntersection<U> = (U extends unknown ? (x: U) => U : never) extends (x: infer I) => U ? I : never;

export type ARIAButtonType = 'button' | 'a' | 'div';

/**
* @internal
*/
export type ARIAButtonElement<AlternateAs extends 'a' | 'div' = 'a' | 'div'> =
| HTMLButtonElement
| (AlternateAs extends 'a' ? HTMLAnchorElement : never)
| (AlternateAs extends 'div' ? HTMLDivElement : never);

/**
* @internal
*/
export type ARIAButtonElementIntersection<AlternateAs extends 'a' | 'div' = 'a' | 'div'> = UnionToIntersection<
ARIAButtonElement<AlternateAs>
>;

/**
* Props expected by `useARIAButtonProps` hooks
*/
Expand Down Expand Up @@ -48,8 +65,6 @@ export type ARIAButtonAlteredProps<Type extends ARIAButtonType> =
? Pick<JSX.IntrinsicElements['div'], 'onClick' | 'onKeyDown' | 'onKeyUp' | 'aria-disabled' | 'tabIndex' | 'role'>
: never);

type UnionToIntersection<U> = (U extends unknown ? (x: U) => U : never) extends (x: infer I) => U ? I : never;

/**
* Merge of props provided by the user and props provided internally.
*/
Expand Down
2 changes: 2 additions & 0 deletions packages/react-components/react-aria/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ export type {
ARIAButtonProps,
ARIAButtonResultProps,
ARIAButtonType,
ARIAButtonElement,
ARIAButtonElementIntersection,
} from './hooks/useARIAButton/index';