[#1060] Adjust docs/typings for initialFocus option #1062
Conversation
Fixes #1060 The option can _also_ be set to `undefined` or a function that returns `undefined`.
🦋 Changeset detectedLatest commit: 7d4024b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Unfortunately, that doesn't solve the problem. Being able to specify a function that always returns undefined is not really more helpful than specifying undefined directly. Instead, we would need something like FocusTargetValueOrFalse | (() => FocusTargetValueOrFalse | undefined) | undefined.
FYI, the information I get with your changes when trying initialFocus: () => someCondition ? someElement : undefined:
Type '() => HTMLElement | undefined' is not assignable to type 'FocusTargetOrFalse | (() => undefined) | undefined'.
|
@FloEdelmann Thanks for checking it out. You're right, I was able to reproduce the error. I think the fix is simply changing the function type to |
|
I will push this out next early next week. |
|
Published in v7.5.3 |
Fixes #1060
The option can also be set to
undefinedor a function that returnsundefined.PR Checklist
Please leave this checklist in your PR.
npm run demo-bundlein your branch and include the/docs/demo-bundle.jsfile that gets generated in your PR).// TEST MANUALLYcomments here) that can't be fully tested in Cypress have been manually verified.typeof document/window !== 'undefined'before using it in code that gets executed on load.npm run changesetlocally to add one, and follow the prompts).