angular/components

docs: clarify support for ViewEncapsulation.ShadowDom

Open

#13,837 建立於 2018年10月26日

在 GitHub 查看
 (15 留言) (29 反應) (0 負責人)TypeScript (24,044 star) (6,650 fork)batch import
P2area: manydocselementshelp wanted

描述

Proposal

What is the expected behavior?

If ViewEncapsulation.ShadowDom is not supported, this should be called out in the docs to save developers time and frustration.

What is the current behavior?

ViewEncapsulation.ShadowDom is not supported and is not documented.

What are the steps to reproduce?

  1. Open https://stackblitz.com/edit/angular-i5jw3k?file=app/table-selection-example.ts
  2. Notice how the checkboxes aren't themed
  3. Open https://stackblitz.com/edit/angular-sbrzfb?file=app/input-overview-example.ts
  4. Notice how the inputs are not themed or styled properly

What is the use-case or motivation for changing an existing behavior?

To save developers time and frustration.

Which versions of Angular, Material, OS, TypeScript, browsers are affected?

Angular: 7.0.0 Angular Material: 7.0.2 TypeScript: ~3.1.1 Browsers: Tested on Chrome, Firefox, and Safari latest stable versions

Is there anything else we should know?

Nope

貢獻者指南

技術棧
typescripthtmlcss
領域
documentationfrontend
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
basic Angular knowledgefamiliarity with ViewEncapsulation
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
First, locate the documentation for Angular Material components, likely in the `guides` or `cdk` directory of the repository (e.g., `guides/theming.md` or `cdk/a11y/README.md`). Look for any existing sections on styling or view encapsulation. Then, add a clear note that `ViewEncapsulation.ShadowDom` is not supported for Material components, explaining the impact (e.g., checkboxes and inputs losing themes) and recommend using `ViewEncapsulation.Emulated` or `None` instead. Reference the StackBlitz examples provided in the issue to illustrate the problem. Finally, update the component API docs where relevant to mention this limitation.