Skip to content

[Docs] Add table layout guidelines#9541

Open
tkajtoch wants to merge 2 commits intoelastic:mainfrom
tkajtoch:docs/column-guidelines
Open

[Docs] Add table layout guidelines#9541
tkajtoch wants to merge 2 commits intoelastic:mainfrom
tkajtoch:docs/column-guidelines

Conversation

@tkajtoch
Copy link
Copy Markdown
Member

@tkajtoch tkajtoch commented Mar 30, 2026

Summary

Resolves #9527

This PR adds table layout guidelines as part of the tables sweep initiative.

API Changes

N/A; Documentation only

Screenshots

screencapture-eui-elastic-co-pr-9541-docs-components-tables-layout-guidelines-2026-03-31-14_31_14

Impact Assessment

  • [ ]~ 🔴 Breaking changes — What will break? How many usages in Kibana/Cloud UI are impacted?~
  • 💅 Visual changes — May impact style overrides; could require visual testing. Explain and estimate impact.
  • 🧪 Test impact — May break functional or snapshot tests (e.g., HTML structure, class names, default values).
  • 🔧 Hard to integrate — If integration is complex, stage commits in Kibana/Cloud UI branches for cherry-picking and link to them below.

Impact level: 🟢 None

Release Readiness

  • Documentation: {link to docs page(s)}
  • Figma: {link to Figma or issue}
  • Migration guide: {steps or link, for breaking/visual changes or deprecations}
  • Adoption plan (new features): {link to issue/doc or outline who will integrate this and where}

QA instructions for reviewer

Checklist before marking Ready for Review

Reviewer checklist

  • Approved Impact Assessment — Acceptable to merge given the consumer impact.
  • Approved Release Readiness — Docs, Figma, and migration info are sufficient to ship.

@tkajtoch tkajtoch self-assigned this Mar 30, 2026
@tkajtoch tkajtoch requested a review from a team as a code owner March 30, 2026 12:52
@tkajtoch tkajtoch added documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog Use on PRs to skip changelog requirement (Don't delete - used for automation) labels Mar 30, 2026
@elasticmachine
Copy link
Copy Markdown
Collaborator

💚 Build Succeeded

History

cc @tkajtoch

@elasticmachine
Copy link
Copy Markdown
Collaborator

elasticmachine commented Mar 30, 2026

💚 Build Succeeded

History

cc @tkajtoch

@weronikaolejniczak weronikaolejniczak self-requested a review March 31, 2026 10:29
@JasonStoltz JasonStoltz requested review from JasonStoltz and removed request for weronikaolejniczak March 31, 2026 13:38
Copy link
Copy Markdown
Member

@JasonStoltz JasonStoltz left a comment

Choose a reason for hiding this comment

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

My overall impression: This is too verbose and text heavy.

A few suggestions:

  • Structure this as Dos and Dont's or make it more "rules" based.
  • Add examples
  • Make text concise -- the intro, for example.

Ex.

Current:

## Layout and scrolling
Enable scrollableInline={true} and tableLayout="auto" to allow horizontal scrolling on overflow to maintain usability across different viewports.

Whenever creating a table, always consider all possible viewport and container sizes, and especially smaller resolutions, even if the application doesn't explicitly support mobile devices. This helps to maintain usability even when push flyouts are open or other container-affecting components are rendered.
...

What is the rule here? Lead with that.
When should we apply this rule, and when should we NOT apply this rule? And if it's a gray area, how do we make that decision?
What does that look like?

Potential option:

## Enable horizontal scrolling

**Always design tables for the narrowest container they may appear in** -- including
states where push flyouts, sidebars, or other elements reduce available width.Enable horizontal scrolling

Set `scrollableInline={true}` and `tableLayout="auto"` so the table scrolls
horizontally on overflow rather than compressing columns into illegibility.

:::tip
Test your table at ~600 px width or with a push flyout open.
If columns become unreadable, horizontal scrolling should take over.
:::
  • Can we tie this together with Kibana utils? Something we do this elsewhere:
:::note Kibana engineers

Kibana provides presets which do {xyz}. You can read more here {link to presets}
We enforce these guidelines in Kibana with lint rules, which are here {link to lint rules}

:::

@JasonStoltz
Copy link
Copy Markdown
Member

I had cursor rewrite what you provided. Don't use this exactly, but do use it as an illustration of the feedback I left.

screencapture-localhost-3000-docs-components-tables-layout-guidelines-2026-03-31-15_14_05

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog Use on PRs to skip changelog requirement (Don't delete - used for automation)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Tables sweep] Add tabular content guidelines

3 participants