angular-cn/aio/content/guide/component-styles.md

356 lines
15 KiB
Markdown
Raw Normal View History

# Component Styles
2017-03-31 19:57:13 -04:00
2017-03-06 05:43:33 -05:00
Angular applications are styled with standard CSS. That means you can apply
everything you know about CSS stylesheets, selectors, rules, and media queries
directly to Angular applications.
2017-03-06 05:43:33 -05:00
Additionally, Angular can bundle *component styles*
with components, enabling a more modular design than regular stylesheets.
2017-03-06 05:43:33 -05:00
This page describes how to load and apply these component styles.
You can run the <live-example></live-example> in Stackblitz and download the code from there.
2017-03-31 19:57:13 -04:00
2017-03-06 05:43:33 -05:00
## Using component styles
2017-03-06 05:43:33 -05:00
For every Angular component you write, you may define not only an HTML template,
but also the CSS styles that go with that template,
2017-03-06 05:43:33 -05:00
specifying any selectors, rules, and media queries that you need.
One way to do this is to set the `styles` property in the component metadata.
The `styles` property takes an array of strings that contain CSS code.
2017-03-06 05:43:33 -05:00
Usually you give it one string, as in the following example:
<code-example path="component-styles/src/app/hero-app.component.ts" header="src/app/hero-app.component.ts"></code-example>
## Style scope
<div class="alert is-critical">
The styles specified in `@Component` metadata _apply only within the template of that component_.
</div>
They are _not inherited_ by any components nested within the template nor by any content projected into the component.
In this example, the `h1` style applies only to the `HeroAppComponent`,
not to the nested `HeroMainComponent` nor to `<h1>` tags anywhere else in the application.
2017-03-31 19:57:13 -04:00
This scoping restriction is a ***styling modularity feature***.
2017-03-31 19:57:13 -04:00
* You can use the CSS class names and selectors that make the most sense in the context of each component.
* Class names and selectors are local to the component and don't collide with
2017-03-06 05:43:33 -05:00
classes and selectors used elsewhere in the application.
2017-03-06 05:43:33 -05:00
* Changes to styles elsewhere in the application don't affect the component's styles.
2017-03-06 05:43:33 -05:00
* You can co-locate the CSS code of each component with the TypeScript and HTML code of the component,
which leads to a neat and tidy project structure.
2017-03-06 05:43:33 -05:00
* You can change or remove component CSS code without searching through the
whole application to find where else the code is used.
{@a special-selectors}
## Special selectors
2017-03-06 05:43:33 -05:00
Component styles have a few special *selectors* from the world of shadow DOM style scoping
(described in the [CSS Scoping Module Level 1](https://www.w3.org/TR/css-scoping-1) page on the
2017-03-06 05:43:33 -05:00
[W3C](https://www.w3.org) site).
The following sections describe these selectors.
### :host
Use the `:host` pseudo-class selector to target styles in the element that *hosts* the component (as opposed to
2017-03-06 05:43:33 -05:00
targeting elements *inside* the component's template).
<code-example path="component-styles/src/app/hero-details.component.css" region="host" header="src/app/hero-details.component.css"></code-example>
2017-03-06 05:43:33 -05:00
The `:host` selector is the only way to target the host element. You can't reach
the host element from inside the component with other selectors because it's not part of the
component's own template. The host element is in a parent component's template.
Use the *function form* to apply host styles conditionally by
including another selector inside parentheses after `:host`.
2017-03-06 05:43:33 -05:00
The next example targets the host element again, but only when it also has the `active` CSS class.
<code-example path="component-styles/src/app/hero-details.component.css" region="hostfunction" header="src/app/hero-details.component.css"></code-example>
### :host-context
2017-03-06 05:43:33 -05:00
Sometimes it's useful to apply styles based on some condition *outside* of a component's view.
For example, a CSS theme class could be applied to the document `<body>` element, and
you want to change how your component looks based on that.
2017-03-06 05:43:33 -05:00
Use the `:host-context()` pseudo-class selector, which works just like the function
form of `:host()`. The `:host-context()` selector looks for a CSS class in any ancestor of the component host element,
up to the document root. The `:host-context()` selector is useful when combined with another selector.
2017-03-06 05:43:33 -05:00
The following example applies a `background-color` style to all `<h2>` elements *inside* the component, only
if some ancestor element has the CSS class `theme-light`.
<code-example path="component-styles/src/app/hero-details.component.css" region="hostcontext" header="src/app/hero-details.component.css"></code-example>
### (deprecated) `/deep/`, `>>>`, and `::ng-deep`
Component styles normally apply only to the HTML in the component's own template.
Applying the `::ng-deep` pseudo-class to any CSS rule completely disables view-encapsulation for
that rule. Any style with `::ng-deep` applied becomes a global style. In order to scope the specified style
to the current component and all its descendants, be sure to include the `:host` selector before
`::ng-deep`. If the `::ng-deep` combinator is used without the `:host` pseudo-class selector, the style
can bleed into other components.
The following example targets all `<h3>` elements, from the host element down
through this component to all of its child elements in the DOM.
<code-example path="component-styles/src/app/hero-details.component.css" region="deep" header="src/app/hero-details.component.css"></code-example>
The `/deep/` combinator also has the aliases `>>>`, and `::ng-deep`.
2017-04-10 11:51:13 -04:00
<div class="alert is-important">
Use `/deep/`, `>>>` and `::ng-deep` only with *emulated* view encapsulation.
2017-03-06 05:43:33 -05:00
Emulated is the default and most commonly used view encapsulation. For more information, see the
[Controlling view encapsulation](guide/component-styles#view-encapsulation) section.
2017-04-10 11:51:13 -04:00
</div>
<div class="alert is-important">
The shadow-piercing descendant combinator is deprecated and [support is being removed from major browsers](https://www.chromestatus.com/features/6750456638341120) and tools.
As such we plan to drop support in Angular (for all 3 of `/deep/`, `>>>` and `::ng-deep`).
Until then `::ng-deep` should be preferred for a broader compatibility with the tools.
</div>
{@a loading-styles}
## Loading component styles
There are several ways to add styles to a component:
2017-03-31 19:57:13 -04:00
2017-03-06 05:43:33 -05:00
* By setting `styles` or `styleUrls` metadata.
* Inline in the template HTML.
* With CSS imports.
2017-03-06 05:43:33 -05:00
The scoping rules outlined earlier apply to each of these loading patterns.
### Styles in component metadata
You can add a `styles` array property to the `@Component` decorator.
Each string in the array defines some CSS for this component.
<code-example path="component-styles/src/app/hero-app.component.ts" header="src/app/hero-app.component.ts (CSS inline)">
</code-example>
<div class="alert is-critical">
2017-03-31 19:57:13 -04:00
Reminder: these styles apply _only to this component_.
They are _not inherited_ by any components nested within the template nor by any content projected into the component.
2017-03-31 19:57:13 -04:00
</div>
The Angular CLI command [`ng generate component`](cli/generate) defines an empty `styles` array when you create the component with the `--inline-style` flag.
<code-example language="sh" class="code-shell">
ng generate component hero-app --inline-style
</code-example>
### Style files in component metadata
You can load styles from external CSS files by adding a `styleUrls` property
to a component's `@Component` decorator:
<code-tabs>
<code-pane header="src/app/hero-app.component.ts (CSS in file)" path="component-styles/src/app/hero-app.component.1.ts"></code-pane>
<code-pane header="src/app/hero-app.component.css" path="component-styles/src/app/hero-app.component.css"></code-pane>
</code-tabs>
2017-03-31 19:57:13 -04:00
<div class="alert is-critical">
2017-03-31 19:57:13 -04:00
Reminder: the styles in the style file apply _only to this component_.
They are _not inherited_ by any components nested within the template nor by any content projected into the component.
2017-04-10 11:51:13 -04:00
</div>
<div class="alert is-helpful">
You can specify more than one styles file or even a combination of `styles` and `styleUrls`.
2017-04-10 11:51:13 -04:00
</div>
When you use the Angular CLI command [`ng generate component`](cli/generate) without the `--inline-style` flag, it creates an empty styles file for you and references that file in the component's generated `styleUrls`.
2017-03-31 19:57:13 -04:00
<code-example language="sh" class="code-shell">
ng generate component hero-app
</code-example>
2017-03-31 19:57:13 -04:00
2017-03-06 05:43:33 -05:00
### Template inline styles
You can embed CSS styles directly into the HTML template by putting them
2017-03-06 05:43:33 -05:00
inside `<style>` tags.
<code-example path="component-styles/src/app/hero-controls.component.ts" region="inlinestyles" header="src/app/hero-controls.component.ts">
</code-example>
2017-03-06 05:43:33 -05:00
### Template link tags
You can also write `<link>` tags into the component's HTML template.
<code-example path="component-styles/src/app/hero-team.component.ts" region="stylelink" header="src/app/hero-team.component.ts">
</code-example>
<div class="alert is-critical">
2017-03-31 19:57:13 -04:00
When building with the CLI, be sure to include the linked style file among the assets to be copied to the server as described in the [CLI wiki](https://github.com/angular/angular-cli/wiki/stories-asset-configuration).
<!-- 2018-10-16: The link above is still the best source for this information. -->
Once included, the CLI will include the stylesheet, whether the link tag's href URL is relative to the application root or the component file.
</div>
2017-03-31 19:57:13 -04:00
### CSS @imports
2017-03-06 05:43:33 -05:00
You can also import CSS files into the CSS files using the standard CSS `@import` rule.
For details, see [`@import`](https://developer.mozilla.org/en/docs/Web/CSS/@import)
on the [MDN](https://developer.mozilla.org) site.
2017-03-31 19:57:13 -04:00
In this case, the URL is relative to the CSS file into which you're importing.
<code-example path="component-styles/src/app/hero-details.component.css" region="import" header="src/app/hero-details.component.css (excerpt)">
</code-example>
### External and global style files
When building with the CLI, you must configure the `angular.json` to include _all external assets_, including external style files.
Register **global** style files in the `styles` section which, by default, is pre-configured with the global `styles.css` file.
See the [CLI wiki](https://github.com/angular/angular-cli/wiki/stories-global-styles) to learn more.
<!-- 2018-10-16: The link above is still the best source for this information. -->
### Non-CSS style files
If you're building with the CLI,
you can write style files in [sass](http://sass-lang.com/), [less](http://lesscss.org/), or [stylus](http://stylus-lang.com/) and specify those files in the `@Component.styleUrls` metadata with the appropriate extensions (`.scss`, `.less`, `.styl`) as in the following example:
2017-03-31 19:57:13 -04:00
<code-example>
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.scss']
})
...
</code-example>
The CLI build process runs the pertinent CSS preprocessor.
When generating a component file with `ng generate component`, the CLI emits an empty CSS styles file (`.css`) by default.
You can configure the CLI to default to your preferred CSS preprocessor
as explained in the [CLI wiki](https://github.com/angular/angular-cli/wiki/stories-css-preprocessors
"CSS Preprocessor integration").
<!-- 2018-10-16: The link above is still the best source for this information. -->
<div class="alert is-important">
Style strings added to the `@Component.styles` array _must be written in CSS_ because the CLI cannot apply a preprocessor to inline styles.
</div>
{@a view-encapsulation}
2017-03-31 19:57:13 -04:00
## View encapsulation
2017-03-06 05:43:33 -05:00
As discussed earlier, component CSS styles are encapsulated into the component's view and don't
affect the rest of the application.
2017-03-06 05:43:33 -05:00
To control how this encapsulation happens on a *per
component* basis, you can set the *view encapsulation mode* in the component metadata.
Choose from the following modes:
* `ShadowDom` view encapsulation uses the browser's native shadow DOM implementation (see
[Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Shadow_DOM)
2017-03-06 05:43:33 -05:00
on the [MDN](https://developer.mozilla.org) site)
to attach a shadow DOM to the component's host element, and then puts the component
view inside that shadow DOM. The component's styles are included within the shadow DOM.
2017-03-31 19:57:13 -04:00
* `Native` view encapsulation uses a now deprecated version of the browser's native shadow DOM implementation - [learn about the changes](https://hayato.io/2016/shadowdomv1/).
2017-03-06 05:43:33 -05:00
* `Emulated` view encapsulation (the default) emulates the behavior of shadow DOM by preprocessing
(and renaming) the CSS code to effectively scope the CSS to the component's view.
For details, see [Appendix 1](guide/component-styles#inspect-generated-css).
2017-03-31 19:57:13 -04:00
* `None` means that Angular does no view encapsulation.
Angular adds the CSS to the global styles.
The scoping rules, isolations, and protections discussed earlier don't apply.
This is essentially the same as pasting the component's styles into the HTML.
2017-03-06 05:43:33 -05:00
To set the components encapsulation mode, use the `encapsulation` property in the component metadata:
<code-example path="component-styles/src/app/quest-summary.component.ts" region="encapsulation.native" header="src/app/quest-summary.component.ts"></code-example>
`ShadowDom` view encapsulation only works on browsers that have native support
for shadow DOM (see [Shadow DOM v1](https://caniuse.com/#feat=shadowdomv1) on the
2017-03-06 05:43:33 -05:00
[Can I use](http://caniuse.com) site). The support is still limited,
which is why `Emulated` view encapsulation is the default mode and recommended
in most cases.
{@a inspect-generated-css}
## Inspecting generated CSS
2017-03-06 05:43:33 -05:00
When using emulated view encapsulation, Angular preprocesses
all component styles so that they approximate the standard shadow CSS scoping rules.
2017-03-06 05:43:33 -05:00
In the DOM of a running Angular application with emulated view
encapsulation enabled, each DOM element has some extra attributes
attached to it:
<code-example format="">
2017-03-31 19:57:13 -04:00
&lt;hero-details _nghost-pmm-5>
&lt;h2 _ngcontent-pmm-5>Mister Fantastic&lt;/h2>
&lt;hero-team _ngcontent-pmm-5 _nghost-pmm-6>
&lt;h3 _ngcontent-pmm-6>Team&lt;/h3>
&lt;/hero-team>
&lt;/hero-detail>
</code-example>
2017-03-06 05:43:33 -05:00
There are two kinds of generated attributes:
2017-03-31 19:57:13 -04:00
2017-03-06 05:43:33 -05:00
* An element that would be a shadow DOM host in native encapsulation has a
generated `_nghost` attribute. This is typically the case for component host elements.
* An element within a component's view has a `_ngcontent` attribute
2017-03-06 05:43:33 -05:00
that identifies to which host's emulated shadow DOM this element belongs.
2017-03-06 05:43:33 -05:00
The exact values of these attributes aren't important. They are automatically
generated and you never refer to them in application code. But they are targeted
by the generated component styles, which are in the `<head>` section of the DOM:
<code-example format="">
2017-03-31 19:57:13 -04:00
[_nghost-pmm-5] {
display: block;
border: 1px solid black;
}
h3[_ngcontent-pmm-6] {
background-color: white;
border: 1px solid #777;
}
</code-example>
2017-03-06 05:43:33 -05:00
These styles are post-processed so that each selector is augmented
with `_nghost` or `_ngcontent` attribute selectors.
2017-03-06 05:43:33 -05:00
These extra selectors enable the scoping rules described in this page.