Skip to content

[Sistent] Add Data Table component to the Sistent components page #7681

@rishiraj38

Description

@rishiraj38

Current Behavior

Layer5 and its projects use the Sistent library to enable easy component reusability. One of the most critical and frequently used components is the ResponsiveDataTable.
Currently, this component lacks representation on our centralized components page. Maintaining consistent usage and example documentation is essential for aiding new contributors.

Technical Context

The ResponsiveDataTable is a high-level wrapper around @sistent/mui-datatables (a Layer5-maintained fork). This documentation should focus on how to use the Sistent wrapper while linking to the upstream library for advanced property references.

Desired Behavior

Add documentation for the Data Table component following the Sistent MDX structure. Create a new directory at src/collections/sistent/components/data-table/ with the following files:

  1. index.mdx: Overview of the component and its purpose (managing complex datasets).
  2. guidance.mdx: Best practices for usage, column labeling, and responsiveness.
  3. code.mdx: Live code examples using <ThemeWrapper> and <CodeBlock>. Examples should include:
    • Basic Data Table (Sorting/Pagination).
    • Column Visibility Control.
    • Custom Cell Rendering (e.g., dates).

Reference Implementation

A contributor can find the source logic and current usage here:

Template Reference

You can follow the existing Button component documentation for structure and style.


Contributor Resources and Handbook

The layer5.io website uses Gatsby, React, and GitHub Pages. Site content is found under the master branch.

Join the Layer5 Community by submitting your community member form.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions