angular / angular/components

docs: clarify support for ViewEncapsulation.ShadowDom

Open
#13,837 15 comments 29 reactions 0 assignees View on GitHub
area: many docs elements help wanted P2
Dominant language
TypeScript
Stars
25k
Forks
6.8k
Avg merge
1d 8h
Merged PRs (30d)
91

Description

#### 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
1. Notice how the checkboxes aren't themed
1. Open https://stackblitz.com/edit/angular-sbrzfb?file=app/input-overview-example.ts
1. 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

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the two linked StackBlitz examples and the Angular documentation for ViewEncapsulation.ShadowDom. Update the relevant documentation to state the support status and explain the observed theming and styling limitation; done when developers can find that guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.