Decide if SDDS SDCs should include props from included components

kristen pol → credited anand.toshniwal93 → .

Credit to Anand.

Add parent.

Looking at experience_builder/components/simple/shoe_button, it has:

shoe_button.twig

  {% if icon %}
    {{ include('experience_builder:shoe_icon', icon, with_context = false) }}
  {% endif %}

shoe_button.component.yml

    icon:
      title: Icon
      $ref: json-schema-definitions://experience_builder.module/shoe-icon
      type: object

One thing to note also is that all of their yaml files start with:

'$schema': 'https://git.drupalcode.org/project/sdc/-/raw/1.x/src/metadata.schema.json'

so based on this, it looks like we need to:

1. Update our included components to use the schema definition
2. Remove any included component props from their parent
3. Ideally, update the script to handle for new components

I should note that getting XB to run requires using vanilla core (you can't use Drupal CMS right now!) so I'm in the middle of updating docs and things are a bit "sideways" at the moment.

Note this related issue for slots:

🐛 SDC incorrectly throws an exception about embedded slots Needs work

I have updated script as per the below comment

https://www.drupal.org/project/demo_design_system/issues/3469495#comment... 📌 Decide if SDDS SDCs should include props from included components Needs review

Assigning to me.

Assigning to Jacob for thoughts.

I think it depends on how we see examples being used. If we're able to successfully get an example's content working in referenced to included props without them being present in the yml then we don't need to include included props.

Fair enough. Which means this one goes back to being blocked by the XB blockers.

Back to active since we are still waiting.

Shoe button isn't even showing up in the component list anymore.

For now, we should just include all the props for the included/embeded components.

Later, we may want to define our own schemas and do something like:

icon:
      title: Icon
      $ref: json-schema-definitions://experience_builder.module/shoe-icon
      type: object

I did play around with adding our own schemas and it wasn't super straightforward so I've parked it. I'll make an issue as a future thing so we don't forget about it.

Added issue, closing this one.

📌 Evaluate creating schema.json for SDDS Postponed