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

feat: refine group (fix#287) #669

Closed
wants to merge 1 commit into from

Conversation

zyy7259
Copy link

@zyy7259 zyy7259 commented Jul 25, 2018

Summary

  • isolate a group's open status with isolated: true
  • config a isolated group's initial open status with initialIsolatedOpen: true
  • config a group's sidebarDepth with sidebarDepth: 2
  • nested sidebar groups

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

os: Mac High Sierra 10.13.6

  • Chrome Version 67.0.3396.99 (Official Build) (64-bit)
  • Firefox 60.0.2 (64-bit)
  • Safari Version 11.1.2 (13605.3.8)
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

@zyy7259
Copy link
Author

zyy7259 commented Jul 25, 2018

Test demo urls:

If you want to build the demo from scratch:

  • git clone [email protected]:zyy7259/vuepress.git
    • cd vuepress
    • yarn
    • git checkout feature-refine-group
  • cd ..
  • git clone [email protected]:zyy7259/test-vuepress-nested-group.git
    • cd test-vuepress-nested-group
    • npm run dev

@davestewart
Copy link

davestewart commented Aug 17, 2018

What does this mean / do?

You can isolate a group's open status with isolated: true

@zyy7259
Copy link
Author

zyy7259 commented Aug 18, 2018

What does this mean / do? ...

@davestewart Right now, when you open a group, other groups will be closed automatically. With isolated: true a group won’t be closed when you open another group at the same level.

@marceloavf
Copy link

Looking forward for this, need any help?

@zyy7259
Copy link
Author

zyy7259 commented Sep 19, 2018

Rebased from master.

Should I wait and rebase again when #815 is done?

@jackpope
Copy link

jackpope commented Dec 3, 2018

@zyy7259 Looks like #815 was merged. Do you need anything on this?

- isolate a group's open status with `isolated: true`
- config a isolated group's initial open status with `initialIsolatedOpen: true`
- config a group's sidebarDepth with `sidebarDepth: 2`
- nested sidebar groups
@zyy7259
Copy link
Author

zyy7259 commented Dec 4, 2018

Rebased on top of master.

@@ -329,7 +335,7 @@ module.exports = {
```

::: warning Note
Unlike the [built-in search](#built-in-search) engine which works out of the box, [Algolia DocSearch](https://community.algolia.com/docsearch/) requires you to submit your site to them for indexing before it starts working.
Unlike the [built-in search](#built-in-search) engine which works out of the box, [Algolia DocSearch](https://community.algolia.com/docsearch/) requires you to submit your site to them for indexing before it starts working.

Choose a reason for hiding this comment

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

This change is probably not relevant for this PR?

Copy link
Author

Choose a reason for hiding this comment

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

Oh, I have config my IDE to trim trailing whitespace. Should I add the whitespace back?

@ulivz ulivz force-pushed the master branch 3 times, most recently from 6c3127f to 71574f2 Compare December 18, 2018 18:27
@ulivz ulivz force-pushed the master branch 5 times, most recently from 316e022 to 1284944 Compare January 29, 2019 11:47
@ulivz
Copy link
Member

ulivz commented Feb 3, 2019

Thanks for the great work, but it's not recommended to bundle two many features in a PR.

I just create a PR containing following necessary features:

  1. Configurable sidebarDepth for sidebar group;
  2. Nested sidebar groups;
  3. Clickable heading for sidebar groups.

For isolated and initialIsolatedOpen, they are not so necessary, but will bring much extra learning costs, therefore we are not going to introduce these features.

Let's move #1257 to continue.

@ulivz ulivz closed this Feb 3, 2019
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.

6 participants