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

fix: documentation sidebar component to show on mobile #670

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

junnjiee16
Copy link

@junnjiee16 junnjiee16 commented Jan 21, 2025

Fixes #664 (There was no way to access the LeftSidebar component in mobile view, which contained links to each hook documentation)

LeftSidebar wasn't able to show on mobile as hidden md:block was applied on the component itself

I changed the component to take in an extra className prop, so that only selected LeftSidebar components will be hidden.

I also removed the Features and Documentation nav links in the MobileNav component - it was weird having the Documentation and Introduction link together, since it led to the same page.

Edited the marketing layout so that LeftSidebar is able to be shown on the home page too

Before:
image

After:
image

Copy link

changeset-bot bot commented Jan 21, 2025

⚠️ No Changeset found

Latest commit: 723a7dc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@junnjiee16 junnjiee16 changed the title fix: left-sidebar component to be shown on mobile fix: left-sidebar component show on mobile Jan 21, 2025
@junnjiee16 junnjiee16 changed the title fix: left-sidebar component show on mobile fix: documentation sidebar component to show on mobile Jan 21, 2025
@iwan-uschka
Copy link

Thanks @junnjiee16 for creating that PR. I am new to this project in terms of contributing to it but i would like to challenge the changes you've made because the main navigation on the homepage now differs between mobile and tablet/desktop view.

I would suggest to

  • remove the main navigation on the homepage completely because it doesn't add real value
    • Documentation and Explore the docs link to the same URL and are initially visible even on smaller screens
    • Features contains an anchor link to a block that is initially visible even on smaller screens
  • apply your changes to all pages but the root/home page

@iwan-uschka
Copy link

In #665 we try to figure out if it makes sense to work on PRs in this repository at all because it seems to be dead. But who knows. Anyway: if you want to make this PR work you have to add a changeset. I went through the same process couple of weeks ago :) Feel free to scroll through #665 to get some information about it.

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.

Documentation site sidebar does not show on mobile
2 participants