NgClass

Stable Directive

What it does

Adds and removes CSS classes on an HTML element.

How to use

<some-element [ngClass]="'first second'">...</some-element>

<some-element [ngClass]="['first', 'second']">...</some-element>

<some-element [ngClass]="{'first': true, 'second': true, 'third': false}">...</some-element>

<some-element [ngClass]="stringExp|arrayExp|objExp">...</some-element>

<some-element [ngClass]="{'class1 class2 class3' : true}">...</some-element>

Class Overview

class NgClass implements DoCheck {
  constructor(_iterableDiffers: IterableDiffers, _keyValueDiffers: KeyValueDiffers, _ngEl: ElementRef, _renderer: Renderer)
  
  
  klass 
  ngClass 
  ngDoCheck() : void
}

Selectors

[ngClass]

Class Description

The CSS classes are updated as follows, depending on the type of the expression evaluation:

• string - the CSS classes listed in the string (space delimited) are added,
• Array - the CSS classes declared as Array elements are added,
• Object - keys are CSS classes that get added when the expression given in the value

         evaluates to a truthy value, otherwise they are removed.
  

Constructor

constructor(_iterableDiffers: IterableDiffers, _keyValueDiffers: KeyValueDiffers, _ngEl: ElementRef, _renderer: Renderer)

Class Details

klass

ngClass

ngDoCheck() : void

exported from @angular/common/index, defined in @angular/common/src/directives/ng_class.ts