Overview

Module and theme components are displayed in separate lists in the design. For this reason, the client side needs to be able to be able to distinguish:

  1. module-provided Components
  2. theme-provided Components
  3. JavaScript Components
  4. Blocks
  5. Elements

Proposed resolution

This could be done either by:

  1. providing different endpoints for the different component sources
  2. it could be a single endpoint where the components are categorized (that's a confusing word choice, because of #3459088: Every XB `Component` config entity should have a `category` property, which is independent of this!) based on their source provider's type.

User interface changes

None.

CommentFileSizeAuthor
#10 XB Categories.png71.48 KBlauriii

Issue fork experience_builder-3482393

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

lauriii created an issue. See original summary.

lauriii’s picture

lauriii
he/him
Primary language Finnish
Location Finland
commented
Assigned: Unassigned » wim leers
wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Title: Provide the frontend a way to distinguish module and theme components from one another » [PP-1] Provide the frontend a way to distinguish module and theme components from one another
Issue summary: View changes
Issue tags: +Needs issue summary update
Related issues: +#3482529: Refactor XB internals to not assume /xb-components HTTP API returns only SDC-powered XB Components

#3482529: Refactor XB internals to not assume /xb-components HTTP API returns only SDC-powered XB Components introduces some additional structure that will make this much clearer to land.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Title: [PP-1] Provide the frontend a way to distinguish module and theme components from one another » [PP-1] HTTP API: update /xb-components to specify each `Component`'s `extensionType`
Issue summary: View changes
Issue tags: -Needs issue summary update
Related issues: +#3455975: HTTP API: update /xb-component/{component_id} to list possible prop sources for current entity context

wim leers opened merge request !373

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Title: [PP-1] HTTP API: update /xb-components to specify each `Component`'s `extensionType` » [PP-1] HTTP API: update /xb-components to specify each `Component`'s `extension_type`
Assigned: wim leers » Unassigned
Status: Active » Needs review

Ready! 😊

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Issue tags: +openapi

Trivial update for /openapi.yml, tagging.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Title: [PP-1] HTTP API: update /xb-components to specify each `Component`'s `extension_type` » HTTP API: update /xb-components to specify each `Component`'s `extension_type`

#3482529: Refactor XB internals to not assume /xb-components HTTP API returns only SDC-powered XB Components landed!

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Assigned: Unassigned » longwave

#3475584: Add support for Blocks as Components is in, rebased.

lauriii’s picture

lauriii
he/him
Primary language Finnish
Location Finland
commented
Issue summary: View changes
Status: Needs review » Needs work
StatusFileSize
new XB Categories.png71.48 KB

Discussed this with @longwave and @jessebaker. We believe the extension_type key is too narrow and doesn't account for other needs we have for these. Essentially what we need is information on what is the source of the "component". Potential sources are: Blocks, Theme Components, Module Components, Elements, and JavaScript components. Each of these sources then have categories within itself. Here's a visualization of that:

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Title: HTTP API: update /xb-components to specify each `Component`'s `extension_type` » HTTP API: update /xb-components to specify each `Component`'s `source`
Issue summary: View changes

As per the diagram repurposing this issue to add source.

category will be added in #3459088: Every XB `Component` config entity should have a `category` property which is postponed on the core issue #3474533: ComponentPluginManager must implement CategorizingPluginManagerInterface

longwave opened merge request !419

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Status: Needs work » Needs review

source implementation in MR!419.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Status: Needs review » Needs work
Issue tags: +Needs documentation updates

RTBC as far as I'm concerned, with one exception: docs/components.md should be updated to capture #10, and … why not embed exactly that diagram in that document while we're at it? 😇

wim leers closed merge request !373

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Assigned: longwave » wim leers
Status: Needs work » Needs review
Issue tags: -Needs documentation updates

Added the categories requirement and Mermaid version of #10 to components.md.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Assigned: wim leers » Unassigned
Status: Needs review » Reviewed & tested by the community
wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Assigned: Unassigned » traviscarden

Needs approval from @traviscarden.

traviscarden’s picture

traviscarden commented
Assigned: traviscarden » wim leers

Looks good!

traviscarden’s picture

traviscarden commented
Assigned: wim leers » Unassigned
Status: Reviewed & tested by the community » Fixed

Oops. You asked me to go ahead and merge. Done. 🙂

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.