[IndexFilters] Prevent keyboard shortcuts working if component has no search field or filters #11665
Conversation
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
|
/snapit |
|
🫰✨ Thanks @mrcthms! Your snapshot has been published to npm. Test the snapshot by updating your yarn add @shopify/polaris@0.0.0-snapshot-20240228105807 |
|
This seems good to me. Thanks Marc! Interesting though, the I'll tophat our section in the admin to confirm it's working 👍🏻 |
mrcthms
force-pushed
the
mrcthms-remove-keyboard-shortcut-on-unneeded-index-filters
branch
from
1808ba8
to
c9bd980
Compare
|
@martinamarien I'll raise that with the Polaris team to see if they can investigate why we don't show the full props here. |
Co-authored-by: Chloe Rice <chloerice@users.noreply.github.com>
mrcthms
deleted the
mrcthms-remove-keyboard-shortcut-on-unneeded-index-filters
branch
Merged
mrcthms
pushed a commit
that referenced
this pull request
Mar 5, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @shopify/polaris-icons@8.7.0 ### Minor Changes - [#11682](#11682) [`9eebf1a45`](9eebf1a) Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Fixes clipping on mobile - [#11686](#11686) [`9b1b74447`](9b1b744) Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Update icons for mobile clipping - [#11687](#11687) [`eeea3b96c`](eeea3b9) Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Minus and Plus icons to big and unbalanced ### Patch Changes - [#11685](#11685) [`ac563025e`](ac56302) Thanks [@sam-b-rose](https://github.com/sam-b-rose)! - Removed REM units from SkeletonIcon ## @shopify/polaris@12.20.0 ### Minor Changes - [#11663](#11663) [`ab2877249`](ab28772) Thanks [@mrcthms](https://github.com/mrcthms)! - Updated `BulkActions` to support containing a flat array of actions into a single section within the ActionList - [#11674](#11674) [`042b428be`](042b428) Thanks [@mrcthms](https://github.com/mrcthms)! - Updated BulkActions to show titles of sections if provided ### Patch Changes - [#11670](#11670) [`c2e443ec9`](c2e443e) Thanks [@mrcthms](https://github.com/mrcthms)! - Updated IndexTable so that no bulk actions are required to see the paginated select all text - [#11684](#11684) [`75dcb5443`](75dcb54) Thanks [@mrcthms](https://github.com/mrcthms)! - Updated Actions to safeguard against incorrect prop shapes being passed to it - [#11648](#11648) [`8c7302e11`](8c7302e) Thanks [@trtri2](https://github.com/trtri2)! - Fixed hover styles to multiple selection variant of `OptionList` - [#11665](#11665) [`4263d9ada`](4263d9a) Thanks [@mrcthms](https://github.com/mrcthms)! - Fixed `IndexFilters` responding to keyboard shortcuts when there is no search field or filters - Updated dependencies \[[`ac563025e`](ac56302), [`9eebf1a45`](9eebf1a), [`9b1b74447`](9b1b744), [`eeea3b96c`](eeea3b9)]: - @shopify/polaris-icons@8.7.0 ## polaris.shopify.com@0.64.0 ### Minor Changes - [#11674](#11674) [`042b428be`](042b428) Thanks [@mrcthms](https://github.com/mrcthms)! - Updated BulkActions to show titles of sections if provided - [#11683](#11683) [`8a0e1b32f`](8a0e1b3) Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Update design guidance for icons - [#11634](#11634) [`27ca061a6`](27ca061) Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Adds guidance on optimzing icons to contribution page ### Patch Changes - Updated dependencies \[[`c2e443ec9`](c2e443e), [`ab2877249`](ab28772), [`ac563025e`](ac56302), [`75dcb5443`](75dcb54), [`042b428be`](042b428), [`9eebf1a45`](9eebf1a), [`8c7302e11`](8c7302e), [`4263d9ada`](4263d9a), [`9b1b74447`](9b1b744), [`eeea3b96c`](eeea3b9)]: - @shopify/polaris@12.20.0 - @shopify/polaris-icons@8.7.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
|
Thanks for making this fix! 🙏🏻 I tophatted our channel in production and it works great/ |
AnnaCheba
pushed a commit
to AnnaCheba/polaris
that referenced
this pull request
Apr 22, 2024
… search field or filters (Shopify#11665) ### WHY are these changes introduced? Fixes Shopify#11664 Fixes a issue where pressing the F key to toggle the filtering mode of the IndexFilters was still toggling even when the component had no search field or filters. This resulted in the default mode vanishing from the screen and unable to get it back unless one performs a manual refresh of the page. ### WHAT is this pull request doing? Returns early from the keydown event listener if both the `hideQueryField` and `hideFilters` props are `true`. ### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#install-dependencies-and-build-workspaces) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog) Spin URL: https://admin.web.index-filter-keyboard-shortcut.marc-thomas.eu.spin.dev/store/shop1/orders (I've updated the Orders index to remove search and filters to showcase the change) ### 🎩 checklist - [x] Tested a [snapshot](https://github.com/Shopify/polaris/blob/main/documentation/Releasing.md#-snapshot-releases) - [x] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [x] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [x] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [x] Updated the component's `README.md` with documentation changes - [x] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide --------- Co-authored-by: Chloe Rice <chloerice@users.noreply.github.com>
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.
WHY are these changes introduced?
Fixes #11664
Fixes a issue where pressing the F key to toggle the filtering mode of the IndexFilters was still toggling even when the component had no search field or filters. This resulted in the default mode vanishing from the screen and unable to get it back unless one performs a manual refresh of the page.
WHAT is this pull request doing?
Returns early from the keydown event listener if both the
hideQueryFieldandhideFiltersprops aretrue.How to 🎩
🖥 Local development instructions
🗒 General tophatting guidelines
📄 Changelog guidelines
Spin URL: https://admin.web.index-filter-keyboard-shortcut.marc-thomas.eu.spin.dev/store/shop1/orders (I've updated the Orders index to remove search and filters to showcase the change)
🎩 checklist
README.mdwith documentation changes