fix(react-components): use custom RefAttributes instead of React.RefAttributes #34590
Conversation
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
Hotell
changed the title
📊 Bundle size report✅ No changes found |
|
Pull request demo site: URL |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
change/@fluentui-react-utilities-66a3d122-bdde-45be-a7b3-d6ae2b28a1d6.json
Outdated
Show resolved
Hide resolved
Hotell
force-pushed
the
react-18/ref-attr-usage
branch
from
5e71b4c to
9462a63
Compare
Hotell
commented
Jun 4, 2025
packages/react-components/react-utilities/src/compose/getIntrinsicElementProps.ts
Show resolved
Hide resolved
Hotell
commented
Jun 4, 2025
| @@ -51,6 +51,11 @@ export const CheckboxShim = React.forwardRef((props: ICheckboxProps, _ref: React | |||
| indicator={{ className: mergeClasses('ms-Checkbox-checkbox', styles.checkbox) }} | |||
| /> | |||
| ); | |||
| }); | |||
| // NOTE: cast is necessary as `ICheckboxProps` extends React.Ref<HTMLDivElement> which is not compatible with our defined React.Ref<HTMLInputElement> | |||
| }) as React.ForwardRefExoticComponent< | |||
There was a problem hiding this comment.
unified pattern with the rest of migration code - in this case simple advance declaration wouldn't match because the ref generic mismatch
Hotell
commented
Jun 4, 2025
| @@ -42,7 +42,7 @@ export const brandWeb: BrandVariants; | |||
| export const ButtonShim: React_2.ForwardRefExoticComponent<IBaseButtonProps & React_2.RefAttributes<HTMLButtonElement>>; | |||
|
|
|||
| // @public (undocumented) | |||
| export const CheckboxShim: React_2.ForwardRefExoticComponent<Pick<ICheckboxProps, "label" | "title" | "className" | "key" | "disabled" | "name" | "defaultChecked" | "id" | "onChange" | "componentRef" | "styles" | "theme" | "checked" | "ariaLabel" | "required" | "ariaDescribedBy" | "ariaLabelledBy" | "ariaPositionInSet" | "ariaSetSize" | "boxSide" | "checkmarkIconProps" | "defaultIndeterminate" | "indeterminate" | "inputProps" | "onRenderLabel"> & React_2.RefAttributes<HTMLInputElement>>; | |||
| export const CheckboxShim: React_2.ForwardRefExoticComponent<ICheckboxProps & React_2.RefAttributes<HTMLInputElement>>; | |||
There was a problem hiding this comment.
this is the same API without unwrapping -> result of normalizing patterns and using explicit function types
Hotell
force-pushed
the
react-18/ref-attr-usage
branch
from
34c4a8b to
9f80d96
Compare
Hotell
commented
Jun 6, 2025
| */ | ||
| export const getIntrinsicElementProps = < | ||
| Props extends UnknownSlotProps, | ||
| ExcludedPropKeys extends Extract<keyof Props, string> = never, | ||
| >( | ||
| /** The slot's default element type (e.g. 'div') */ |
There was a problem hiding this comment.
this is invalid "JSDOC" - moved to proper JSDoc format
Hotell
commented
Jun 6, 2025
| types: { | ||
| 'React.RefAttributes': { | ||
| message: | ||
| '`React.RefAttributes` is leaking string starting @types/[email protected] creating invalid type contracts. Use `RefAttributes` from @fluentui/react-utilities instead', |
There was a problem hiding this comment.
tbh this is not the most robust rule as it doesn't work on interface extensions, and also doesn't distinguishes about the imports. the autofixer is also naive as it won't provide proper import.
for now it's good enough, but in future we will introduce custom rule
Hotell
commented
Jun 6, 2025
| @@ -0,0 +1,7 @@ | |||
| { | |||
| "type": "none", | |||
There was a problem hiding this comment.
although api.md changed the type is exactly the same -> thus no bump
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previous Behavior
New Behavior
RefAttributesinterface which is used within ForwardRefComponent to mitigateReact.RefAttributesexpansion causing breaking changes in v8/v9 mixed context - shipped as patch release in @types/[email protected] #34572React.RefAttributeuse in v9React.RefAttributewith customRefAttributein v9 codeRelated Issue(s)