layer5io / layer5io/layer5

[Sistent] Add UniversalFilter component to the sistent components page

Open Beginner friendly
#7,984 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

framework/gatsby language/markdown project/sistent
Dominant language
JavaScript
Stars
1.1k
Forks
1.6k
Avg merge
2d 10h
Merged PRs (30d)
18

Description

Current Behavior

Layer5 and its projects use the Sistent library to enable component reuse across various projects.
The UniversalFilter is one of the core filtering components available in Sistent, but it is currently not represented in the centralized Sistent component documentation at https://layer5.io/projects/sistent/components.
Adding documentation for UniversalFilter will provide a clear reference for its usage, guidelines, and examples, helping developers understand and reuse the component consistently across Layer5 projects.

Desired Behavior

Add proper documentation for the UniversalFilter component, following the same structure used by other documented Sistent components.
The documentation should follow the new Sistent MDX documentation structure by creating the following files under:
src/collections/sistent/components/universal-filter/

  • index.mdx: Overview of the UniversalFilter component for multi-attribute filtering across tables and catalogs.
  • guidance.mdx: Filter schemas, date-range picker integrations, quick date options, and active filters handling.
  • code.mdx: Code examples demonstrating multi-select column filtering, search inputs, and date pickers using <ThemeWrapper> and <CodeBlock>.

The completed documentation should be available on the Sistent components page and provide a centralized reference for developers using UniversalFilter.

Environment:
  • Host OS:
  • Browser:

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/custom/UniversalFilter.tsx and compare the existing component documentation structure under src/collections/sistent/components/. Create index.mdx, guidance.mdx, and code.mdx under src/collections/sistent/components/universal-filter/, then verify the UniversalFilter documentation appears on the Sistent components page.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
84/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.