-
Notifications
You must be signed in to change notification settings - Fork 236
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
Add Filter text input to manage visible class properties #98
Comments
sounds great! On my todo list 😊 |
@RaananW So I was looking into this... It would technically be much easier to implement this if we used the JSON output for the files, instead of the TypeDoc html, that way we could cache the loaded files, and easily apply filters to different JSON objects, and slot in filter-inputs to each section of the json. However, it would mean a ton more work setting up the actual page. The alternative is to hackily traverse the HTML, but it would be quicker (although more fragile, certainly if typedoc changes things slightly in the HTML). My question is if one was to do this work, would you be okay with going down the JSON route and creating a custom view of the docs instead of using the TypeDoc generated HTML, or would you prefer we use the current HTML output with a solution more like this extension that would inspect the HTML for view/hide. Note, I'm willing to do either approach even if it'd be a bit of work to do, but I didn't wanna just make a decision, on your behalf. |
The issue with the JSON is to generate a familiar and usable HTML layout to display the API docs. TypeDoc does it wonderfully. If we can find a backwards-compatible HTML layout that works well and can be generated using the JSON output, i am all for it! Otherwise, we will have to stick with the HTML. |
#1025 |
Ahha! I didnt know that you could do that. Thanks for the PR man. Learned something new 😄 |
Re: https://forum.babylonjs.com/t/request-api-doc-index-sidebar-filter/15682/6
The idea is to have a text input at the top of each class page that when typed in will remove visibility of the properties/methods that don't match the input string. This will make it much easier to find the user's desired information.
The text was updated successfully, but these errors were encountered: