Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: [ADR-0004] use RadixUI #741

Merged
merged 6 commits into from
Jul 21, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions doc/adr/0004-use-radix-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 1. Record architecture decisions

Date: 2023-07-17

## Status

Accepted


## Context

In our project, we have identified the need for a set of UI components that handle not only the logical part but also the design aspects. We have evaluated existing libraries such as Radix and Headless UI, which provide components with implicit designs.
Amzani marked this conversation as resolved.
Show resolved Hide resolved

We have concluded that using a ready-made library would restrict our freedom to customize the look and feel of the components. Additionally, these libraries integrate design elements into their components, making it challenging or impossible to modify them according to our specific requirements.
Amzani marked this conversation as resolved.
Show resolved Hide resolved

This is related to [ADR-003](./0003-use-design-system.md).

## Decision

After careful evaluation, we have decided to use Radix UI. This decision was driven by the following factors:

- **Flexibility**: By creating our own components, we gain complete freedom to define the design and visual aspects according to our specific needs and branding.

- **Logic Integration**: Building our own components allows us to integrate both the logical and design aspects seamlessly. We can ensure that our components handle keyboard navigation, support screen readers, check for rendering space, and avoid collisions with window limits.

- **Maintenance and Community Support**: We have selected Radix as our preferred library due to its completeness, active maintenance, and vibrant community.

## Consequences

The decision to build our own UI components instead of using existing libraries will have the following consequences:

- **Increased Development Effort and maintenance**: Developing custom UI components requires additional time and effort compared to adopting an existing library.

- **Design Consistency Responsibility**: With the freedom to define our own components, we also bear the responsibility of maintaining design consistency across the application. We must establish design guidelines and ensure that all components adhere to them, promoting a cohesive and intuitive user interface.

- **Reduced Dependency on External Libraries**: By building our own components, we reduce our reliance on external libraries and minimize the risk of being tied to their specific look and feel. This independence allows us to evolve and iterate on the components based on our unique requirements, providing long-term flexibility.

By carefully considering these consequences and actively managing the development and maintenance process, we believe that building our own UI components will provide us with the flexibility, control, and customization required to deliver an outstanding studio user experience.