aboutsummaryrefslogtreecommitdiffstats
path: root/docs/src
AgeCommit message (Collapse)Author
2013-11-05fix(ngdocs): `shortDescription()` should not error if no `description`Pete Bacon Darwin
2013-11-04chore(docs): fix ordering of docs in the guideBrian Ford
2013-10-27chore(ngdocs): improve the docs search placeholder textMatias Niemelä
2013-10-26docs(ngdoc.js): fix usage to display attributes as dash-caseDavid Bennett
Closes 4611
2013-10-24chore(ngdocs): ensure the docs menu changes when browsing a different sectionMatias Niemelä
Closes #4619
2013-10-23feat(docs): provide index pages for each angular moduleMatias Niemelä
2013-10-22feat(ngdocs): add forward slash shortcut key for search barMatias Niemelä
2013-10-22fix(ngdocs): remove the side search barMatias Niemelä
BREAKING CHANGE The side search bar on the docs page has been removed in favor of the top search bar.
2013-10-18chore(docs): generate header ids for better linkingVojta Jina
- generate ids for all headers - collect defined anchors - check broken links (even if the page exists, but the anchor/id does not)
2013-10-10chore(ngdocs): improve the side search animation effectsMatias Niemelä
2013-10-08feat(tutorial): add step 12 of the phonecat tutorialBrian Ford
2013-09-30fix(docs.js): handle empty deps array for plunkr/jsfiddleJames Daily
Change return value of docsApp.serviceFactory.prepareDefaultAppModule to include empty array `[]` instead of array containing one empty string element `['']`. This will correct script.js for simple plunkr/jsfiddle examples such as [ngChecked](http://docs.angularjs.org/api/ng.directive:ngChecked).
2013-09-30fix(ngdoc): add default values to ngdoc templateDag-Inge Aas
ngDoc did not add default value to template, even though it was present in the documentation. This change adds the default value to the description column in the parameters table. Closes #3950
2013-09-27feat(docs): linkify error messages on minErr docs pagesKen Sheedlo
2013-09-26docs(minerr): fix bad line wrap due to errand nowrap in CSSBrian Ford
2013-09-25docs(docs.css): prevent `<code>` elements from wrappingMisha Moroshko
Closes #4114
2013-09-16docs(ngdoc): fix spelling mistakeTim Statler
Closes #3836
2013-09-11fix(ngdoc.js): update default directive restrict to 'A'rodyhaddad
2013-09-04chore(ngdoc): fix version number parsing for doc version switcherIgor Minar
2013-08-30fix(guide) broken title overflow in navlistgdi2290
2013-08-23fix($animate): skip ngAnimate animations if the provided element already has ↵Matias Niemelä
transitions/durations attached to it Closes #3587
2013-08-23chore(ngdocs): fix the version jumperMatias Niemelä
correct the ordering and make gen-docs prepare the list of versions during the build process
2013-08-22docs(module): improve the installation instructions for optional modulesBrian Ford
Currently, the documentation does a bad job of explaining the distinction between the services that it provides, and the module itself. Furthermore, the instructions for using optional modules are inconsistent or missing. This commit addresses the problem by ading a new `{@installModule foo}` annotation to the docs generator that inlines the appropriate instructions based on the name of the module.
2013-08-20fix(ngdocs): use cdn version to generate link to source filesJames Daily
Closes #3616 Closes #3675
2013-08-16fix(docs): wrap error message text inside boxKen Sheedlo
2013-08-16chore(ngdocs): disable google analytics in e2e testsIgor Minar
GA is not needed during e2e tests, so I'm removing it to speed up the e2e test suite. See previous commits for more info.
2013-08-16chore(ngdocs): disable code prettification in e2e testsIgor Minar
code prettification is expensive and not needed for e2e tests, so I'm disabling it to speed up the e2e test suite. this is a temporary measure, see previous commit for more info.
2013-08-16chore(ngdocs): disable lunr search during e2e testsIgor Minar
lunr has been responsible for slowdown in our test suite by adding ~1sec per end-to-end test. (this is because it initializes the index when the app starts) since out test suite primarily tests the examples, it's reasonable do disable the search as a temporary meansure. the real fix is to use protractor and extract all of the examples into standalone apps which can be tested without bootstrapping the whole docs app.
2013-08-14chore(ngdocs): fixup the docs version switcherIgor Minar
2013-08-12fix(minerr): escape double quotes in error displaysKen Sheedlo
Closes #3553
2013-08-09chore(ngMobile): rename module ngTouch and file to angular-touch.jsBrian Ford
BREAKING CHANGE: since all the code in the ngMobile module is touch related, we are renaming the module to ngTouch. To migrate, please replace all references to "ngMobile" with "ngTouch" and "angular-mobile.js" to "angular-touch.js". Closes #3526
2013-08-08fix(docs/error): make minerr ids searchableKen Sheedlo
Closes #3513
2013-08-05fix(tutorial): show tutorial pages in search navKen Sheedlo
2013-08-02chore(ngdocs): make sure the fold feature doesn't show up during page loadMatias Niemelä
2013-08-01fix(docs): handle the empty string in errorDisplayKen Sheedlo
2013-07-31docs(header): replace logo.png with logo.svgBrenton
The current logo looks awful on high-density displays. SVG is a better choice because it can scale to any resolution without increasing file size. Amending #2775 to add support for IE 8 by falling back to existing PNG with img.onerror Using relative URLs as directed by @btford and @petebacondarwin. (commit by Brenton Simpson - @appsforartists) Closes #2874
2013-07-29chore(ngdocs): all animation-supported directives working with docs examples ↵Matias Niemelä
and jsFiddle/Plunkr pages
2013-07-29chore(ngdocs): fixed jsFiddle/Plunkr examples to include ngAnimate and use a ↵Matias Niemelä
default App the module is not set
2013-07-29fix(ngdocs): make jsFiddle and Plunkr links work with external AngularJS modulesMatias Niemelä
2013-07-29fix(bower): update bower usage and resourcesKen Sheedlo
Changes: - Fix our old code to use bower_components/ as the install dir - Fix the Bootstrap asset to use github.com/twbs/bootstrap (it moved) - Fail the build on Bower failure. Bower should not fail silently.
2013-07-27fix(docs): fix margin around nav-list itemsKen Sheedlo
Closes #3363
2013-07-26chore(ngdocs): fix docs search to properly hide the X button when collapsedMatias Niemelä
2013-07-26fix(ngInclude): $animate refactoring + use transclusionMatias Niemelä
BREAKING CHANGE: previously ngInclude only updated its content, after this change ngInclude will recreate itself every time a new content is included. This ensures that a single rootElement for all the included contents always exists, which makes definition of css styles for animations much easier.
2013-07-26feat(ngAnimate): complete rewrite of animationsMatias Niemelä
- ngAnimate directive is gone and was replaced with class based animations/transitions - support for triggering animations on css class additions and removals - done callback was added to all animation apis - $animation and $animator where merged into a single $animate service with api: - $animate.enter(element, parent, after, done); - $animate.leave(element, done); - $animate.move(element, parent, after, done); - $animate.addClass(element, className, done); - $animate.removeClass(element, className, done); BREAKING CHANGE: too many things changed, we'll write up a separate doc with migration instructions
2013-07-26chore(ngdocs): replace showdown.js with marked.jsMatias Niemelä
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(minErr): Build minErr doc siteKen Sheedlo
2013-07-23docs(index): add seed app link to menu itemRichard John
2013-07-18chore(ngdocs): fix improve button overlapMatias Niemelä
2013-07-16fix(writer): fix makeDir directory tree bugKen Sheedlo