Skip to content

feat: introduce header default filter options #307 #1816

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

Merged

Conversation

aqumus
Copy link
Contributor

@aqumus aqumus commented Dec 3, 2021

fixes #307

Whats changed?

  1. introduce VisibilityFilter enum
  2. add visibility, showInherited and showExternals options which sets the default value of generated header filter
  3. use the options value in header.ts theme partials
  4. set the FilterItem (i.e FilterItemSelect and FilterItemChecked) component value by querying the dom element and plucking out dom value/attribute

Questions:

  1. How does filter interaction updates the docs for eg: when inherited is unchecked by user, docs hides the inherited methods, not able to figure this out? Although this is just for my understanding
  2. Is the setting of Filter component value reasonable?
  3. What test case could we add for this?
  4. Do we need to raise PR for typedoc-site to add description of these new options?

@aqumus
Copy link
Contributor Author

aqumus commented Jan 18, 2022

@Gerrit0 possible to review this PR? I am also interested to know answers to the questions mentioned in the PR details.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 19, 2022

I'll try and get to this this weekend - sorry, slipped through the cracks

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 24, 2022

Looks like it'll be next weekend ^

@Gerrit0 Gerrit0 mentioned this pull request Apr 17, 2022
8 tasks
@aqumus
Copy link
Contributor Author

aqumus commented Apr 18, 2022

@Gerrit0 Are the PR changes in the correct direction, any comments? I could resolve the conflicts and update the PR if it brings much value to v0.23 beta changes

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 18, 2022

Yes - this is in the right direction, I just need to find some (soon! actually this time) to get it merged into the beta branch. I think there will end up being one option, which will be an object that can also have "@deprecated": false to add checkboxes for specific tags.

@Gerrit0 Gerrit0 added this to the v0.23 milestone May 30, 2022
@Gerrit0 Gerrit0 merged commit 8ff6b4c into TypeStrong:master Jun 26, 2022
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.

Default the selected menu options on a generated doc site
2 participants