Skip to content

📚 Clarify that buttons are styled links - #287

Merged
chrisjsewell merged 1 commit into
mainfrom
docs/button-links-intro
Jul 15, 2026
Merged

📚 Clarify that buttons are styled links#287
chrisjsewell merged 1 commit into
mainfrom
docs/button-links-intro

Conversation

@chrisjsewell

@chrisjsewellchrisjsewell commented Jul 15, 2026

Copy link
Copy Markdown
Member

Carries the documentation clarification from #158 (thanks @gabalafou — the commit is authored to you) forward onto the current docs:

  • The Buttons intro now explains that button-link/button-ref are links styled as buttons, and that plain link syntax is usually the right tool — these directives are for calling visual attention to a link.
  • Adds the accessibility admonition: the output is an <a> tag, not <button>, so assistive tech treats them as links (e.g. they appear in links lists).
  • Drops the stale Material Design/Bootstrap "further details" sentence.

The original PR's snippet/fixture additions are not carried: they predate three rewrites of this docs page and the button test-suite additions (#281's tests/test_buttons.py now covers button-ref rendering directly), so only the prose — the durable part — comes forward, lightly adapted.

Supersedes #158 (will be closed with credit once this merges).

@codecov

codecovBot commented Jul 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.63%. Comparing base (05d61f3) to head (1ae7382).

Additional details and impacted files
@@ Coverage Diff @@## main #287 +/- ##
=======================================
Coverage 92.63% 92.63% =======================================
Files 13 13 Lines 1371 1371 =======================================
Hits 1270 1270 Misses 101 101 
FlagCoverage Δ
pytests92.63% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Carried from PR #158, updated for the current docs: explains that
button-link/button-ref render as styled <a> tags (not <button>), when to
prefer plain link syntax, and the accessibility implications.
@chrisjsewell
chrisjsewellforce-pushed the docs/button-links-intro branch from f82e96f to 1ae7382CompareJuly 15, 2026 11:47
@chrisjsewell
chrisjsewell merged commit 9d1140f into mainJul 15, 2026
25 checks passed
@chrisjsewell
chrisjsewell deleted the docs/button-links-intro branch July 15, 2026 13:05
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@chrisjsewell@gabalafou