Skip to content

fix(material/tabs): update MatTab _scrollToLabel function to always display a label from its start #26737

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

Merged
merged 1 commit into from
Mar 15, 2023

Conversation

clamli
Copy link
Contributor

@clamli clamli commented Mar 7, 2023

_scrollheader() computes the distance to move a tab list. Originally it set the scroll amount to a third of the length of the tab list view window, which did not consider the length of the tab label itself. When the screen size is small, the label might be clipped and not completely readable on its own and users see just the left or right of the tab text.

This PR updates _scrollheader() function to make it smarter on distance calculation. It introduced two variables,

  • minLeftSpace: the distance from the first fully rendered label to the left border of the viewport.
  • minRightSpace: the distance from the last fully rendered label to the right border of the viewport.

Now the new scroll amount is,

  • 'before' direction: MINIMUM(minRightSpace, 1/3 * viewLength)
  • 'after' direction: MINIMUM(minLeftSpace, 1/3 * viewLength)

This way, the moving distance would be guarded by the remaining space on either side of the label and we can make sure the label would not be clipped.

As discussed offline, it would be hard to display a label fully when it is long without causing any UI regression. A reasonable compromise would be to ensure that the first part of each label is readable and is distinct from other labels.

We update _scrollToLabel function to always display a long label from its start, this way, we at least make sure the first part of it is readable. What the exact changes are,

  • set scrollDistance so that it will always align the border of the viewport to the head or tail of the focused label
  • remove EXAGGERATED_OVERSCROLL because that will add disruption to the moving strategy we are using
  • update the tab names used in the unit tests to make sure the length of the tabs is always larger than the maximum scroll distance.

Demo:
final-demo

@clamli clamli requested a review from crisbeto as a code owner March 7, 2023 01:28
@clamli clamli changed the title Make MatTab _scrollheader function smarter to display content fully fix(material/tabs): Make MatTab _scrollheader function smarter to display content fully Mar 7, 2023
clamli added a commit to clamli/components that referenced this pull request Mar 7, 2023
@clamli clamli changed the title fix(material/tabs): Make MatTab _scrollheader function smarter to display content fully fix(material/tabs): update MatTab _scrollToLabel function to always d… …isplay a label from its start Mar 8, 2023
@clamli clamli changed the title fix(material/tabs): update MatTab _scrollToLabel function to always d… …isplay a label from its start fix(material/tabs): update MatTab _scrollToLabel function to always display a label from its start Mar 8, 2023
@clamli clamli force-pushed the MatTabReflow branch 3 times, most recently from 824dd84 to a47c834 Compare March 8, 2023 22:52
@clamli clamli requested a review from andrewseguin as a code owner March 8, 2023 22:52
@clamli clamli requested review from crisbeto and removed request for andrewseguin March 8, 2023 23:39
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The behavior and runtime code LGTM, but the tests can be improved.

