Skip to content
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

UI: Mobile truncate story name #24372

Merged
merged 6 commits into from
Oct 10, 2023
Merged

Conversation

cdedreuille
Copy link
Contributor

Closes #24257

What I did

On mobile, if the story name is too long we want to truncate it automatically to make sure it doesn't go into 2 lines.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Go to Storybook UI locally
  2. Go to this story - http://localhost:6006/?path=/story/manager-mobile-navigation--long-story-name
  3. Check that the name is in 1 line and truncated with ellipsis

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@cdedreuille cdedreuille added maintenance User-facing maintenance tasks ci:normal labels Oct 4, 2023
@cdedreuille cdedreuille self-assigned this Oct 4, 2023
@cdedreuille cdedreuille changed the base branch from next to release-8-0 October 4, 2023 13:41
@yannbf
Copy link
Member

yannbf commented Oct 5, 2023

Hey @cdedreuille I tried this story in Chromatic and the result is not what we expect:

@cdedreuille
Copy link
Contributor Author

@yannbf Are you sure you are seeing the latest version? In Chromatic I can see that the new version is actually correct and it truncate the text.

CleanShot 2023-10-05 at 16 48 58@2x

@cdedreuille
Copy link
Contributor Author

@yannbf
Copy link
Member

yannbf commented Oct 5, 2023

Thanks @cdedreuille it works:

But I wonder if it should be the other way around. If you have stories like so:

DesignSystem/Molecules/Heading/First
DesignSystem/Molecules/Heading/Second
DesignSystem/Molecules/Heading/Third

With this change, you get the following names:

DesignSystem/Molecules/He...
DesignSystem/Molecules/He...
DesignSystem/Molecules/He...

And that doesn't help, given that you want to know which story you selected, and you only know which category that is in, now it feels like every story is the same.


Instead, what if we explored other ideas such as:

  1. The truncating happened the other way around:
...em/Molecules/Heading/First
...em/Molecules/Heading/Second
...em/Molecules/Heading/Third
  1. If too long, the full name does not include the topmost level
Molecules/Heading/First
Molecules/Heading/Second
Molecules/Heading/Third
  1. On mobile, we only include the last two levels, which will relate to the component and story names:
Heading/First
Heading/Second
Heading/Third

@ndelangen
Copy link
Member

On mobile, we only include the last two levels, which will relate to the component and story names:

I like this option the best. Great suggestion @yannbf 👏

@cdedreuille
Copy link
Contributor Author

Thanks a lot @yannbf for your suggestions. I added a condition to only add the parent if the story name is less than 24 characters. We still need to truncate the text in some cases but for a majority of cases I think it should be enough.


let fullStoryName = currentStory.renderLabel?.(currentStory) || currentStory.name;
let node = index[currentStory.id];

while ('parent' in node && node.parent && index[node.parent]) {
while ('parent' in node && node.parent && index[node.parent] && fullStoryName.length < 24) {
Copy link
Contributor

Choose a reason for hiding this comment

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

this won't make it stop at 24 characters, it will just make sure that it doesn't add more parents when it has exceeded 24 characters.

Take this example:

Long Root Parent Name/Loooooooong Name/Medium Name/Short Name
  ^21 char           ^    ^16 char    ^  ^11 char ^  ^10 char

Will result in:

Loooooooong Name/Medium Name/Short Name
    ^16 char    ^  ^11 char ^   ^10 char
= 39 characters

Which is still better than nothing, but I just wanted to make sure we all understood this.
If we wanted this to always stop at 24 characters, we would afterwards remove any characters before the last 24 with a substr or similar, which would result in:

e/Medium Name/Short Name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @JReinhold. We don't want to stop exactly at 24 characters. This is just an arbitrary number based on the tests I made to get a sense as to when we can put the parent or not. If the parent has a long name for example, we will use the css truncate with "..." to actually truncate the text.

@cdedreuille cdedreuille merged commit 147cafc into release-8-0 Oct 10, 2023
51 checks passed
@cdedreuille cdedreuille deleted the mobile-truncate-story-name branch October 10, 2023 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Truncate story name on mobile
4 participants