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

website: Update breadcrumbs documentation & demos #957

Merged
merged 14 commits into from
Feb 3, 2023

Conversation

FlyersPh9
Copy link
Collaborator

@FlyersPh9 FlyersPh9 commented Jan 5, 2023

  • Add breadcrumbs demos for the different sections on the page.
  • Update documentation, include adding hyperlinks to other mentioned components.

@FlyersPh9 FlyersPh9 added the documentation Improvements or additions to documentation label Jan 5, 2023
@FlyersPh9 FlyersPh9 self-assigned this Jan 5, 2023
@FlyersPh9 FlyersPh9 marked this pull request as ready for review January 30, 2023 20:50
@FlyersPh9 FlyersPh9 requested a review from a team as a code owner January 30, 2023 20:50
@FlyersPh9 FlyersPh9 requested review from a team, mayank99 and r100-stack and removed request for a team January 30, 2023 20:50

### First truncated element
Show as many previously accessed folders as possible so that users can quickly go back to an upper level. If all breadcrumb items can be shown without horizontal scrolling, show them all. Try to keep the first level - the root folder - always accessible. Therefore when you start truncating element start with the secondly accessed folder and work your way from there.
Copy link
Member

Choose a reason for hiding this comment

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

The last sentence here might need some commas. I was a bit confused what message the sentence was trying to convey.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ive tried to make it more clear, let me know what you think.

<Button key={1} onClick={() => {}}>
My files
</Button>
<Button key={2} onClick={() => {}}>
Copy link
Member

Choose a reason for hiding this comment

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

Are all the empty onClicks needed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It would appear they are not needed, removed.

<div
style={{
border: '1px solid pink',
maxWidth: 450,
Copy link
Member

Choose a reason for hiding this comment

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

There's a bit of overflow on the smallest window width with the current maxWidth. Should we change the maxWidth?

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

What width works on your screen? Being on macOS I can never see those thicker scrollbars that Windows has.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I am unable to re-create this scenario. When shrinking the browser window width, I do not see the pink box going outside of the demo frame:
Screenshot 2023-02-03 at 12 33 59 PM

Copy link
Contributor

Choose a reason for hiding this comment

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

I was able to recreate this error. In collaboration with Jon, I fixed it by changing the maxWidth in Breadcrumbs.extremetruncation.tsx from 450 to 425.

@FlyersPh9 FlyersPh9 merged commit b0eae77 into main Feb 3, 2023
@FlyersPh9 FlyersPh9 deleted the jon/documentation-site-breadcrumbs branch February 3, 2023 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants