@sshmaxime/design-system

Web Design System 🧑‍🎨

Welcome to the Component UI repository for Ledger !

This repository houses a collection of reusable components designed to streamline and enhance the user interface across various projects within our organization. Whether you're working on a web applications, LLD or any other web-based platform, these components are crafted to ensure consistency, efficiency, and aesthetic appeal.

Feel free to explore, contribute, and use these components to elevate the design and functionality of our projects. We encourage collaboration and feedback from all team members to continuously improve and expand our UI component library.

Features

• Reusable Components: A wide range of UI components crafted by our design team to for our various design needs.

• Client Components: Some of these components uses hooks (useState or others) and therefore needs to be marked as client components to be used in Next.js project. Therefore, you'll notice that they have the use client; directives at their top. It's very important and handful if we want to be as flexible as possible.

• Easy Integration: Simple integration process into existing or new projects.

• Customizable: Components are designed to be flexible and customizable to fit specific project requirements within a certain limit.

• Auto-documentation: Detailed documentation is provided by default for each component for easy understanding and implementation.

Known issues

TailwindCSS

There currently is a slight overlap in CSS that currently prevent us to have a smooth design if using TailwindCSS. This PR addresses it: https://github.com/tailwindlabs/tailwindcss/pull/12735. It has been merged but it isn't yet out because there hasn't been a new release of Tailwind since then.

In order to fix that we can patch the Tailwind library in the host project.

Sourcemap

When building the library, you might encounter this error: Error when using sourcemap for reporting an error: Can't resolve original location of error.. It's a known issue and a simple warning from Rollup. You can safely ignore it.

Contributions

We welcome contributions from all team members! If you have ideas for new components, improvements to existing ones, or bug fixes, feel free to open an issue or submit a pull request.

Let's collaborate to create a robust and efficient UI component library for our company!

TODO:

• Add proper colors to the light theme

Contact

If you have any questions, suggestions, or need assistance, please don't hesitate to contact @sshmaxime.