Hey there, have you ever needed to programmatically add a class to an element in an Angular application? Like, maybe when a button is disabled, we need a class, but then once it’s enabled, we don’t. Or how about when a form goes from an invalid state to valid? Well, good news, this is actually pretty easy to do in angular. In this post I’m going to show you four different ways. First we’ll use a method called class binding. Next we’ll use the ngClass directive. After that we’ll use the @HostBinding decorator. And finally, we’ll use the Renderer2 addClass() and removeClass() methods. Let’s get to it!
Using Angular Class Binding
So class binding is something that you'd want to use in more simplistic cases where we basically just either want a class on an element or not. For example, we may want to add a disabled class to a button in a form when the form is invalid. To do this we simply add the word class in square brackets, followed by a dot and then our disabled class name. Then, we will bind this when our control is invalid.
<form>
...
<input [formControl]="emailControl" type="email" />
...
<button [class.disabled]="emailControl.invalid">Subscribe</button>
</form>
Using the Angular ngClass Directive
When we encounter more complex scenarios, we may find ourselves needing to use the ngClass directive instead of Angular class binding. The directive gives us more flexibility and allows us to use more advanced logic for adding and removing class names. In this example, we want to switch between two different classes on our wrapping fieldset depending on whether the form is valid or not.
To use the ngClass directive, we still use the square brackets, but this time we're going to use a ternary operator and when our control is invalid we'll add a class of 'invalid' and when it's not we'll add a class of 'valid'.
<form>
<fieldset [ngClass]="emailControl.invalid ? 'invalid' : 'valid'">
...
<input [formControl]="emailControl" type="email" />
...
</fieldset>
</form>
Using Angular @HostBinding
What if we have the need to conditionally bind a class on the host of our Angular Component or Directive? Well this is where the Angular @HostBinding decorator comes into play. To do this we add the @HostBinding decorator within our component class and within this is will look much like our class binding example. We'll add the class name followed by a dot and then the class. Then we use a field, we'll call this one 'isValid' and we'll initialize it to false.
To update this field, we'll need to subscribe to our email control status changes event and then simply update the value based on the status.
...
export class FormComponent implements OnInit {
@HostBinding('class.valid') isValid = false;
...
constructor(private destroyRef: DestroyRef) {}
ngOnInit() {
this.emailControl.statusChanges
.pipe(takeUntilDestroyed(this.destroyRef))
.subscribe((status) => this.isValid = status === 'VALID');
}
}
Using Angular Renderer2 addClass and removeClass Methods
When we need to get real crazy and do something like add a class to the body element from within our component, this may seem near impossible in Angular. But, fortunately it's not. We can reach for the Angular Renderer2 class which allows us to do several different things. For our purposes for conditionally adding classes to elements, we are only concerned with the add and remove class methods.
First, we need to make sure that we inject the Renderer2 into our component via the constructor. Then, we we will add a ternary operator within our status changes observable subscription for our control. If its status valid, we will want to add the class to our document.body element, and if it's invalid, we will want to be sure to remove the valid class.
...
export class FormComponent implements OnInit {
...
constructor(private destroyRef: DestroyRef, private renderer: Renderer2) {}
ngOnInit() {
this.emailControl.statusChanges
.pipe(takeUntilDestroyed(this.destroyRef))
.subscribe((status) => {
...
status === 'VALID'
? this.renderer.addClass(document.body, 'valid')
: this.renderer.removeClass(document.body, 'valid');
});
}
}
In Conclusion
Okay so we now have four different ways to conditionally add and remove classes in Angular. First, we used class binding for more simple, straight forward cases. Then we used the ngClass directive where more advanced logic was needed. After that we used the @HostBinding decorator to conditionally bind classes to our component host element. And finally, when all else failed and we needed something else, we used the Renderer2 add and remove class methods to bridge the gap.
So hopefully that helps you out along your way and gives you some options when you need to programmatically add or remove classes.
Found This Helpful?
If you found this article helpful and want to show some love, you can always buy me a coffee!
Want to See It in Action?
Check out the demo code and examples of these techniques in the in the stackblitz example below. If you have any questions or thoughts, don’t hesitate to leave a comment.