Repository navigation
API index status filter does not apply when viewing only packages #25708
Description
I'm submitting a...
[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report
[ ] Performance issue
[ ] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question
[X] Other... Please describe: AIO behavior of API index page filtering
Current behavior
https://angular.io/api?status=security-risk&type=package
If you filter the API reference index by type=package, the status filter does nothing. No matter what status filter option is chosen, all packages are displayed.
Expected behavior
Some options:
- Disable status filter, so it's clear that it doesn't apply when type=package
- If entire packages do have a status, find a way to encode that so we can enable status filter and have it behave the same way it does for individual types
- If a package's status can be derived from its exports, then use the types to determine package status? I'm not sure if this one makes sense, but I could imagine "type=package & status=security risk" returning every package that has at least one export for which status=security risk.
Minimal reproduction of the problem with instructions
- Go to angular.io/docs
- Choose API from left nav
- Choose type=package
- Choose status=security risk
All packages are listed. - Choose status=deprecated
All packages are listed.
https://angular.io/api?status=security-risk&type=package
What is the motivation / use case for changing the behavior?
To cause package list to match selected filter settings.
Environment
Angular version: X.Y.Z
Browser:
- [ ] Chrome (desktop) version XX
- [ ] Chrome (Android) version XX
- [ ] Chrome (iOS) version XX
- [ ] Firefox version XX
- [ ] Safari (desktop) version XX
- [ ] Safari (iOS) version XX
- [ ] IE version XX
- [ ] Edge version XX
For Tooling issues:
- Node version: XX
- Platform:
Others:
Activity
jenniferfell commentedon Aug 28, 2018
@petebacondarwin @jbogarthyde @IgorMinar FYI
petebacondarwin commentedon Aug 29, 2018
As far as I am aware packages do not have their own "status" states, and I don't know how one would compute the state from exports which can be mixed within a package (e.g. some exports could be experimental, while others are deprecated).
So until we decide to apply these states to packages as a whole, I will implement the first option given by @jenniferfell, which is to disable this drop-down when the type is being filtered as "package".
feat(docs-infra): disable "status" selector in API list when displayi…
IgorMinar commentedon Aug 30, 2018
petebacondarwin commentedon Aug 31, 2018
@IgorMinar is that marked in some way in the source code?
feat(docs-infra): disable "status" selector in API list when displayi…
angular-automatic-lock-bot commentedon Sep 14, 2019
This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.
Read more about our automatic conversation locking policy.
This action has been performed automatically by a bot.