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

[Feature] API tabs #21

Open
skoropadas opened this issue Mar 1, 2023 · 0 comments
Open

[Feature] API tabs #21

skoropadas opened this issue Mar 1, 2023 · 0 comments
Assignees
Labels
Type: Enhancement New feature or request

Comments

@skoropadas
Copy link
Member

skoropadas commented Mar 1, 2023

Description

At the current moment, we display only one API page for each entity and it's a bit overloaded especially for classes, I think it would be more flexible to start grouping information about entities via tabs.

Proposed solution

For example, Angular Component may have 3 tabs:

  • API - should contain basic information about the component, such as a list of members.
  • References - should contain links to the current entity as a type or function call, or to the component that is using the current one.
  • Framework-specific tab - for Angular, we can display information on which module declared and exports the component, whether it is standalone, and other framework-specific information. We could also add a plugin system in the future to allow users to create custom tabs with the information they want to display.

Alternatives considered

@skoropadas skoropadas added the Type: Enhancement New feature or request label Mar 1, 2023
@skoropadas skoropadas self-assigned this Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant