aboutsummaryrefslogtreecommitdiffstats
path: root/docs/angular.formatter.ngdoc
blob: ba28471f2228439565201e5309c1d3125efa0270 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
@workInProgress
@ngdoc overview
@name angular.formatter
@namespace Namespace for all formats.
@description
# Overview
The formatters are responsible for translating user readable text in an input widget to a
data model stored in an application.

# Writting your own Formatter
Writing your own formatter is easy. Just register a pair of JavaScript functions with 
`angular.formatter`. One function for parsing user input text to the stored form, 
and one for formatting the stored data to user-visible text.

Here is an example of a "reverse" formatter: The data is stored in uppercase and in 
reverse, while it is displayed in lower case and non-reversed. User edits are 
automatically parsed into the internal form and data changes are automatically 
formatted to the viewed form.

<pre>
function reverse(text) {
  var reversed = [];
  for (var i = 0; i < text.length; i++) {
    reversed.unshift(text.charAt(i));
  }
  return reversed.join('');
}

angular.formatter('reverse', {
  parse: function(value){
    return reverse(value||'').toUpperCase();
  },
  format: function(value){
    return reverse(value||'').toLowerCase();
  }
});
</pre>

@example
<script type="text/javascript">
function reverse(text) {
  var reversed = [];
  for (var i = 0; i < text.length; i++) {
    reversed.unshift(text.charAt(i));
  }
  return reversed.join('');
}

angular.formatter('reverse', {
  parse: function(value){
    return reverse(value||'').toUpperCase();
  },
  format: function(value){
    return reverse(value||'').toLowerCase();
  }
});
</script>

Formatted: 
<input type="text" name="data" value="angular" ng:format="reverse"/>
<br/>

Stored: 
<input type="text" name="data"/><br/>
<pre>{{data}}</pre>


@scenario
it('should store reverse', function(){
 expect(element('.doc-example input:first').val()).toEqual('angular');
 expect(element('.doc-example input:last').val()).toEqual('RALUGNA');
 
 this.addFutureAction('change to XYZ', function($window, $document, done){
   $document.elements('.doc-example input:last').val('XYZ').trigger('change');
   done();
 });
 expect(element('.doc-example input:first').val()).toEqual('zyx');
});