-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Conversation
Hey @cdedreuille I tried this story in Chromatic and the result is not what we expect: |
@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. |
Thanks @cdedreuille it works: But I wonder if it should be the other way around. If you have stories like so:
With this change, you get the following names:
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:
|
I like this option the best. Great suggestion @yannbf 👏 |
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) { |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
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:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/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>