Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 2d0eda1

Browse files
docs(ngMessageExp): split ngMessage docs up to show its alias more clearly
1 parent 4374f89 commit 2d0eda1

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

src/ngMessages/messages.js

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -537,23 +537,51 @@ angular.module('ngMessages', [])
537537
* <ANY ng-messages="expression">
538538
* <ANY ng-message="stringValue">...</ANY>
539539
* <ANY ng-message="stringValue1, stringValue2, ...">...</ANY>
540-
* <ANY ng-message-exp="expressionValue">...</ANY>
541540
* </ANY>
542541
*
543542
* <!-- or by using element directives -->
544543
* <ng-messages for="expression">
545544
* <ng-message when="stringValue">...</ng-message>
546545
* <ng-message when="stringValue1, stringValue2, ...">...</ng-message>
547-
* <ng-message when-exp="expressionValue">...</ng-message>
548546
* </ng-messages>
549547
* ```
550548
*
551549
* {@link module:ngMessages Click here} to learn more about `ngMessages` and `ngMessage`.
552550
*
553551
* @param {expression} ngMessage|when a string value corresponding to the message key.
554-
* @param {expression} ngMessageExp|whenExp an expression value corresponding to the message key.
555552
*/
556553
.directive('ngMessage', ngMessageDirectiveFactory('AE'))
554+
555+
556+
/**
557+
* @ngdoc directive
558+
* @name ngMessageExp
559+
* @restrict AE
560+
* @scope
561+
*
562+
* @description
563+
* `ngMessageExp` is a directive with the purpose to show and hide a particular message.
564+
* For `ngMessageExp` to operate, a parent `ngMessages` directive on a parent DOM element
565+
* must be situated since it determines which messages are visible based on the state
566+
* of the provided key/value map that `ngMessages` listens on.
567+
*
568+
* @usage
569+
* ```html
570+
* <!-- using attribute directives -->
571+
* <ANY ng-messages="expression">
572+
* <ANY ng-message-exp="expressionValue">...</ANY>
573+
* </ANY>
574+
*
575+
* <!-- or by using element directives -->
576+
* <ng-messages for="expression">
577+
* <ng-message when-exp="expressionValue">...</ng-message>
578+
* </ng-messages>
579+
* ```
580+
*
581+
* {@link module:ngMessages Click here} to learn more about `ngMessages` and `ngMessage`.
582+
*
583+
* @param {expression} ngMessageExp|whenExp an expression value corresponding to the message key.
584+
*/
557585
.directive('ngMessageExp', ngMessageDirectiveFactory('A'));
558586

559587
function ngMessageDirectiveFactory(restrict) {

0 commit comments

Comments
 (0)