aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/guide/ie.ngdoc
blob: 2842a83e297994f280795229faf23624cd9bd0e6 (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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
@ngdoc overview
@name  Internet Explorer Compatibility
@description

# Overview

This document describes the Internet Explorer (IE) idiosyncrasies when dealing with custom HTML
attributes and tags. Read this document if you are planning on deploying your Angular application
on IE v8.0 or earlier.

The project currently supports and will attempt to fix bugs for IE8 and above. The continuous
integration server runs all the tests against IE8. See http://ci.angularjs.org.

IE7 and below are not tested and the project makes no guarantee that Angular will work on it.
A subset of the AngularJS functionality may work. It is up to you to test and decide whether
it works for your particular app.

It is very unlikely that issues specific to IE7 or earlier will be given any time by the core team.
[GitHub](https://github.com/angular/angular.js/issues/4974)


# Short Version

To make your Angular application work on IE please make sure that:

  1. You polyfill JSON.stringify for IE7 and below. You can use
     [JSON2](https://github.com/douglascrockford/JSON-js) or
     [JSON3](http://bestiejs.github.com/json3/) polyfills for this.

     ```html
       <!doctype html>
       <html xmlns:ng="http://angularjs.org">
         <head>
           <!--[if lte IE 7]>
             <script src="/path/to/json2.js"></script>
           <![endif]-->
         </head>
         <body>
           ...
         </body>
       </html>
     ```

  2. add `id="ng-app"` to the root element in conjunction with `ng-app` attribute

     ```html
       <!doctype html>
       <html xmlns:ng="http://angularjs.org" id="ng-app" ng-app="optionalModuleName">
         ...
       </html>
     ```

  3. you **do not** use custom element tags such as `<ng:view>` (use the attribute version
     `<div ng-view>` instead), or

  4. if you **do use** custom element tags, then you must take these steps to make IE 8 and below happy:

     ```html
       <!doctype html>
       <html xmlns:ng="http://angularjs.org" id="ng-app" ng-app="optionalModuleName">
         <head>
           <!--[if lte IE 8]>
             <script>
               document.createElement('ng-include');
               document.createElement('ng-pluralize');
               document.createElement('ng-view');

               // Optionally these for CSS
               document.createElement('ng:include');
               document.createElement('ng:pluralize');
               document.createElement('ng:view');
             </script>
           <![endif]-->
         </head>
         <body>
           ...
         </body>
       </html>
     ```
  5. Use `ng-style` tags instead of `style="{{ someCss }}"`. The later works in Chrome and Firefox
     but does not work in Internet Explorer <= 11 (the most recent version at time of writing).


The **important** parts are:

  * `xmlns:ng` - *namespace* - you need one namespace for each custom tag you are planning on
    using.

  * `document.createElement(yourTagName)` - *creation of custom tag names* - Since this is an
    issue only for older version of IE you need to load it conditionally. For each tag which does
    not have namespace and which is not defined in HTML you need to pre-declare it to make IE
    happy.


# Long Version

IE has issues with element tag names which are not standard HTML tag names. These fall into two
categories, and each category has its own fix.

  * If the tag name starts with `my:` prefix then it is considered an XML namespace and must
    have corresponding namespace declaration on `<html xmlns:my="ignored">`

  * If the tag has no `:` but it is not a standard HTML tag, then it must be pre-created using
    `document.createElement('my-tag')`

  * If you are planning on styling the custom tag with CSS selectors, then it must be
    pre-created using `document.createElement('my-tag')` regardless of XML namespace.


## The Good News

The good news is that these restrictions only apply to element tag names, and not to element
attribute names. So this requires no special handling in IE: `<div my-tag your:tag></div>`.


## What happens if I fail to do this?

Suppose you have HTML with unknown tag `mytag` (this could also be `my:tag` or `my-tag` with same
result):

```html
  <html>
    <body>
      <mytag>some text</mytag>
    </body>
  </html>
```

It should parse into the following DOM:

```
#document
  +- HTML
     +- BODY
        +- mytag
           +- #text: some text
```

The expected behavior is that the `BODY` element has a child element `mytag`, which in turn has
the text `some text`.

But this is not what IE does (if the above fixes are not included):

```
#document
  +- HTML
     +- BODY
        +- mytag
        +- #text: some text
        +- /mytag
```

In IE, the behavior is that the `BODY` element has three children:

  1. A self closing `mytag`. Example of self closing tag is `<br/>`. The trailing `/` is optional,
  but the `<br>` tag is not allowed to have any children, and browsers consider `<br>some
  text</br>` as three siblings not a `<br>` with `some text` as child.

  2. A text node with `some text`. This should have been a child of `mytag` above, not a sibling.

  3. A corrupt self closing `/mytag`. This is corrupt since element names are not allowed to have
  the `/` character. Furthermore this closing element should not be part of the DOM since it is
  only used to delineate the structure of the DOM.


## CSS Styling of Custom Tag Names

To make CSS selectors work with custom elements, the custom element name must be pre-created with
`document.createElement('my-tag')` regardless of XML namespace.

```html
  <html xmlns:ng="needed for ng: namespace">
    <head>
      <!--[if lte IE 8]>
        <script>
          // needed to make ng-include parse properly
          document.createElement('ng-include');

          // needed to enable CSS reference
          document.createElement('ng:view');
        </script>
      <![endif]-->
      <style>
        ng\:view {
          display: block;
          border: 1px solid red;
        }

        ng-include {
          display: block;
          border: 1px solid blue;
        }
      </style>
    </head>
    <body>
      <ng:view></ng:view>
      <ng-include></ng-include>
      ...
    </body>
  </html>
```