Skip to content

Conversation

@highfieldjames
Copy link
Contributor

@highfieldjames highfieldjames commented Jan 20, 2023

WHY are these changes introduced?

A tooltip was recently added to the IndexTable headings to indicate the sort direction. In Shopify admin (web), we have inputs within the index table which have their interactivity blocked by the tooltip and its overlay. As the tooltips are a single line (e.g. "A-Z" to indicate the sort direction), I propose we use the dismissOnMouseOut prop so the tooltip is closed when the mouse moves out of the tooltip header area.

Video of the issue in Shopify admin

tooltip-blocking-input.mp4

Video of the issue in Storybook

before-fix.mp4

Video of the fix in Storybook

dismiss-tooltips.mp4

WHAT is this pull request doing?

Uses the dismissOnMouseOut prop on Tooltip (see Tooltip docs) to close the tooltip when not hovering on the header cell

How to 🎩

🖥 Local development instructions
🗒 General tophatting guidelines
📄 Changelog guidelines

Tophat using the Storybook story for the index table with sortable headings

🎩 checklist

@github-actions
Copy link
Contributor

size-limit report 📦

Path Size
polaris-react-cjs 214.78 KB (+0.01% 🔺)
polaris-react-esm 137.11 KB (+0.01% 🔺)
polaris-react-esnext 192.65 KB (+0.01% 🔺)
polaris-react-css 42.01 KB (0%)

@highfieldjames highfieldjames merged commit e6aa9c8 into main Jan 20, 2023
@highfieldjames highfieldjames deleted the index-table-tooltip-closing branch January 20, 2023 15:45
sophschneider pushed a commit that referenced this pull request Jan 24, 2023
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@6.9.0

### Minor Changes

