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

sidenav is not building full API for full scope of component #15

Closed
blackfalcon opened this issue Feb 22, 2024 · 2 comments · Fixed by #20
Closed

sidenav is not building full API for full scope of component #15

blackfalcon opened this issue Feb 22, 2024 · 2 comments · Fixed by #20
Assignees
Labels
auro-sidenav good first issue Good for newcomers Type: Bug Bug or Bug fixes

Comments

@blackfalcon
Copy link
Member

Please verify the version of auro-sidenav you have installed

@latest

Please describe the bug

In reviewing the page in the Auro doc site, I noticed that the API page only references the API from the sidenav element itself, not the sidenavitem element too.

This is clear from this line in the package.json

    "build:api": "wca analyze 'src/auro-sidenav.js' --outFiles docs/api.md",

Reproducing the error

This issue is reproducible on the Auro docsite

Expected behavior

The dynamic API documentation should be exported for the full scope of the element.

What browsers are you seeing the problem on?

Firefox, Chrome, Safari, Microsoft Edge

Additional context

none

Exit criteria

This issue can be closed once the API docs are filly exported and all examples are illustrated in the API pages for this component.

@blackfalcon blackfalcon added auro-sidenav not-reviewed Issue has not been reviewed by Auro team members Type: Bug Bug or Bug fixes labels Feb 22, 2024
@Patrick-Daly-AA Patrick-Daly-AA added good first issue Good for newcomers and removed not-reviewed Issue has not been reviewed by Auro team members labels Feb 22, 2024
@Patrick-Daly-AA
Copy link

Reference other multi-element components like Auro Radio for examples

@jordanjones243
Copy link
Contributor

This issue was fixed by the work done in this PR:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auro-sidenav good first issue Good for newcomers Type: Bug Bug or Bug fixes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants