feat: why this API - accessible disclosure widget with focused tests#499
Merged
Merged
Conversation
|
@martinshub-tech Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
LGTM ✅ solid work — thanks for taking this on! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #391
feat: why this API — accessible disclosure widget with focused tests
What
Implements the
WhyApicomponent (src/components/WhyApi.tsx) — a "Why this API?" disclosure widget surfaced on each marketplaceApiCard. It derives a short, human-readable list of recommendation reasons from the API's existing metrics (rating, uptime, latency, price, category) and reveals them through a native toggle/disclosure pattern.Changes
src/components/WhyApi.tsx(modified)style={{}}props with BEM class names (.why-api,.why-api__toggle,.why-api__toggle--open,.why-api__reasons,.why-api__item,.why-api__check,.why-api__text,.why-api__chevron)WhyApiPropsinterface for downstream type safetywhy-api__toggle--openmodifier class so the open state is CSS-targetablebuildReasons(), component-level ARIA guarantee list, design token inventory, and usage examplesrc/components/WhyApi.test.tsx(new)36 focused tests across two suites — all passing:
buildReasons()(20 tests)pricePerCalltakes precedence overpricePerRequestvia??WhyApicomponent (16 tests)aria-expanded="false", list absent)aria-expandedaria-controlswired to listidaria-labelnames the specific APIwhy-api__toggle,why-api__toggle--openadded/removed correctlysrc/index.css(modified)Added self-contained
.why-apiBEM block:--accent,--accent-strong,--muted,--transition-speed)why-api-appearkeyframe) on list openfocus-visiblering matches app-wide focus style (2 px solid--accent, 3 px offset)user-select: noneon decorative glyphs (chevron, check mark)Accessibility (WCAG 2.1 AA)
aria-expanded+aria-controlsdisclosure patternaria-label+role="list"▸▾,✓):aria-hidden="true"Test output