diff --git a/BROWSER-SUPPORT.md b/BROWSER-SUPPORT.md new file mode 100644 index 0000000000..81fc161283 --- /dev/null +++ b/BROWSER-SUPPORT.md @@ -0,0 +1,56 @@ +# Browser Support +Browser support and polyfills guide. + +Browser compatibility and support depends on targeted browsers and 3rd party libraries. ADF framework is based on the following libraries and components: + +- Angular 2 (all ADF components) +- Material Design Lite (all ADF components) +- Moment.js (many ADF components) +- PDF.js (`ng2-alfresco-viewer` component) +- Raphael.js (`ng2-alfresco-diagrams`, `ng2-alfresco-analytics`) +- Chart.js (`ng2-alfresco-analytics`) +- Material Design - Date and Time Picker (`ng2-activiti-form`, `ng2-alfresco-analytics`) + +## Browser polyfills + +### Angular 2 +Please refer to the [official guide](https://angular.io/docs/ts/latest/guide/browser-support.html) for Angular 2 browser support. + +ADF (demo shell) imports by default the following set of recommended polyfills: + +- [core-js](https://www.npmjs.com/package/core-js) (ES6 standard support) + +### 3rd party libraries +Please refer to the following list of [popular polyfills](https://github.com/Modernizr/Modernizr/wiki/HTML5-Cross-Browser-Polyfills) for HTML5 cross-browser compatibility. + +ADF (demo shell) imports by default the following set of recommended polyfills: + +- [intl](https://www.npmjs.com/package/intl), Polyfill the ECMA-402 Intl API (except collation), **IE**/**Safari** +- [dom4](https://github.com/WebReflection/dom4), A fully tested and covered polyfill for new DOM Level 4 entries, **IE** +- [element.scrollintoviewifneeded-polyfill](https://www.npmjs.com/package/element.scrollintoviewifneeded-polyfill), simple JavaScript implementation of the non-standard WebKit method scrollIntoViewIfNeeded that can be called on DOM elements, **IE**/**Firefox**/**Safari**, required only to support **Material Design - Date and Time Picker** component +- [pdfjs compatibility](https://www.npmjs.com/package/pdfjs-dist), Portable Document Format (PDF) library that is built with HTML5, **IE** +- (dialog-polyfill)[https://www.npmjs.com/package/dialog-polyfill], Polyfill for the dialog element, **IE**/**Safari**/**Firefox** + +## Example + +```html + + + + + + + + + + + + + + + + + +``` + +For a complete code please refer to [demo shell](demo-shell-ng2/index.html) example. diff --git a/README.md b/README.md index 0fe12cf51c..d9251a57de 100644 --- a/README.md +++ b/README.md @@ -95,3 +95,5 @@ All components are supported in the below browsers: |Firefox* |Latest | *Concerning Alfresco Upload Component, folder upload currently not supported [firefox known issue](https://bugzilla.mozilla.org/show_bug.cgi?id=1188880 ) + +Please refer to [Browser Support](BROWSER-SUPPORT.md) article for more details.