@clamli clamli force-pushed the MatTabReflow branch 3 times, most recently from c473a3c to 0fdf334 Compare March 9, 2023 21:53
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@crisbeto crisbeto added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Mar 10, 2023
@crisbeto crisbeto merged commit 946cc67 into angular:main Mar 15, 2023
crisbeto pushed a commit that referenced this pull request Mar 15, 2023
…isplay a label from its start (#26736) (#26737)

(cherry picked from commit 946cc67)
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Mar 30, 2023
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@angular/cdk](https://github.com/angular/components) | dependencies | patch | [`15.2.1` -> `15.2.5`](https://renovatebot.com/diffs/npm/@angular%2fcdk/15.2.1/15.2.5) |
| [@angular/material](https://github.com/angular/components) | dependencies | patch | [`15.2.1` -> `15.2.5`](https://renovatebot.com/diffs/npm/@angular%2fmaterial/15.2.1/15.2.5) |

---

### Release Notes

<details>
<summary>angular/components</summary>

### [`v15.2.5`](https://github.com/angular/components/blob/HEAD/CHANGELOG.md#&#8203;1525-metal-plumber-2023-03-29)

[Compare Source](angular/components@15.2.4...15.2.5)

##### cdk

| Commit | Type | Description |
| -- | -- | -- |
| [4ec3abd723](angular/components@4ec3abd) | fix | **overlay:** don't close if scroll is coming from inside overlay ([#&#8203;26840](angular/components#26840)) |

##### material

| Commit | Type | Description |
| -- | -- | -- |
| [600d40eb24](angular/components@600d40e) | fix | **datepicker:** remove div as a child of button ([#&#8203;26838](angular/components#26838)) |

#### Special Thanks

Kristiyan Kostadinov and Wagner Maciel

<!-- CHANGELOG SPLIT MARKER -->

### [`v15.2.4`](https://github.com/angular/components/blob/HEAD/CHANGELOG.md#&#8203;1524-brimstone-bank-2023-03-23)

[Compare Source](angular/components@15.2.3...15.2.4)

##### material

| Commit | Type | Description |
| -- | -- | -- |
| [580fbf500](angular/components@580fbf5) | fix | **core:** apply strong focus styles to selected option ([#&#8203;26811](angular/components#26811)) |
| [1ba5ade41](angular/components@1ba5ade) | fix | **datepicker:** date range input not marked as required when using reactive forms ([#&#8203;26749](angular/components#26749)) |
| [acc7d8148](angular/components@acc7d81) | fix | **tooltip:** only expand hover area on side closest to trigger ([#&#8203;26786](angular/components#26786)) |

#### Special Thanks

Kristiyan Kostadinov, Wagner Maciel and Zach Arend

<!-- CHANGELOG SPLIT MARKER -->

### [`v15.2.3`](https://github.com/angular/components/blob/HEAD/CHANGELOG.md#&#8203;1523-aluminum-statue-2023-03-16)

[Compare Source](angular/components@15.2.2...15.2.3)

##### material

| Commit | Type | Description |
| -- | -- | -- |
| [7dfcf8ff3](angular/components@7dfcf8f) | fix | **checkbox:** fix ARIA semantics and use native DOM properties ([#&#8203;26710](angular/components#26710)) |
| [40d38889c](angular/components@40d3888) | fix | **chips:** chip label appearing above sticky columns ([#&#8203;26794](angular/components#26794)) |
| [b846d1e05](angular/components@b846d1e) | fix | **chips:** don't prevent default mousedown action ([#&#8203;26765](angular/components#26765)) |
| [501d73e5b](angular/components@501d73e) | fix | **chips:** styling not cleared on basic chips in listbox and grid ([#&#8203;26771](angular/components#26771)) |
| [06ed54c25](angular/components@06ed54c) | fix | **tabs:** update MatTab \_scrollToLabel function to always display a label from its start ([#&#8203;26736](angular/components#26736)) ([#&#8203;26737](angular/components#26737)) |

#### Special Thanks

Boyi Li, Kristiyan Kostadinov, Paul Gschwendtner and Zach Arend

<!-- CHANGELOG SPLIT MARKER -->

### [`v15.2.2`](https://github.com/angular/components/blob/HEAD/CHANGELOG.md#&#8203;1522-topaz-toast-2023-03-08)

[Compare Source](angular/components@15.2.1...15.2.2)

##### material

| Commit | Type | Description |
| -- | -- | -- |
| [e7612c747](angular/components@e7612c7) | fix | **chips:** unable to shift + tab out of a chip set ([#&#8203;26727](angular/components#26727)) |
| [1bf2fc2e1](angular/components@1bf2fc2) | fix | **core:** mat-option sets aria-selected="false" ([#&#8203;26673](angular/components#26673)) |
| [9473b1688](angular/components@9473b16) | fix | **datepicker:** resolve server-side rendering error ([#&#8203;26742](angular/components#26742)) |
| [99dac0835](angular/components@99dac08) | fix | **paginator:** opt-out of single-selection indicator ([#&#8203;26746](angular/components#26746)) |
| [ec824f1f7](angular/components@ec824f1) | fix | **snack-bar:** live region not working when modal is open ([#&#8203;26725](angular/components#26725)) |

##### cdk-experimental

| Commit | Type | Description |
| -- | -- | -- |
| [e1c8fe85b](angular/components@e1c8fe8) | fix | **scrolling:** throw error rather than string ([#&#8203;26736](angular/components#26736)) |

#### Special Thanks

Kristiyan Kostadinov, RuoJia123 and Zach Arend

<!-- CHANGELOG SPLIT MARKER -->

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTcuMSIsInVwZGF0ZWRJblZlciI6IjM1LjI0LjYifQ==-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1813
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Apr 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants