Skip to content

Change collapsable to collapsible in sidebar groups config #607

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

Closed
hoopyfroody opened this issue Jun 22, 2018 · 3 comments
Closed

Change collapsable to collapsible in sidebar groups config #607

hoopyfroody opened this issue Jun 22, 2018 · 3 comments

Comments

@hoopyfroody
Copy link

hoopyfroody commented Jun 22, 2018

Feature request

What problem does this feature solve?

Sidebar groups config in the default theme contains the collapsable prop. My instinctual reaction was that this should be collapsible. While both versions of the word are correct, collapsible is by far the most used (source: google search, ratio is about 10:1). I think changing it may save some people having to go to the docs to find the correct spelling.

What does the proposed API look like?

module.exports = {
  themeConfig: {
    sidebar: [
      {
        title: 'Group 1',
        collapsible: false,
        children: [
          '/'
        ]
      }
    ]
  }
}

How should this be implemented in your opinion?

Well, I realise this is a breaking change and a bit of a pet peeve, so perhaps not at all. But I did want to bring it up, since we are pre-1.0 and there might still be a window.

Are you willing to work on this yourself?

Sure, I'll do a PR if this is deemed a good suggestion.

@ulivz
Copy link
Member

ulivz commented Jun 22, 2018

Thanks for your suggestion, but since collapsable has been able to get the result what user want:

image

It also has no side effects, so it isn't worth taking breaking change for that.

@ulivz ulivz closed this as completed Jun 22, 2018
@hoopyfroody
Copy link
Author

Sure, I find your reasoning a bit off (my issue wasn't about a google search working, but intuitively misspelling in the config file), but I can accept that this may not be worth a breaking change.

@ulivz
Copy link
Member

ulivz commented Aug 7, 2018

We have set alias collapsible for collapsable at #706.

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

No branches or pull requests

2 participants