docs(core/content-header): Add docs for content-header responsive behavior - #274
docs(core/content-header): Add docs for content-header responsive behavior#274dmytro-halimov wants to merge 4 commits into
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
❌ Deploy Preview for industrial-experience failed.
|
📝 WalkthroughWalkthroughThe content header documentation adds a truncation playground and explains responsive wrapping, optional truncation, alignment, overflow handling, and recommended action patterns. ChangesContent header documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/components/content-header/guide.md`:
- Line 52: Update the textOverflow documentation to require an accessible
alternative for truncated titles and subtitles, rather than relying solely on
native browser tooltips; document an accessible text or disclosure mechanism
that exposes the complete values when needed.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 54d22b51-2b57-4897-8d4f-97bdfa4879b9
📒 Files selected for processing (2)
docs/components/content-header/code.mdxdocs/components/content-header/guide.md
| - Content in the header slot remains beside the title and aligned with its first line. | ||
| - The back button and action buttons remain aligned with the first title line. | ||
|
|
||
| Set the `textOverflow` property to `truncate` only when the header must retain a compact height. In HTML, use `text-overflow="truncate"`. In this mode, the title and subtitle each use a single line and are truncated with an ellipsis when needed. The complete values remain available as native browser tooltips. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Treat the native tooltip as supplemental.
Do not present a native browser tooltip as the only way to access a truncated title or subtitle. title content is not consistently available to keyboard users or all assistive technologies. Document an accessible text or disclosure alternative when the full value is required.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/components/content-header/guide.md` at line 52, Update the textOverflow
documentation to require an accessible alternative for truncated titles and
subtitles, rather than relying solely on native browser tooltips; document an
accessible text or disclosure mechanism that exposes the complete values when
needed.
Main Repo PR: siemens/ix#2702
🆕 What is the new behavior?
Summary by CodeRabbit