Skip to content

Add Data Grid and HTML Table guides#196

Merged
danielleroux merged 11 commits intomainfrom
docs/usage-guide-tables
Mar 26, 2026
Merged

Add Data Grid and HTML Table guides#196
danielleroux merged 11 commits intomainfrom
docs/usage-guide-tables

Conversation

@kathrinschalber
Copy link
Copy Markdown
Collaborator

@kathrinschalber kathrinschalber commented Mar 11, 2026

Add two new component usage guides: docs/components/grid/guide.md (Data Grid / AG Grid) and docs/components/html-grid/guide.md (HTML Table). Each guide includes options, behavior patterns (sorting, filtering, grouping, selection, actions), states, dos/don'ts, and related links, and uses the 'tab-item' front matter. These docs provide UX and implementation guidance for using data grids and HTML tables in the app.

💡 What is the current behavior?

We dont have any usage guides for AG Grid and normal HTML table

GitHub Issue Number: #

🆕 What is the new behavior?

Added guides for both

  • Grid (AG Grid)
  • HTML Grid (regular table)

👨‍💻 Help & support

IX-1770

Add two new component usage guides: docs/components/grid/guide.md (Data Grid / AG Grid) and docs/components/html-grid/guide.md (HTML Table). Each guide includes options, behavior patterns (sorting, filtering, grouping, selection, actions), states, dos/don'ts, and related links, and uses the 'tab-item' front matter. These docs provide UX and implementation guidance for using data grids and HTML tables in the app.
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 11, 2026

Deploy Preview for industrial-experience ready!

Name Link
🔨 Latest commit 3a985e3
🔍 Latest deploy log https://app.netlify.com/projects/industrial-experience/deploys/69c5269e72f76b0008f6c9c2
😎 Deploy Preview https://deploy-preview-196--industrial-experience.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces essential documentation for Data Grids (AG Grid) and HTML Tables, aiming to standardize their usage and interaction patterns across applications. The new guides provide detailed insights into their capabilities, behaviors, and best practices, ensuring developers and designers have clear references for implementing these complex data presentation components.

Highlights

  • New Documentation Guides: Two new component usage guides have been added for Data Grids (AG Grid) and standard HTML Tables, providing comprehensive UX and implementation guidance.
  • Comprehensive Content: Each guide details options, behavior patterns (sorting, filtering, grouping, selection, actions), various states, best practices (dos/don'ts), and related links.
  • Sidebar Integration: The documentation sidebar has been updated to include these new 'Usage' guides under their respective component sections, enhancing navigation.
Changelog
  • docs/components/grid/guide.md
    • Added a new guide for Data Grid (AG Grid) usage, covering options, behavior, states, and best practices.
  • docs/components/html-grid/guide.md
    • Added a new guide for HTML Table usage, detailing options, behavior, states, and best practices.
  • sidebars.ts
    • Integrated the new Data Grid and HTML Table usage guides into the documentation sidebar navigation.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces two new, comprehensive usage guides for Data Grid and HTML Table components. The documentation is well-structured. My review focuses on ensuring adherence to the repository's documentation style guide. I've identified a few areas for improvement, primarily concerning the use of correct typographical characters (apostrophes), the formatting of the 'States' section, and maintaining a suggestive tone as outlined in the guidelines. I have provided specific code suggestions to help align the new guides with the established style.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment thread docs/components/grid/guide.md Outdated
Comment thread docs/components/grid/guide.md Outdated
Comment thread docs/components/grid/guide.md Outdated
Comment thread docs/components/html-grid/guide.md Outdated
Comment thread docs/components/html-grid/guide.md Outdated
Comment thread docs/components/html-grid/guide.md Outdated
Comment thread docs/components/html-grid/guide.md Outdated
kathrinschalber and others added 4 commits March 11, 2026 14:53
Update documentation for data grids and HTML tables: replace Figma illustration links and clarify the "States" sections. Reworded and reorganized state descriptions to introduce a default state and provide per-state guidance (sorted, filtered, selected, loading, grouped, edit mode / no results as applicable). Also made a small copy tweak recommending not to mix row-click behaviors. These are editorial/content improvements to improve consistency and clarity.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Refactor docs for Data Grid and HTML Table: streamline content, reorder and consolidate options and behavior sections, add links to AG Grid and MDN references, and simplify lists of features and states. Replace verbose behavior blocks with concise, structured outlines and add illustrative Figma images. Added two new image assets under static/figma and updated docs/components/grid/guide.md and docs/components/html-grid/guide.md accordingly.
Copy link
Copy Markdown
Collaborator

@flxlst09 flxlst09 left a comment

Choose a reason for hiding this comment

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

Thanks for bringing this forward, no usage guide for one of our most used components was not satisfying. Minor suggestions for changes.

Comment thread docs/components/grid/guide.md
Comment thread docs/components/grid/guide.md Outdated
Comment thread docs/components/grid/guide.md Outdated
Comment thread docs/components/grid/guide.md Outdated
Comment thread docs/components/grid/guide.md
Enhance the Data Grid (AG Grid) documentation: add a brief AG Grid overview, link feature items to AG Grid docs, introduce alternate row styling, clarify grouping/selection/inline-editing and column visibility/reordering, and update detail view to reference modals and panes. Add an Overflow behavior note, include a new Figma image showing grid states, adjust Dos and Don'ts wording, and expand Related links (key-value list, KPI, modal). Also add the corresponding static Figma asset.
@kathrinschalber kathrinschalber marked this pull request as ready for review March 25, 2026 11:56
tokyojen
tokyojen previously approved these changes Mar 25, 2026
Comment thread docs/components/grid/guide.md
Comment thread docs/components/grid/guide.md Outdated
Comment thread docs/components/grid/guide.md Outdated
Comment thread docs/components/html-grid/guide.md Outdated
Comment thread docs/components/html-grid/guide.md Outdated
Comment thread docs/components/html-grid/guide.md Outdated
Co-authored-by: tokyojen <143795032+tokyojen@users.noreply.github.com>
@danielleroux danielleroux added this to the 4.4.0 milestone Mar 26, 2026
@danielleroux danielleroux merged commit 40a4e04 into main Mar 26, 2026
5 checks passed
@danielleroux danielleroux deleted the docs/usage-guide-tables branch March 26, 2026 15:20
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.

4 participants