aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/guide/directive.ngdoc
AgeCommit message (Collapse)Author
2014-03-24docs(guides/directive): add (') to contractionHEADmasterLuke Eller
add apostrophe (') to contraction
2014-03-22docs(guide/directive): fix broken linkJohn K. Paul
Fix broken internal link in directive documentation. Closes #6802
2014-03-07docs(guide/directive): fix typoSekib Omazic
`restictions` -> `restrictions` Closes #6604
2014-03-05docs(directive.ngdoc): typo fixTony Bergeron
2014-02-26docs(guide/directive): update directive restrict optionspyriand3r
- add missing 'C' restriction for class names
2014-02-21docs(*): fix anchors for members in api docsPeter Bacon Darwin
2014-02-20docs(guide/directive): add a more detailed description of isolate scope `&` ↵Brad Williams
bindings More description of "&" bindings, the fact that they trigger evaluation of expressions in the original scope's context. Closes #6255
2014-02-16docs(*): fix jshint issues in examplesPeter Bacon Darwin
2014-02-16docs(bike-shed-migration): fix url-based links refs to AUTO modulePeter Bacon Darwin
2014-02-16docs(bike-shed-migration): fix up links outside the domainPeter Bacon Darwin
It is safer to use markdown style links and save jsdoc style links for internal links and code references
2014-01-28test(docs): convert example end to end doc tests from scenario runner to ↵Julie
protractor Thanks to jeffbcross, petebacondarwin, btford, jdeboer, tbosch for contributions! Closes #6023
2014-01-21docs(guide/directive): clarify attr object definitionIgor Minar
Closes #5884
2014-01-21style(guide/directive): remove wsIgor Minar
2014-01-17docs(directive): link to directive registration api functionBen McCann
Originally, this issue was regarding documenting `restrict: 'CM'` in the directive guide, but it was pointed out that the restrict documentation is covered in the $compile documentation. Because of this, a link was simply added to the $compile documentation. However, the wording suggests that it's actually linking to the directive registration function, in $compileProvider, so the docs will link there instead. There is a link only a paragraph below to the $compile documentation, so this does not hurt. Closes #5516
2014-01-15docs(guide/directive): rephrase for consistencyRoy Ling
- referring to `=attr` rather than `=prop` is consistent with note under example with =customerInfo - change `prop` to `attr` (basically `prop` refers to property in JS object, `attr` is for HTML tag) - change the function name in description to match the name in code example Closes #5786
2014-01-07docs(directives): Fixed typo from HMTL to HTML in line 283Zhong Liang Ong
HTML was mis-spelt as HMTL
2013-12-18docs(guide/directive): improve access to isolate scope informationPete Bacon Darwin
Closes #5329
2013-12-17docs(bootstrap-prettify): fix $timeout issues and update related docsPete Bacon Darwin
End 2 end tests wait for all `$timeout`s to be run before completing the test. This was problematic where we were using timeouts that restarted themselves because there would never be a point when all timeouts had completed, causing the tests to hang. To fix this $timeout had been monkey-patched but this caused other issue itself. Now that we have $interval we don't need to use $timeout handlers that re-trigger the $timeout so we can ditch the monkey-patch. This commit tidies up any examples that are using this approach and changes them to use $interval instead. Closes #5232
2013-11-20docs(guide/directive): use `hideDialog` handler in exampleMaksim
The handler is in the controller but was not being used in the template. Closes #5020
2013-11-18docs(guide/directive): clarify code example for isolated scopes bindingsJens Berthold
Use different names for the attribute on the element (`info`) and the property (`customerInfo`) on the isolate scope. Before `customer` was used for both which made it harder to understand. Closes #4825
2013-11-18docs(guide/directive): add note about HTML case-insensitivityPete Bacon Darwin
Closes #4719
2013-11-14docs(guide/directive): split long linesPete Bacon Darwin
2013-11-14docs(guide/directive): clarify sentence meaningxdhmoore
Closes #4873
2013-11-06docs(guide/directive): link to directives API from the top of the pageBrian Ford
2013-11-05docs(guide/directive): fix transclusion exampleMichal Bendowski
The example about transclusion and scopes worked only because the order of `scope` and `element` arguments is wrong, which means that the `name' property of the scope is not really being updated. To really work, the directive has to define its own scope, either a new child scope or, as is more common with transclusion, an isolated scope. Closes #4774
2013-10-28docs(guide/directive): fix myDraggable for zoomed pageGabor Csizmadia
If you have zoomed into the page in your browser then the screen coordinate system no longer matches the page coordinate system. To ensure that dragged elements work correctly when zoomed we should use pageX/pageY rather than screenX/screenY. Closes #4687
2013-10-26docs(guide/directive): correct reference to myDir rather than ngBindJoe Grund
Closes #4647
2013-10-26docs(guide/directive): improve wordingPete Bacon Darwin
2013-10-26docs(guide/directive): we are registering directives, not controllersJoey Organisak
Closes #4615
2013-10-23docs(guide/directive,guide/compiler,): drastically improveBrian Ford
2013-10-18docs: correct broken linksVojta Jina
This also contains some whitespace corrections by my editor.
2013-10-14docs(guide/directive): improve readability and grammar.sflahave
Closes #4386
2013-10-03docs(guide/directive): clarify use of binding to scopesgdennie
The use of 'angular' as sample text is confusing to the newbie in that they are forced to confirm that the text 'angular' is not a keyword or otherwise referring to a system component. This is changed to a more obvious sample text. The most common form of `ngBind` is moved to the top of the list. Closes #4237
2013-10-03docs(guide/directive): fix indentation in example codemtaran-google
Closes #4241
2013-09-30docs(guide): describe directive replace:falseRon Waldon
Previous version stated `replace:false` will append template to element. Improve description to accurately state that template will _replace_ the contents of the current element. Closes #2235, #4166
2013-08-29docs(guide): remove duplicated `require` sectiontomazy
2013-07-31feat(directive): support as instance syntaxLucas Galfasó
Support controller: 'MyController as my' syntax for directives which publishes the controller instance to the directive scope. Support controllerAs syntax to define an alias to the controller within the directive scope.
2013-07-25feat($sce): new $sce service for Strict Contextual Escaping.Chirayu Krishnappa
$sce is a service that provides Strict Contextual Escaping services to AngularJS. Strict Contextual Escaping -------------------------- Strict Contextual Escaping (SCE) is a mode in which AngularJS requires bindings in certain contexts to result in a value that is marked as safe to use for that context One example of such a context is binding arbitrary html controlled by the user via ng-bind-html-unsafe. We refer to these contexts as privileged or SCE contexts. As of version 1.2, Angular ships with SCE enabled by default. Note: When enabled (the default), IE8 in quirks mode is not supported. In this mode, IE8 allows one to execute arbitrary javascript by the use of the expression() syntax. Refer http://blogs.msdn.com/b/ie/archive/2008/10/16/ending-expressions.aspx to learn more about them. You can ensure your document is in standards mode and not quirks mode by adding <!doctype html> to the top of your HTML document. SCE assists in writing code in way that (a) is secure by default and (b) makes auditing for security vulnerabilities such as XSS, clickjacking, etc. a lot easier. Here's an example of a binding in a privileged context: <input ng-model="userHtml"> <div ng-bind-html-unsafe="{{userHtml}}"> Notice that ng-bind-html-unsafe is bound to {{userHtml}} controlled by the user. With SCE disabled, this application allows the user to render arbitrary HTML into the DIV. In a more realistic example, one may be rendering user comments, blog articles, etc. via bindings. (HTML is just one example of a context where rendering user controlled input creates security vulnerabilities.) For the case of HTML, you might use a library, either on the client side, or on the server side, to sanitize unsafe HTML before binding to the value and rendering it in the document. How would you ensure that every place that used these types of bindings was bound to a value that was sanitized by your library (or returned as safe for rendering by your server?) How can you ensure that you didn't accidentally delete the line that sanitized the value, or renamed some properties/fields and forgot to update the binding to the sanitized value? To be secure by default, you want to ensure that any such bindings are disallowed unless you can determine that something explicitly says it's safe to use a value for binding in that context. You can then audit your code (a simple grep would do) to ensure that this is only done for those values that you can easily tell are safe - because they were received from your server, sanitized by your library, etc. You can organize your codebase to help with this - perhaps allowing only the files in a specific directory to do this. Ensuring that the internal API exposed by that code doesn't markup arbitrary values as safe then becomes a more manageable task. In the case of AngularJS' SCE service, one uses $sce.trustAs (and shorthand methods such as $sce.trustAsHtml, etc.) to obtain values that will be accepted by SCE / privileged contexts. In privileged contexts, directives and code will bind to the result of $sce.getTrusted(context, value) rather than to the value directly. Directives use $sce.parseAs rather than $parse to watch attribute bindings, which performs the $sce.getTrusted behind the scenes on non-constant literals. As an example, ngBindHtmlUnsafe uses $sce.parseAsHtml(binding expression). Here's the actual code (slightly simplified): var ngBindHtmlUnsafeDirective = ['$sce', function($sce) { return function(scope, element, attr) { scope.$watch($sce.parseAsHtml(attr.ngBindHtmlUnsafe), function(value) { element.html(value || ''); }); }; }]; Impact on loading templates --------------------------- This applies both to the ng-include directive as well as templateUrl's specified by directives. By default, Angular only loads templates from the same domain and protocol as the application document. This is done by calling $sce.getTrustedResourceUrl on the template URL. To load templates from other domains and/or protocols, you may either either whitelist them or wrap it into a trusted value. *Please note*: The browser's Same Origin Policy and Cross-Origin Resource Sharing (CORS) policy apply in addition to this and may further restrict whether the template is successfully loaded. This means that without the right CORS policy, loading templates from a different domain won't work on all browsers. Also, loading templates from file:// URL does not work on some browsers. This feels like too much overhead for the developer? ---------------------------------------------------- It's important to remember that SCE only applies to interpolation expressions. If your expressions are constant literals, they're automatically trusted and you don't need to call $sce.trustAs on them. e.g. <div ng-html-bind-unsafe="'<b>implicitly trusted</b>'"></div> just works. Additionally, a[href] and img[src] automatically sanitize their URLs and do not pass them through $sce.getTrusted. SCE doesn't play a role here. The included $sceDelegate comes with sane defaults to allow you to load templates in ng-include from your application's domain without having to even know about SCE. It blocks loading templates from other domains or loading templates over http from an https served document. You can change these by setting your own custom whitelists and blacklists for matching such URLs. This significantly reduces the overhead. It is far easier to pay the small overhead and have an application that's secure and can be audited to verify that with much more ease than bolting security onto an application later.
2013-07-24docs(directive): Clarified and cleaned up directive guideDean Sofer
- corrected terminology about how directives use `require` - added more variations to the DirectiveDefinitionObject - removed some slightly superfluous text docs(directive): Minor correction to example to avoid bad practice Anchor tags should use `ng-href` instead of `href` for interpolation. docs(directive): Supplementing DDO description DDO = Directive Definition Object Tweak recommended here: https://github.com/angular/angular.js/pull/2888/files#r4664565
2013-07-04docs(guide/directive): make directive controller minification-safeAndrew O'Brien
It is best to emphasize that the "controller" property needs to be min safe Closes #3125
2013-06-19feat(jqLite): switch bind/unbind to more recent jQuery on/offMichał Gołębiowski
jQuery switched to a completely new event binding implementation as of 1.7.0, centering around on/off methods instead of previous bind/unbind. This patch makes jqLite match this implementation while still supporting previous bind/unbind methods.
2013-06-19docs(directive): fix typosarkasm
2013-06-06refactor($route): pull $route and friends into angular-route.jsIgor Minar
$route, $routeParams and ngView have been pulled from core angular.js to angular-route.js/ngRoute module. This is was done to in order keep the core focused on most commonly used functionality and allow community routers to be freely used instead of $route service. There is no need to panic, angular-route will keep on being supported by the angular team. Note: I'm intentionally not fixing tutorial links. Tutorial will need bigger changes and those should be done when we update tutorial to 1.2. BREAKING CHANGE: applications that use $route will now need to load angular-route.js file and define dependency on ngRoute module. Before: ``` ... <script src="angular.js"></script> ... var myApp = angular.module('myApp', ['someOtherModule']); ... ``` After: ``` ... <script src="angular.js"></script> <script src="angular-route.js"></script> ... var myApp = angular.module('myApp', ['ngRoute', 'someOtherModule']); ... ``` Closes #2804
2013-05-22docs(guide/directive): clarify directive priorityJens Rantil
Fixes #2644.
2013-05-21doc($compile): clarify compile function return valueJens Rantil
If a compile function (within a directive) returns a function, it is a post-link function. Closes: #2713
2013-04-30docs(guide:directive): add directive controller usageChris Nicola
Specifically adding a directive controller to the example definition and how to use declare injectables to avoid minification errors.
2013-04-17docs(directive guide) typo in compile/link section@fbiville
The code snippet shows `{{action.description}}`, the explanation referred to it as `{{action.descriptions}}`.
2013-04-11docs(guide/directives): give more details about directive declarationLuc Morin
2013-03-29docs(directive): fix typoSrinivas Kusunam
2013-03-29docs(*): fixed typosPascal Borreli