Skip to content

docs(core/content-header): Add docs for content-header responsive behavior - #274

Open
dmytro-halimov wants to merge 4 commits into
mainfrom
fix/content-header-responsive-fix
Open

docs(core/content-header): Add docs for content-header responsive behavior#274
dmytro-halimov wants to merge 4 commits into
mainfrom
fix/content-header-responsive-fix

Conversation

@dmytro-halimov

@dmytro-halimov dmytro-halimov commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Main Repo PR: siemens/ix#2702

🆕 What is the new behavior?

  • Document responsive title and subtitle wrapping in ix-content-header.
  • Explain explicit truncation and consumer-managed action overflow.
  • Add the truncation example to the component’s code page.

Summary by CodeRabbit

  • Documentation
    • Added guidance for responsive title and subtitle wrapping.
    • Documented optional text truncation and default wrapping behavior.
    • Added recommendations for aligning header actions and handling secondary actions responsively.
    • Updated Dos and Don’ts to help prevent text and action-label overlap.

@dmytro-halimov
dmytro-halimov requested review from a team as code owners August 10, 2026 09:31
@netlify

netlify Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploy Preview for industrial-experience failed.

Name Link
🔨 Latest commit 62b311e
🔍 Latest deploy log https://app.netlify.com/projects/industrial-experience/deploys/6a799a6ddcc5920008cb7bb4

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The content header documentation adds a truncation playground and explains responsive wrapping, optional truncation, alignment, overflow handling, and recommended action patterns.

Changes

Content header documentation

Layer / File(s) Summary
Responsive text and truncation guidance
docs/components/content-header/code.mdx, docs/components/content-header/guide.md
The code documentation adds the truncation playground. The guide documents responsive wrapping, optional truncation with tooltips, alignment, overflow handling, and related Dos and Don’ts.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: danielleroux

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change and its focus on responsive behavior in content-header.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/content-header-responsive-fix

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b6ce63 and 62b311e.

📒 Files selected for processing (2)
  • docs/components/content-header/code.mdx
  • docs/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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 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.

@nuke-ellington
nuke-ellington changed the base branch from main to release/v5.2.0 August 13, 2026 15:27
@nuke-ellington
nuke-ellington changed the base branch from release/v5.2.0 to main August 14, 2026 12:22
Sign up for free to 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.

1 participant