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

Config-based List and Detail Views in Admin UI #3123

Open
dlhck opened this issue Oct 9, 2024 · 1 comment
Open

Config-based List and Detail Views in Admin UI #3123

dlhck opened this issue Oct 9, 2024 · 1 comment
Labels
dx 💙 Quality of life improvements for developers type: feature ✨ @vendure/admin-ui
Milestone

Comments

@dlhck
Copy link
Collaborator

dlhck commented Oct 9, 2024

Description

  • While creating custom entities in Vendure is a streamlined process with a great developer experience, displaying and managing these entities in the Admin UI currently requires manual work. Developers need to create custom Angular components for both list and detail views, along with custom forms to manage the data.
  • Although this provides flexibility for tailoring the Admin UI to specific business workflows, it can be overly complex when the goal is simply to enable admin users to create, update, or read custom entities.
  • The config-based list and detail views will leverage Vendure's Typescript-based configuration system, similar to the one used for custom fields. This will allow developers to define custom UI extensions for custom entities without needing to write Angular code. The system will automatically generate list and detail views in the Admin UI, significantly improving the developer experience and speeding up the development process.

Motivation

  • Simplify the process of exposing custom entities in the Admin UI by reducing the need for custom Angular components and forms.
  • Enable rapid development by automating the generation of list and detail views through a configuration-based approach.
  • Maintain flexibility for more complex cases while offering a streamlined path for simpler use cases where custom entities need to be managed in the Admin UI.

Proposed Solution

  • Implement a configuration-based system, similar to custom fields, that allows developers to define list and detail views for custom entities through TypeScript-based config files.
  • Automatically generate the necessary UI components for list and detail views in the Admin UI without the need for manual Angular coding.
  • Ensure that this approach integrates smoothly with existing custom fields and Admin UI extensions, enabling developers to mix custom code with configuration-based setups as needed.

Additional Context

The goal is to enhance the developer experience and accelerate development workflows by reducing the overhead involved in exposing custom entities in the Admin UI. This will help developers build faster without sacrificing the ability to customize workflows where needed.

This will be done together with #2903

@dlhck dlhck added @vendure/admin-ui type: feature ✨ dx 💙 Quality of life improvements for developers labels Oct 9, 2024
@dlhck dlhck added this to the v3.2.0 milestone Oct 9, 2024
@kkerti
Copy link

kkerti commented Oct 9, 2024

I think this would make dev ex way better! Looking forward to this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx 💙 Quality of life improvements for developers type: feature ✨ @vendure/admin-ui
Projects
Status: 📅 Planned
Development

No branches or pull requests

2 participants