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

Feature: display sidebar on mobile for Pisces and Gemini, fix issue #708 #710

Merged
merged 8 commits into from
Apr 26, 2024

Conversation

triccsr
Copy link
Contributor

@triccsr triccsr commented Oct 19, 2023

PR Checklist

PR Type

  • Bugfix.
  • Feature.
  • Improvement.
  • Code style update (formatting, linting).
  • Refactoring (no functional changes).
  • Documentation.
  • Translation.
  • Other... Please describe:

What is the current behavior?

Sidebar does not display on tablet or mobile for scheme Pisces and Gemini.

Issue resolved: #708

What is the new behavior?

new option on_mobile: Only for Pisces and Gemini. If enabled, a sidebar toggle button will appear on mobile website, just like the way that scheme Muse&Mist work.

new option button_reverse: For all schemes. If enabled, the position of back2top button and sidebar toggle button will be reversed (left to right, right to left).

  • Link to demo site with this changes: https://triccsr.github.io/ (on_mobile is enabled, but button_reverse is disabled)
  • Screenshots with this changes:
    image

How to use?

In NexT _config.yml:

sidebar:
  # Sidebar display on mobile, default value is false (only for Pisces | Gemini)
  on_mobile: true
  # Reverse position of sidebar toggle and back2top button (left to right, right to left), default value is false
  button_reverse: true

@welcome
Copy link

welcome bot commented Oct 19, 2023

Thanks so much for opening your first PR here!

@CLAassistant
Copy link

CLAassistant commented Oct 19, 2023

CLA assistant check
All committers have signed the CLA.

@coveralls
Copy link

coveralls commented Oct 19, 2023

Pull Request Test Coverage Report for Build 8849477699

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.421%

Totals Coverage Status
Change from base Build 8716367640: 0.0%
Covered Lines: 395
Relevant Lines: 400

💛 - Coveralls

@stevenjoezhang
Copy link
Member

Thanks for your contribution! I'm quite busy right now, I'll review & merge it later! 🚀

@stevenjoezhang
Copy link
Member

Thank you for your patience. I will conduct the test & merge as soon as possible! This feature is very nice and important to the theme~

@stevenjoezhang stevenjoezhang added this to the 8.20.0 milestone Mar 4, 2024
@triccsr
Copy link
Contributor Author

triccsr commented Mar 5, 2024

Thank you for your patience. I will conduct the test & merge as soon as possible! This feature is very nice and important to the theme~

My pleasure!

Copy link

This pull request contains changes to the configuration file. Please make sure the documentation in NexT website is changed or added.
Please edit relevant source files here: https://github.com/next-theme/theme-next-docs/tree/master/source/docs and create a pull request with the changes here: https://github.com/next-theme/theme-next-docs/pulls

@stevenjoezhang
Copy link
Member

I have made some changes, and I think it is now ready to be merged. If there are any issues, please let me know.

@stevenjoezhang stevenjoezhang merged commit 1b2b004 into next-theme:master Apr 26, 2024
12 checks passed
Copy link

welcome bot commented Apr 26, 2024

Congrats on merging your first pull request here! 🎉 How awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants