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

HTML Symbol filters #3922

Open
5 tasks
martinbonnin opened this issue Nov 15, 2024 · 0 comments
Open
5 tasks

HTML Symbol filters #3922

martinbonnin opened this issue Nov 15, 2024 · 0 comments
Labels
enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format

Comments

@martinbonnin
Copy link
Contributor

martinbonnin commented Nov 15, 2024

Follow up from this slack discussion

On a package/type page, it would be nice being able to have filter to filter out symbols according to some criterias. The ones I currently have in mind:

  • Extensions
  • Protected
  • Deprecated
  • OptIn1
  • OptIn2

Those last 2 OptIn filters are related to #1862. I think I'd like it to expand to all the different OptIn annotation present in that type. For an example @ExperimentalApi or @LowLevelApi, etc... There's an issue that if there are a lot of OptIn, the filter list will grow too much but IMO if there are many OptIn in a type, this is probably a code smell already.

Ideally, the filter can be set through a query parameter so that shareable links can include them:

https://com.example/symbol/index.html?filter=deprecated,extensions

I think I'd like the default to include everything for easier "search in page" functionality. With visual clues for deprecated/protected/opt-in symbols (see also #3924)

Note that this issue is different from #3874 in that it filters inside the page while I understand #3874 is about search filters.

@martinbonnin martinbonnin added the enhancement An issue for a feature or an overall improvement label Nov 15, 2024
@martinbonnin martinbonnin changed the title HTML Filters HTML Symbol filters Nov 15, 2024
@whyoleg whyoleg added the format: html An issue/PR related to Dokka's default HTML output format label Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format
Projects
None yet
Development

No branches or pull requests

2 participants