fix(animations): remove deprecated trigger APIs (#10825)

BREAKING CHANGE: Animations defined using an at-symbol prefix that are
not property bound are now invalid.

```html
<!-- this is now invalid -->
<div @flip="flipState"></div>

<!-- change that to -->
<div [@flip]="flipState"></div>
```

BREAKING CHANGE: Animations that are not bound using the at-symbol
prefix using `animate-` must now be preixed using `bind-animate-`.

```html
<!-- this is now invalid -->
<div animate-flip="flipState"></div>

<!-- is valid now -->
<div bind-animate-flip="flipState"></div>
```

Closes #10825
This commit is contained in:
Matias Niemelä 2016-08-16 14:09:21 -07:00 committed by vikerman
parent a86c554a8e
commit 9adf80385b
2 changed files with 37 additions and 36 deletions

View File

@ -39,14 +39,15 @@ import {PreparsedElementType, preparseElement} from './template_preparser';
// Group 4 = "ref-/#" // Group 4 = "ref-/#"
// Group 5 = "on-" // Group 5 = "on-"
// Group 6 = "bindon-" // Group 6 = "bindon-"
// Group 7 = "animate-/@" // Group 7 = "@"
// Group 8 = the identifier after "bind-", "var-/#", or "on-" // Group 8 = the identifier after "bind-", "var-/#", or "on-"
// Group 9 = identifier inside [()] // Group 9 = identifier inside [()]
// Group 10 = identifier inside [] // Group 10 = identifier inside []
// Group 11 = identifier inside () // Group 11 = identifier inside ()
const BIND_NAME_REGEXP = const BIND_NAME_REGEXP =
/^(?:(?:(?:(bind-)|(var-)|(let-)|(ref-|#)|(on-)|(bindon-)|(animate-|@))(.+))|\[\(([^\)]+)\)\]|\[([^\]]+)\]|\(([^\)]+)\))$/; /^(?:(?:(?:(bind-)|(var-)|(let-)|(ref-|#)|(on-)|(bindon-)|(@))(.+))|\[\(([^\)]+)\)\]|\[([^\]]+)\]|\(([^\)]+)\))$/;
const ANIMATE_PROP_PREFIX = 'animate-';
const TEMPLATE_ELEMENT = 'template'; const TEMPLATE_ELEMENT = 'template';
const TEMPLATE_ATTR = 'template'; const TEMPLATE_ATTR = 'template';
const TEMPLATE_ATTR_PREFIX = '*'; const TEMPLATE_ATTR_PREFIX = '*';
@ -540,8 +541,8 @@ class TemplateParseVisitor implements html.Visitor {
} else if (isPresent(bindParts[7])) { // match: animate-name } else if (isPresent(bindParts[7])) { // match: animate-name
if (attrName[0] == '@' && isPresent(attrValue) && attrValue.length > 0) { if (attrName[0] == '@' && isPresent(attrValue) && attrValue.length > 0) {
this._reportError( this._reportError(
`Assigning animation triggers via @prop="exp" attributes with an expression is deprecated. Use property bindings (e.g. [@prop]="exp") instead!`, `Assigning animation triggers via @prop="exp" attributes with an expression is invalid. Use property bindings (e.g. [@prop]="exp") or use an attribute without a value \(e.g. @prop\) instead.`,
attr.sourceSpan, ParseErrorLevel.WARNING); attr.sourceSpan, ParseErrorLevel.FATAL);
} }
this._parseAnimation( this._parseAnimation(
bindParts[8], attrValue, attr.sourceSpan, targetMatchableAttrs, targetAnimationProps); bindParts[8], attrValue, attr.sourceSpan, targetMatchableAttrs, targetAnimationProps);
@ -598,9 +599,18 @@ class TemplateParseVisitor implements html.Visitor {
name: string, expression: string, sourceSpan: ParseSourceSpan, name: string, expression: string, sourceSpan: ParseSourceSpan,
targetMatchableAttrs: string[][], targetProps: BoundElementOrDirectiveProperty[], targetMatchableAttrs: string[][], targetProps: BoundElementOrDirectiveProperty[],
targetAnimationProps: BoundElementPropertyAst[]) { targetAnimationProps: BoundElementPropertyAst[]) {
if (name[0] == '@') { const animatePropLength = ANIMATE_PROP_PREFIX.length;
var isAnimationProp = name[0] == '@';
var animationPrefixLength = 1;
if (name.substring(0, animatePropLength) == ANIMATE_PROP_PREFIX) {
isAnimationProp = true;
animationPrefixLength = animatePropLength;
}
if (isAnimationProp) {
this._parseAnimation( this._parseAnimation(
name.substr(1), expression, sourceSpan, targetMatchableAttrs, targetAnimationProps); name.substr(animationPrefixLength), expression, sourceSpan, targetMatchableAttrs,
targetAnimationProps);
} else { } else {
this._parsePropertyAst( this._parsePropertyAst(
name, this._parseBinding(expression, sourceSpan), sourceSpan, targetMatchableAttrs, name, this._parseBinding(expression, sourceSpan), sourceSpan, targetMatchableAttrs,
@ -809,11 +819,10 @@ class TemplateParseVisitor implements html.Visitor {
boundPropertyName = partValue.substr(1); boundPropertyName = partValue.substr(1);
bindingType = PropertyBindingType.Animation; bindingType = PropertyBindingType.Animation;
securityContext = SecurityContext.NONE; securityContext = SecurityContext.NONE;
// DEPRECATED: remove this if statement post RC5
if (boundPropertyName[0] == '@') { if (boundPropertyName[0] == '@') {
this._reportError( this._reportError(
`Assigning animation triggers within host data as attributes such as "@prop": "exp" is deprecated. Use host bindings (e.g. "[@prop]": "exp") instead!`, `Assigning animation triggers within host data as attributes such as "@prop": "exp" is invalid. Use host bindings (e.g. "[@prop]": "exp") instead.`,
sourceSpan, ParseErrorLevel.WARNING); sourceSpan, ParseErrorLevel.FATAL);
boundPropertyName = boundPropertyName.substr(1); boundPropertyName = boundPropertyName.substr(1);
} }
} else { } else {

View File

@ -284,32 +284,26 @@ Can't bind to 'invalidProp' since it isn't a known property of 'my-component'.
]); ]);
}); });
it('should parse bound properties via animate- and not report them as attributes', () => { it('should parse bound properties via bind-animate- and not report them as animation properties',
expect(humanizeTplAst(parse('<div animate-something="value2">', []))).toEqual([
[ElementAst, 'div'],
[BoundElementPropertyAst, PropertyBindingType.Animation, 'something', 'value2', null]
]);
});
// DEPRECATED: remove this spec post RC5
it('should parse bound properties via @ and not report them as attributes and also report a deprecation warning',
() => { () => {
expect(humanizeTplAst(parse('<div @something="value2">', []))).toEqual([ expect(humanizeTplAst(parse('<div bind-animate-something="value2">', []))).toEqual([
[ElementAst, 'div'], [ElementAst, 'div'],
[ [
BoundElementPropertyAst, PropertyBindingType.Animation, 'something', 'value2', null BoundElementPropertyAst, PropertyBindingType.Animation, 'something', 'value2', null
] ]
]); ]);
expect(console.warnings).toEqual([[
'Template parse warnings:',
`Assigning animation triggers via @prop="exp" attributes with an expression is deprecated. Use property bindings (e.g. [@prop]="exp") instead! ("<div [ERROR ->]@something="value2">"): TestComp@0:5`
].join('\n')]);
}); });
// DEPRECATED: remove this spec post RC5 it('should throw an error when parsing detects non-bound properties via @ that contain a value',
it('should issue a warning when host attributes contain a non property-bound animation trigger',
() => { () => {
expect(() => { parse('<div @something="value2">', []); })
.toThrowError(
/Assigning animation triggers via @prop="exp" attributes with an expression is invalid. Use property bindings \(e.g. \[@prop\]="exp"\) or use an attribute without a value \(e.g. @prop\) instead. \("<div \[ERROR ->\]@something="value2">"\): TestComp@0:5/);
});
it('should throw an error when host attributes contain a non property-bound animation trigger',
() => {
expect(() => {
var dirA = CompileDirectiveMetadata.create({ var dirA = CompileDirectiveMetadata.create({
selector: 'div', selector: 'div',
type: new CompileTypeMetadata({moduleUrl: someModuleUrl, name: 'DirA'}), type: new CompileTypeMetadata({moduleUrl: someModuleUrl, name: 'DirA'}),
@ -317,11 +311,9 @@ Can't bind to 'invalidProp' since it isn't a known property of 'my-component'.
}); });
humanizeTplAst(parse('<div></div>', [dirA])); humanizeTplAst(parse('<div></div>', [dirA]));
})
expect(console.warnings).toEqual([[ .toThrowError(
'Template parse warnings:', /Assigning animation triggers within host data as attributes such as "@prop": "exp" is invalid. Use host bindings \(e.g. "\[@prop\]": "exp"\) instead. \("\[ERROR ->\]<div><\/div>"\): TestComp@0:0, Directive DirA/);
`Assigning animation triggers within host data as attributes such as "@prop": "exp" is deprecated. Use host bindings (e.g. "[@prop]": "exp") instead! ("[ERROR ->]<div></div>"): TestComp@0:0, Directive DirA`
].join('\n')]);
}); });
it('should not issue a warning when host attributes contain a valid property-bound animation trigger', it('should not issue a warning when host attributes contain a valid property-bound animation trigger',