Aug 13, 2013

Angular.js – create reusable HTML widgets with directives

What is a directive?

Angular directives are a very powerful component of the Angular framework. They can control how the page is rendered in many different ways. Many of the attributes and tags built in to Angular are directives, such as ‘ng-show’, ‘ng-hide’, ‘ng-repeat’, etc. One way they can be used is to create HTML an widget that you can re-use across different partials.

How to create a simple directive

The Angular.js directive documentation goes into deep technical detail on how directives are implemented. This deep dive could be useful for complex directives, but it can obscure how easy it is to create simple directives. For example, suppose we want a re-usable HTML widget that messages displays to the user. The first thing we’ll do is create the directive:

As you can see, the code to define the directive is pretty minimal. The ‘scope: false’ tells Angular to not create a separate scope for the directive and just pass through the scope from the parent controller. And the ‘restrict: E’ says to only allow this directive to be used in an HTML element.

Next, let’s create the template body:

partials/widgets/messages.html:

Since we set ‘scope: false’ in the directive definition, errorMessage and successMessage are coming from the parent controller’s $scope. The controller code may contain something along these lines:

Finally, to use the new widget we just include this snippet in one of our partials:

And that’s a quick way to create a re-usable HTML widget with Angular.js.

About the Author

Object Partners profile.

One thought on “Angular.js – create reusable HTML widgets with directives

Comments are closed.

Related Blog Posts
Designing Kubernetes Controllers
There has been some excellent online discussion lately around Kubernetes controllers, highlighted by an excellent Speakerdeck presentation assembled by Tim Hockin. What I’d like to do in this post is explore some of the implications […]
React Server Components
The React Team recently announced new work they are doing on React Server Components, a new way of rendering React components. The goal is to create smaller bundle sizes, speed up render time, and prevent […]
Jolt custom java transform
Jolt is a JSON to JSON transformation library where the transform is defined in JSON. It’s really good at reorganizing the json data and massaging it into the output JSON you need. Sometimes, you just […]
Page Object Model for UI Testing