Add Data Grid and HTML Table guides#196
Conversation
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.
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello, 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
Changelog
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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.
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.
flxlst09
left a comment
There was a problem hiding this comment.
Thanks for bringing this forward, no usage guide for one of our most used components was not satisfying. Minor suggestions for changes.
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.
Co-authored-by: tokyojen <143795032+tokyojen@users.noreply.github.com>
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
👨💻 Help & support
IX-1770