feat: support `clonable` in the shadow option of @Component

Open
#6,833 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
frontend

Research direction

Start by tracing ShadowRootOptions and the @Component decorator into CMP_FLAGS, then inspect createShadowRoot and the existing BUILD.shadowDelegatesFocus path. Add the clonable option through the same flow and verify that attachShadow receives it when enabled, while preserving current behavior when it is absent.

Written by the indexing model from the issue text.

Description

Stencil v5
Prerequisites
Describe the Feature Request

Stencil's createShadowRoot currently builds its options from mode, delegatesFocus and slotAssignment. There is no way for a component author to request clonable, and no way to reach the attachShadow call to set it.

The request is to expose it the same way delegatesFocus and slotAssignment already are.

Describe the Use Case

Any library that measures or duplicates DOM through cloneNode gets an empty element back when it reaches a Stencil shadow component, because the shadow root is silently dropped.

We hit this with AG Grid's column auto-sizing. To size a column to its contents, AG Grid deep clones the cell into an off screen container, reads offsetWidth, then discards the dummy clone. When a cell contains a Stencil shadow component the clone is an empty shell, so the measurement comes back at zero and the column collapses to the width of its header.

Describe Preferred Solution

Mirror the native option, exactly as the existing two options.

  1. Add a clonable option to ShadowRootOptions.
  2. Add a shadowClonable bit to CMP_FLAGS, set from the decorator at compile time.
  3. Set it in createShadowRoot, behind a build flag like the existing BUILD.shadowDelegatesFocus.
Describe Alternatives

Patching the runtime.

Related Code

No response

Additional Information

No response

Dominant language
TypeScript
Stars
13.1k
Forks
855
Avg merge
4h 7m
Merged PRs (30d)
44

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.

More from stenciljs/core

All issues in stenciljs/core

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.