Skip to content

docs(config): add documentation for scopedSlotTextContentFix#767

Merged
rwaskiewicz merged 3 commits intomasterfrom
rwaskiewicz/document-scoped-slot-text-content-fix
Sep 16, 2021
Merged

docs(config): add documentation for scopedSlotTextContentFix#767
rwaskiewicz merged 3 commits intomasterfrom
rwaskiewicz/document-scoped-slot-text-content-fix

Conversation

@rwaskiewicz
Copy link
Copy Markdown
Member

Add documentation for stenciljs/core#3047

@vercel
Copy link
Copy Markdown

vercel bot commented Sep 3, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

stencil-site – ./

🔍 Inspect: https://vercel.com/ionic/stencil-site/HZWxvaVtpvRrQJ2wNnpnaciMP5VW
✅ Preview: https://stencil-site-git-rwaskiewicz-document-scoped-slot-2cc249-ionic1.vercel.app

stencil-site-ionic-io – ./

🔍 Inspect: https://vercel.com/ionic/stencil-site-ionic-io/7p5eUazjUBP7yh4TWXx4YkKEPA6G
✅ Preview: https://stencil-site-ionic-io-git-rwaskiewicz-document-sc-c346f0-ionic1.vercel.app


### scopedSlotTextContentFix

An experimental flag that when set to `true`, aligns the behavior of invoking the `textContent` getter/setter on a scoped component to act more like a component that uses the shadow DOM. Defaults to `false`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does it behave that makes it more like a component that uses the shadow DOM? This may be unclear if the reader doesn't know what the behavior for a component using shadow DOM is.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the verbiage to point to the spec. That may not be the most user friendly thing TBH, but spelling out every single scenario would be pretty cumbersome. Alternatively, we could link https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent#description, but I don't know if one should be considered "better" than the other - the MDN one is definitely more user friendly, but the spec is, well, the spec 😛 LMK what you think

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah tough call, but I think I would lean more towards MDN. At the end of the day, the docs are meant to be informative and understandable/user friendly, so as long as MDN provides all the necessary info (and I believe it does) I would choose it for its user friendliness.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Done in 4d8076c

@rwaskiewicz rwaskiewicz merged commit 8f42172 into master Sep 16, 2021
@rwaskiewicz rwaskiewicz deleted the rwaskiewicz/document-scoped-slot-text-content-fix branch September 16, 2021 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants