From d3fb8dd77614a1512d1d83e64e4afd10580f9cc1 Mon Sep 17 00:00:00 2001 From: Pawel Kozlowski Date: Wed, 19 Nov 2014 19:35:57 +0100 Subject: [PATCH] docs($filter): clarify what is a valid filter name Also updates the CHANGELOG to add info about this breaking some previous invalid uses of $filter Closes #10054 Closes #10131 --- CHANGELOG.md | 5 +++++ docs/content/guide/filter.ngdoc | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5c5b0f9b..f0359c55 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -94,7 +94,12 @@ ([8eabc546](https://github.com/angular/angular.js/commit/8eabc5463c795d87f37e5a9eacbbb14435024061), [#9942](https://github.com/angular/angular.js/issues/9942)) +## Breaking Changes +- **$parse:** due to [fbad2805](https://github.com/angular/angular.js/commit/fbad2805703569058a4a860747b0e2d8aee36bdf), + you can't use characters that have special meaning in AngularJS expressions (ex.: `.` or `-`) + as part of filter's name. Before this commit custom filters could contain special characters + (like a dot) in their name but this wasn't intentional. # 1.3.2 cardiovasculatory-magnification (2014-11-07) diff --git a/docs/content/guide/filter.ngdoc b/docs/content/guide/filter.ngdoc index c33d728b..22eb4a5f 100644 --- a/docs/content/guide/filter.ngdoc +++ b/docs/content/guide/filter.ngdoc @@ -91,6 +91,11 @@ The filter function should be a [pure function](http://en.wikipedia.org/wiki/Pur means that it should be stateless and idempotent. Angular relies on these properties and executes the filter only when the inputs to the function change. +
+**Note:** filter names must be valid angular expression identifiers, such as `uppercase` or `orderBy`. +Names with special characters, such as hyphens and dots, are not allowed. +
+ The following sample filter reverses a text string. In addition, it conditionally makes the text upper-case.