-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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.
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
withFocusReturn: Convert to TypeScript #48748
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
64 changes: 0 additions & 64 deletions
64
packages/components/src/higher-order/with-focus-return/index.js
This file was deleted.
Oops, something went wrong.
74 changes: 74 additions & 0 deletions
74
packages/components/src/higher-order/with-focus-return/index.tsx
This file contains 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 |
---|---|---|
@@ -0,0 +1,74 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { Component } from '@wordpress/element'; | ||
import { createHigherOrderComponent, useFocusReturn } from '@wordpress/compose'; | ||
import deprecated from '@wordpress/deprecated'; | ||
|
||
/** | ||
* Returns true if the given object is component-like. An object is component- | ||
* like if it is an instance of wp.element.Component, or is a function. | ||
* | ||
* @param object Object to test. | ||
* | ||
* @return Whether object is component-like. | ||
*/ | ||
function isComponentLike( object: any ): object is React.ComponentType { | ||
return object instanceof Component || typeof object === 'function'; | ||
} | ||
|
||
type Props = { | ||
onFocusReturn?: () => void; | ||
}; | ||
|
||
/** | ||
* Higher Order Component used to be used to wrap disposable elements like | ||
* sidebars, modals, dropdowns. When mounting the wrapped component, we track a | ||
* reference to the current active element so we know where to restore focus | ||
* when the component is unmounted. | ||
* | ||
* @param options The component to be enhanced with | ||
* focus return behavior, or an object | ||
* describing the component and the | ||
* focus return characteristics. | ||
* | ||
* @return Higher Order Component with the focus restauration behaviour. | ||
*/ | ||
export default createHigherOrderComponent( | ||
// @ts-expect-error TODO: Reconcile with intended `createHigherOrderComponent` types | ||
( options: WPComponent | Record< string, unknown > ) => { | ||
const HoC = | ||
( { onFocusReturn }: Props = {} ) => | ||
( WrappedComponent: React.ComponentType ) => { | ||
const WithFocusReturn = ( | ||
props: Record< string, unknown > | ||
) => { | ||
const ref = useFocusReturn( onFocusReturn ); | ||
return ( | ||
<div ref={ ref }> | ||
<WrappedComponent { ...props } /> | ||
</div> | ||
); | ||
}; | ||
|
||
return WithFocusReturn; | ||
}; | ||
|
||
if ( isComponentLike( options ) ) { | ||
const WrappedComponent = options; | ||
return HoC()( WrappedComponent ); | ||
} | ||
|
||
return HoC( options ); | ||
}, | ||
'withFocusReturn' | ||
); | ||
|
||
export const Provider = ( { children }: { children: React.ReactNode } ) => { | ||
deprecated( 'wp.components.FocusReturnProvider component', { | ||
since: '5.7', | ||
hint: 'This provider is not used anymore. You can just remove it from your codebase', | ||
} ); | ||
|
||
return children; | ||
}; |
This file contains 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 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This HOC was a bit irregular and requires a bit more effort to resolve with the upstream types, so I'll suppress it for now.