search

AlaskaAirlines / auro-sidenav

Custom element that provides users a way to create navigational interfaces
https://auro.alaskaair.com/components/auro/sidenav
Apache License 2.0
0 stars 1 forks source link

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

Closed blackfalcon closed 7 months ago

blackfalcon commented 8 months ago

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.

Patrick-Daly-AA commented 8 months ago

Reference other multi-element components like Auro Radio for examples

jordanjones243 commented 7 months ago

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