Communicating use more clearly. #4914
Conversation
With both the class and the expression having the exact same name it makes it difficult to learn how to use this directive just from looking at this example. By making this simple change it makes the example of the `ngClass` directive much more clear.
| @@ -98,7 +98,7 @@ function classDirective(name, selector) { | |||
| * @example Example that demonstrates basic bindings via ngClass directive. | |||
| <example> | |||
| <file name="index.html"> | |||
| <p ng-class="{strike: strike, bold: bold, red: red}">Map Syntax Example</p> | |||
| <p ng-class="{strikeClass: strike, boldClass: bold, redClass: red}">Map Syntax Example</p> | |||
There was a problem hiding this comment.
it might make the intent more clear to call the expression variables shouldStrike and shouldBold and shouldRed, too.
There was a problem hiding this comment.
I was going to do that, but below we allow them to type "bold" and have it bold. I would rather not force them to type shouldBold
There was a problem hiding this comment.
@kentcdodds - Actually, the opposite is true. What you type in below is the name of the CSS class, so given you change you would need to type in boldClass to get it to work.
|
@kentcdodds - thanks for this PR but your change actually broke the other parts of the demo. |
|
I guess that's what I get for using the github editor and not double checking my assumptions :) Glad it'll be more clear now! |
With both the class and the expression having the exact same name it makes it difficult to learn how to use this directive just from looking at this example. By making this simple change it makes the example of the
ngClassdirective much more clear.