W3cubDocs

/Angular.js 1.6

Improve this Doc View Source ngHide

  1. directive in module ng

The ngHide directive shows or hides the given HTML element based on the expression provided to the ngHide attribute.

The element is shown or hidden by removing or adding the .ng-hide CSS class onto the element. The .ng-hide CSS class is predefined in AngularJS and sets the display style to none (using an !important flag). For CSP mode please add angular-csp.css to your HTML file (see ngCsp).

<!-- when $scope.myValue is truthy (element is hidden) -->
<div ng-hide="myValue" class="ng-hide"></div>

<!-- when $scope.myValue is falsy (element is visible) -->
<div ng-hide="myValue"></div>

When the ngHide expression evaluates to a truthy value then the .ng-hide CSS class is added to the class attribute on the element causing it to become hidden. When falsy, the .ng-hide CSS class is removed from the element causing the element not to appear hidden.

Why is !important used?

You may be wondering why !important is used for the .ng-hide CSS class. This is because the .ng-hide selector can be easily overridden by heavier selectors. For example, something as simple as changing the display style on a HTML list item would make hidden elements appear visible. This also becomes a bigger issue when dealing with CSS frameworks.

By using !important, the show and hide behavior will work as expected despite any clash between CSS selector specificity (when !important isn't used with any conflicting styles). If a developer chooses to override the styling to change how to hide an element then it is just a matter of using !important in their own CSS code.

Overriding .ng-hide

By default, the .ng-hide class will style the element with display: none !important. If you wish to change the hide behavior with ngShow/ngHide, you can simply overwrite the styles for the .ng-hide CSS class. Note that the selector that needs to be used is actually .ng-hide:not(.ng-hide-animate) to cope with extra animation classes that can be added.

.ng-hide:not(.ng-hide-animate) {
  /* These are just alternative ways of hiding an element */
  display: block!important;
  position: absolute;
  top: -9999px;
  left: -9999px;
}

By default you don't need to override in CSS anything and the animations will work around the display style.

A note about animations with ngHide

Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression is true and false. This system works like the animation system present with ngClass except that you must also include the !important flag to override the display property so that the elements are not actually hidden during the animation.

/* A working example can be found at the bottom of this page. */
.my-element.ng-hide-add, .my-element.ng-hide-remove {
  transition: all 0.5s linear;
}

.my-element.ng-hide-add { ... }
.my-element.ng-hide-add.ng-hide-add-active { ... }
.my-element.ng-hide-remove { ... }
.my-element.ng-hide-remove.ng-hide-remove-active { ... }

Keep in mind that, as of AngularJS version 1.3, there is no need to change the display property to block during animation states - ngAnimate will automatically handle the style toggling for you.

Directive Info

  • This directive executes at priority level 0.
  • This directive can be used as multiElement

Usage

  • as element:
    <ng-hide
      ng-hide="expression">
    ...
    </ng-hide>
  • as attribute:
    <ANY
      ng-hide="expression">
    ...
    </ANY>

Arguments

Param Type Details
ngHide expression

If the expression is truthy/falsy then the element is hidden/shown respectively.

Animations

Animation Occurs
addClass .ng-hide After the ngHide expression evaluates to a truthy value and just before the contents are set to hidden.
removeClass .ng-hide After the ngHide expression evaluates to a non truthy value and just before contents are set to visible.
Click here to learn more about the steps involved in the animation.

A simple example, animating the element's opacity:

A more complex example, featuring different show/hide animations:

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.6.6/docs/api/ng/directive/ngHide