othmane/ohif-viewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Creating a README file for ohif:polyfill package

Browse Source
This commit is contained in:
Bruno Alves de Faria 2017-04-21 09:48:57 -03:00
parent 42d7ed3134
commit 2def6ff43e
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Packages/ohif-polyfill/README.md Normal file
View File

@ -0,0 +1,21 @@
## ohif:polyfill
This package provides polyfills for older browsers which make them compatible with the application.
#### Creating assets
Every polyfill shall be added as an asset JS file in the Meteor package definition file (**package.js**) and its file shall be placed inside the **public/js** directory. Adding these files as assets will prevent them from being loaded on all browsers without need.
These files are exposed to the client and can be accessed through the application's **/packages/ohif_polyfill/public/js/** URI.
#### Enabling polyfills
In order to enable a polyfill for a specific browser, a JS file shall be created inside the package's **client** directory with the browser name.
We must check the current browser to include the polyfills, and to enable a polyfill we need something like this:
````js
import { absoluteUrl } from './lib/absoluteUrl';
if (navigator && /BrowserID/.test(navigator.userAgent)) {
const src = absoluteUrl('/packages/ohif_polyfill/public/js/mypolyfill.min.js');
document.write(`<script src="${src}"><\/script>`);
}
````