dotCMS / dotCMS/core

[FEAT] Headless UVE: Sidebars

Open
#33,228 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Doc : Needs Doc dotCMS : UVE OKR : Technical User Experience Priority : 3 Average Team : Scout
Dominant language
Java
Stars
970
Forks
486
Avg merge
3d 33m
Merged PRs (30d)
170

Description

Task Title

Add Sidebar support to GQL and also Rendering Libraries

Description

On our latest release we are not able to fetch for sidebar natively, you need to add a custom query on the client page property and handle your own rendering. We need to provide an accessible way to do this with a rendering component as either DotCMSSidebarComponent or modify the current behavior of our Layout Component.

The sidebar can hold N containers and also it can be anything with any behavior, so we need to let the user modify the styles of the parent but keep the same approach as we did on the body for the content on the containers.

Acceptance Criteria
  • Clients should be able to fetch for sidebars, without adding more queries
  • Clients should have an easy way to render sidebars
  • Clients should be able to edit the content on sidebars inside the UVE
  • Clients should be able to see changes in real time when editing
Priority

Medium

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 by tracing the GQL sidebar data path and the existing Layout Component or proposed DotCMSSidebarComponent in the rendering libraries. Check how body containers are fetched, rendered, edited in the UVE, and updated in real time. Done means sidebars can be fetched without custom queries, rendered accessibly, edited in the UVE, and updated live.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, java
Domain
api, content, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.