search

cloudscape-design / components

React components for Cloudscape Design System
https://cloudscape.design/
Apache License 2.0
2.3k stars 140 forks source link

chore: Updates TopNav API documentation to remove checkbox item support #2417

Closed katiegeorge closed 2 days ago

katiegeorge commented 4 days ago

Description

When we released the latest update to button dropdowns that added support for checkbox items, we kept top navigation out of scope. We need to update the API documentation to indicate this change, to avoid confusing customers.

Related links, issue #, if available: n/a

How has this been tested?

Review checklist _The following items are to be evaluated by the author(s) and the reviewer(s)._ #### Correctness - _Changes include appropriate documentation updates._ - _Changes are backward-compatible if not indicated, see [`CONTRIBUTING.md`](https://github.com/cloudscape-design/components/blob/main/CONTRIBUTING.md#public-apis)._ - _Changes do not include unsupported browser features, see [`CONTRIBUTING.md`](https://github.com/cloudscape-design/components/blob/main/CONTRIBUTING.md#browsers-support)._ - _Changes were manually tested for accessibility, see [accessibility guidelines](https://cloudscape.design/foundation/core-principles/accessibility/)._ #### Security - _If the code handles URLs: all URLs are validated through [the `checkSafeUrl` function](https://github.com/cloudscape-design/components/blob/main/src/internal/utils/check-safe-url.ts)._ #### Testing - _Changes are covered with new/existing unit tests?_ - _Changes are covered with new/existing integration tests?_

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov[bot] commented 4 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.62%. Comparing base (984fcb7) to head (3afd08f).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2417 +/- ## ======================================== Coverage 95.62% 95.62% ======================================== Files 720 720 Lines 19163 19163 Branches 6103 6438 +335 ======================================== + Hits 18324 18325 +1 + Misses 831 830 -1 Partials 8 8 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.