- [#8139](#8139)
[`b998ca007`](b998ca0)
Thanks [@leileu](https://github.com/leileu)! - Adding content minor icon
for left nav in admin


- [#8094](#8094)
[`94988bc26`](94988bc)
Thanks [@Tamas-Kisss](https://github.com/Tamas-Kisss)! - Added major and
minor icon for Papercheck


- [#8121](#8121)
[`f74e8ffcc`](f74e8ff)
Thanks [@zecarlostorre](https://github.com/zecarlostorre)! - Added
EnterMajor icon

## @shopify/polaris@10.23.0

### Minor Changes

- [#8134](#8134)
[`8d80691b5`](8d80691)
Thanks [@mrcthms](https://github.com/mrcthms)! - Removed the focus ring
from `Listbox` options

### Patch Changes

- [#8093](#8093)
[`60dd5a0c5`](60dd5a0)
Thanks [@highfieldjames](https://github.com/highfieldjames)! - Added
`borderRadius` style to `TooltipOverlay`


- [#8090](#8090)
[`bdcc291a4`](bdcc291)
Thanks [@emmanueletti](https://github.com/emmanueletti)! - Replaced
mouse up and down events on Backdrop with onClick to close Modal


- [#8131](#8131)
[`6096c3492`](6096c34)
Thanks [@henryyi](https://github.com/henryyi)! - Fixed Navigation item
secondaryActions alignment in mobile when floating actions are enabled


- [#8114](#8114)
[`e6aa9c801`](e6aa9c8)
Thanks [@highfieldjames](https://github.com/highfieldjames)! - Dismiss
index table tooltip on mouse out


- [#8091](#8091)
[`23ee70d13`](23ee70d)
Thanks [@ginabak](https://github.com/ginabak)! - Added `onBlur` prop to
numerical steppers (`Spinner` component of `TextField`) to remove multi
focus issue in `TextField`.

- Updated dependencies
\[[`b998ca007`](b998ca0),
[`94988bc26`](94988bc),
[`f74e8ffcc`](f74e8ff)]:
    -   @shopify/polaris-icons@6.9.0

## @shopify/plugin-polaris@0.0.30

### Patch Changes

-   Updated dependencies \[]:
    -   @shopify/polaris-migrator@0.11.1

## @shopify/polaris-migrator@0.11.1

### Patch Changes

- Updated dependencies
\[[`cd150396b`](cd15039)]:
    -   @shopify/stylelint-polaris@5.1.1

## @shopify/stylelint-polaris@5.1.1

### Patch Changes

- [#8097](#8097)
[`cd150396b`](cd15039)
Thanks [@qt314](https://github.com/qt314)! - Fix incorrect unit function
categorization

## polaris.shopify.com@0.30.0

### Minor Changes

- [#8110](#8110)
[`5db7778e4`](5db7778)
Thanks [@yurm04](https://github.com/yurm04)! - Added New badge pattern
guidance for the primary nav

### Patch Changes

- [#8107](#8107)
[`fc30bbd32`](fc30bbd)
Thanks [@Rmnlly](https://github.com/Rmnlly)! - Adding examples for
truncateText and multiple secondary actions and updating props on the
documentation site

- Updated dependencies
\[[`b998ca007`](b998ca0),
[`60dd5a0c5`](60dd5a0),
[`bdcc291a4`](bdcc291),
[`6096c3492`](6096c34),
[`94988bc26`](94988bc),
[`e6aa9c801`](e6aa9c8),
[`8d80691b5`](8d80691),
[`f74e8ffcc`](f74e8ff),
[`23ee70d13`](23ee70d)]:
    -   @shopify/polaris-icons@6.9.0
    -   @shopify/polaris@10.23.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@gwyneplaine gwyneplaine mentioned this pull request Feb 14, 2023
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
<!--
  ☝️How to write a good PR title:
- Prefix it with [ComponentName] (if applicable), for example: [Button]
  - Start with a verb, for example: Add, Delete, Improve, Fix…
  - Give as much context as necessary and as little as possible
  - Prefix it with [WIP] while it’s a work in progress
-->

### WHY are these changes introduced?

<!--
  Context about the problem that’s being addressed.
-->

A tooltip was recently added to the IndexTable headings to indicate the
sort direction. In Shopify admin (web), we have inputs within the index
table which have their interactivity blocked by the tooltip and its
overlay. As the tooltips are a single line (e.g. "A-Z" to indicate the
sort direction), I propose we use the `dismissOnMouseOut` prop so the
tooltip is closed when the mouse moves out of the tooltip header area.

#### Video of the issue in Shopify admin


https://user-images.githubusercontent.com/6731221/213668509-a12bff62-dcd1-4d75-8977-a0a1222e3926.mp4

#### Video of the issue in Storybook


https://user-images.githubusercontent.com/6731221/213668947-c7290532-287d-42b2-a4f1-d91ab3fcd90a.mp4

#### Video of the fix in Storybook


https://user-images.githubusercontent.com/6731221/213668959-e7e51cda-d266-4b5f-9177-7d1b5da922fc.mp4

### WHAT is this pull request doing?

<!--
  Summary of the changes committed.

Before / after screenshots are appreciated for UI changes. Make sure to
include alt text that describes the screenshot.

If you include an animated gif showing your change, wrapping it in a
details tag is recommended. Gifs usually autoplay, which can cause
accessibility issues for people reviewing your PR:

    <details>
      <summary>Summary of your gif(s)</summary>
      <img src="..." alt="Description of what the gif shows">
    </details>
-->

Uses the `dismissOnMouseOut` prop on `Tooltip` ([see Tooltip
docs](https://polaris.shopify.com/components/tooltip#props)) to close
the tooltip when not hovering on the header cell

### How to 🎩

🖥 [Local development
instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development)
🗒 [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)

Tophat using the [Storybook
story](https://5d559397bae39100201eedc1-utwopyovkc.chromatic.com/?path=/story/all-components-indextable--with-sortable-headings)
for the index table with sortable headings

### 🎩 checklist

- [ ] 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)
- [ ] Tested for
[accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md)
- [ ] Updated the component's `README.md` with documentation changes
- [ ] [Tophatted
documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md)
changes in the style guide
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
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@6.9.0

### Minor Changes

- [Shopify#8139](Shopify#8139)
[`b998ca007`](Shopify@b998ca0)
Thanks [@leileu](https://github.com/leileu)! - Adding content minor icon
for left nav in admin


- [Shopify#8094](Shopify#8094)
[`94988bc26`](Shopify@94988bc)
Thanks [@Tamas-Kisss](https://github.com/Tamas-Kisss)! - Added major and
minor icon for Papercheck


- [Shopify#8121](Shopify#8121)
[`f74e8ffcc`](Shopify@f74e8ff)
Thanks [@zecarlostorre](https://github.com/zecarlostorre)! - Added
EnterMajor icon

## @shopify/polaris@10.23.0

### Minor Changes

- [Shopify#8134](Shopify#8134)
[`8d80691b5`](Shopify@8d80691)
Thanks [@mrcthms](https://github.com/mrcthms)! - Removed the focus ring
from `Listbox` options

### Patch Changes

- [Shopify#8093](Shopify#8093)
[`60dd5a0c5`](Shopify@60dd5a0)
Thanks [@highfieldjames](https://github.com/highfieldjames)! - Added
`borderRadius` style to `TooltipOverlay`


- [Shopify#8090](Shopify#8090)
[`bdcc291a4`](Shopify@bdcc291)
Thanks [@emmanueletti](https://github.com/emmanueletti)! - Replaced
mouse up and down events on Backdrop with onClick to close Modal


- [Shopify#8131](Shopify#8131)
[`6096c3492`](Shopify@6096c34)
Thanks [@henryyi](https://github.com/henryyi)! - Fixed Navigation item
secondaryActions alignment in mobile when floating actions are enabled


- [Shopify#8114](Shopify#8114)
[`e6aa9c801`](Shopify@e6aa9c8)
Thanks [@highfieldjames](https://github.com/highfieldjames)! - Dismiss
index table tooltip on mouse out


- [Shopify#8091](Shopify#8091)
[`23ee70d13`](Shopify@23ee70d)
Thanks [@ginabak](https://github.com/ginabak)! - Added `onBlur` prop to
numerical steppers (`Spinner` component of `TextField`) to remove multi
focus issue in `TextField`.

- Updated dependencies
\[[`b998ca007`](Shopify@b998ca0),
[`94988bc26`](Shopify@94988bc),
[`f74e8ffcc`](Shopify@f74e8ff)]:
    -   @shopify/polaris-icons@6.9.0

## @shopify/plugin-polaris@0.0.30

### Patch Changes

-   Updated dependencies \[]:
    -   @shopify/polaris-migrator@0.11.1

## @shopify/polaris-migrator@0.11.1

### Patch Changes

- Updated dependencies
\[[`cd150396b`](Shopify@cd15039)]:
    -   @shopify/stylelint-polaris@5.1.1

## @shopify/stylelint-polaris@5.1.1

### Patch Changes

- [Shopify#8097](Shopify#8097)
[`cd150396b`](Shopify@cd15039)
Thanks [@qt314](https://github.com/qt314)! - Fix incorrect unit function
categorization

## polaris.shopify.com@0.30.0

### Minor Changes

- [Shopify#8110](Shopify#8110)
[`5db7778e4`](Shopify@5db7778)
Thanks [@yurm04](https://github.com/yurm04)! - Added New badge pattern
guidance for the primary nav

### Patch Changes

- [Shopify#8107](Shopify#8107)
[`fc30bbd32`](Shopify@fc30bbd)
Thanks [@Rmnlly](https://github.com/Rmnlly)! - Adding examples for
truncateText and multiple secondary actions and updating props on the
documentation site

- Updated dependencies
\[[`b998ca007`](Shopify@b998ca0),
[`60dd5a0c5`](Shopify@60dd5a0),
[`bdcc291a4`](Shopify@bdcc291),
[`6096c3492`](Shopify@6096c34),
[`94988bc26`](Shopify@94988bc),
[`e6aa9c801`](Shopify@e6aa9c8),
[`8d80691b5`](Shopify@8d80691),
[`f74e8ffcc`](Shopify@f74e8ff),
[`23ee70d13`](Shopify@23ee70d)]:
    -   @shopify/polaris-icons@6.9.0
    -   @shopify/polaris@10.23.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants