├── .babelrc ├── .eslintrc.json ├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── .nvmrc ├── .travis.yml ├── CHANGELOG.md ├── CONTRIBUTING.md ├── CONTRIBUTORS.md ├── LICENSE ├── NOTICE ├── README.md ├── RELEASE.md ├── example ├── cross_origin_communication │ ├── 3_a_index.html │ ├── 3_a_provider.html │ ├── 3_b_index.html │ ├── 3_b_provider_error_page.html │ ├── 3_c_index.html │ ├── 3_c_provider_original_page.html │ └── 3_c_provider_redirected_page.html ├── embedded_app_lifecycle │ ├── 2_a_1_fit_content_of_embedded_iframe.html │ ├── 2_a_1_index.html │ ├── 2_a_embedded_statuses.html │ ├── 2_a_index.html │ ├── 2_b_1_fullscreen_content.html │ ├── 2_b_1_index.html │ ├── 2_b_1_trigger_fullscreen_event.html │ ├── 2_c_index.html │ ├── 2_c_provider_consumer_app.html │ └── 2_c_provider_embedded_app.html ├── focus_indicator │ ├── focus_indicator_index.html │ ├── focus_indicator_provider_no_interactable_elements.html │ ├── focus_indicator_provider_no_scrolling.html │ └── focus_indicator_provider_with_interactable_elements.html ├── initialization │ ├── 1_a_index.html │ ├── 1_a_one_domain_whitelist_provider.html │ ├── 1_a_two_domains_whitelist_provider.html │ ├── 1_b_index.html │ ├── 1_b_secret_function.html │ ├── 1_b_secret_function_failure.html │ ├── 1_b_secret_string_literal.html │ ├── 1_c_index.html │ ├── 1_c_on_ready_triggers_after_authorized.html │ ├── 1_c_provider_hidden_until_authorized.html │ ├── 1_d_index.html │ ├── 1_d_provider.html │ ├── 1_e_index.html │ └── 1_e_provider.html └── resizing │ ├── 4_a_index.html │ ├── 4_a_provider.html │ ├── 4_a_provider_2.html │ ├── 4_b_index.html │ ├── 4_c_index.html │ ├── 4_d_index.html │ └── 4_d_provider.html ├── package-lock.json ├── package.json ├── src ├── consumer │ ├── consumer.js │ ├── frame.js │ └── index.js ├── index.js ├── lib │ ├── dimension.js │ ├── logger.js │ ├── string.js │ └── uri.js └── provider │ ├── application.js │ ├── index.js │ └── provider.js ├── test ├── application.js ├── consumer.js ├── frame.js ├── mocha.opts └── provider.js ├── webpack.config.dev.js └── webpack.config.js /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | ["@babel/preset-env", { 4 | "targets": { 5 | "browsers": ["last 2 versions", "iOS >=10", "ie >= 10"] 6 | } 7 | }] 8 | ], 9 | "plugins": [ 10 | "@babel/transform-object-assign", 11 | "@babel/transform-runtime" 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | // When you write javascript you should follow these soft rules and best practices 2 | // https://github.com/airbnb/javascript 3 | 4 | // This is a link to best practices and enforcer settings for eslint 5 | // https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb 6 | 7 | // Use this file as a starting point for your project's .eslintrc. 8 | { 9 | "env": { 10 | "browser": true, 11 | "node": true, 12 | "jquery": true, 13 | "commonjs": true, 14 | "es6": true 15 | }, 16 | "extends": ["airbnb"], 17 | "rules": { 18 | "no-unused-vars": 0, 19 | "max-len": 0 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Please fill out the below template as best you can. 2 | -------------------------------------------------------- 3 | 4 | ### Description of Issue 5 | Describe the issue as best you can. Screenshots, logs, and stack traces can be very helpful! 6 | 7 | ### System Configuration 8 | #### Project Version 9 | 10 | #### Additional Details (optional) 11 | 12 | ### Steps to Reproduce the Issue 13 | 1. Step 1 14 | 1. Step 2 15 | 16 | ### Expected Outcomes 17 | - Links can be styled as buttons 18 | - Disabled links behave the same as disabled buttons 19 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### Summary 2 | Summarize the contents of the code changes in your pull request. Tag any open issues you believe to be resolved by this pull request. 3 | 4 | ### Additional Details 5 | If you have anything else that you think may be relevant to this issue, list it here. Additional information can help us better understand your changes and speed up the review process. 6 | 7 | Please add your name to the [CONTRIBUTORS.md] file. Adding your name to the [CONTRIBUTORS.md] file signifies agreement to all rights and reservations provided by the [License]. 8 | 9 | Thanks for contributing to xfc. 10 | 11 | [CONTRIBUTORS.md]: ../CONTRIBUTORS.md 12 | [License]: ../LICENSE 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | *.log 3 | npm-debug.log* 4 | 5 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 6 | .grunt 7 | 8 | # Dependency directories 9 | node_modules 10 | 11 | # Optional npm cache directory 12 | .npm 13 | 14 | build 15 | doc 16 | lib 17 | dist 18 | 19 | .DS_Store 20 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | lts/dubnium 2 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | script: 3 | - npm test 4 | - npm run lint-js 5 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | Next Release 2 | ------------- 3 | 1.12.0 4 | ------ 5 | * Add support for different styles during iframe focus/blur events. 6 | 7 | 1.11.0 8 | ------ 9 | * Create a custom dispatch to override parent.postMessage 10 | 11 | 1.10.1 12 | ------ 13 | * Remove sinon-test as dependency 14 | 15 | 1.10.0 16 | ------ 17 | * Add support for wildcard characters in acls urls. 18 | 19 | 1.9.0 20 | ------ 21 | * Add custom methods #47 22 | * Add generic options object to App init. #46 23 | 24 | 1.8.1 25 | ------ 26 | * Conditionally remove hasAttribute so it doesn't break on non-elements in IE10. #44 27 | 28 | 1.8.0 29 | ------ 30 | * Remove activeACL set by referrer, as it breaks if you have your own URL in the ACL list 31 | 32 | 1.7.3 33 | ------ 34 | * Fix verifyChallenge to properly handle and return the Promise.reject scenario. #41 35 | 36 | 1.7.2 37 | ------ 38 | * Fix Image resizing for slow loading images by calling on document. 39 | 40 | 1.7.1 41 | ------ 42 | * Add Image resizing for slow loading images. 43 | 44 | 1.7.0 45 | ------ 46 | * Fix resizing: use scrollHeight instead of offsetHeight 47 | 48 | 1.6.2 49 | ------ 50 | * Add classes for provider and consumer. 51 | 52 | 1.6.1 53 | ------ 54 | * Added href attribute pattern check before unloading. 55 | 56 | 1.6.0 57 | ------ 58 | * Remove frame origin check as it doesn't provide any added security value and makes 59 | integration more complicated for providing applications. 60 | 61 | 1.5.1 62 | ------ 63 | * Added download attribute check for IE11 in unload trigger. 64 | 65 | 1.5.0 66 | ------ 67 | * Added support for calculating height of body containing absolute positioned elements. 68 | * Restored default height calculation back to bodyOffset. 69 | 70 | 1.4.0 71 | ------ 72 | * Added trigger for frame unloading. #18 73 | * Updated default height calculation to bodyScroll. 74 | 75 | 1.3.2 76 | ------ 77 | * Updated default height calculation to max to account for dropdowns. 78 | 79 | 80 | 1.3.1 81 | ------ 82 | * Updated node version to 8.9.2 to support NPM 2FA 83 | 84 | 85 | 1.3.0 86 | ------ 87 | * Added the feature to pass in custom attributes for mounted iframe. 88 | * Added support for auto-authorizing the consumer. 89 | 90 | 91 | 1.2.1 92 | ------ 93 | * Removed message event listeners when unmounting frames. 94 | 95 | 96 | 1.2.0 97 | ------ 98 | * Added `load` method to frame in consumer. 99 | * Updated consumer's unmount method to avoid potential memory leak. 100 | 101 | 102 | 1.1.0 103 | ------ 104 | * Removed the need of adding polyfills when consuming xfc. 105 | 106 | 107 | 1.0.2 108 | ------ 109 | * Updated dependency "mutation-observer" to v1.0.3 or above. 110 | 111 | 112 | 1.0.1 113 | ------ 114 | * Updated Webpack to v2. 115 | 116 | 117 | 1.0.0 118 | ------ 119 | * Initial release 120 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Help us to make this project better by contributing. Whether it's new features, bug fixes, or simply improving documentation, your contributions are welcome. Please start with logging a [github issue][1] or submit a pull request. 4 | 5 | Before you contribute, please review these guidelines to help ensure a smooth process for everyone. 6 | 7 | Thanks. 8 | 9 | ## Issue Reporting 10 | 11 | * Please browse our [existing issues][1] before logging new issues. 12 | * Check that the issue has not already been fixed in the `master` branch. 13 | * Open an issue with a descriptive title and a summary. 14 | * Please be as clear and explicit as you can in your description of the problem. 15 | * Please state the version of {technical dependencies} and xfc you are using in the description. 16 | * Include any relevant code in the issue summary. 17 | 18 | ## Pull Requests 19 | 20 | * Read [how to properly contribute to open source projects on Github][2]. 21 | * Fork the project. 22 | * Use a feature branch. 23 | * Write [good commit messages][3]. 24 | * Use the same coding conventions as the rest of the project. 25 | * Commit locally and push to your fork until you are happy with your contribution. 26 | * Make sure to add tests and verify all the tests are passing when merging upstream. 27 | * Add an entry to the [Changelog][4] accordingly. 28 | * Please add your name to the [CONTRIBUTORS.md][8] file. Adding your name to the [CONTRIBUTORS.md][8] file signifies agreement to all rights and reservations provided by the [License][5]. 29 | * [Squash related commits together][6]. 30 | * Open a [pull request][7]. 31 | * The pull request will be reviewed by the community and merged by the project committers. 32 | 33 | [1]: https://github.com/cerner/xfc/issues 34 | [2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request 35 | [3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html 36 | [4]: ./CHANGELOG.md 37 | [5]: ./LICENSE 38 | [6]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html 39 | [7]: https://help.github.com/articles/using-pull-requests 40 | [8]: ./CONTRIBUTORS.md 41 | -------------------------------------------------------------------------------- /CONTRIBUTORS.md: -------------------------------------------------------------------------------- 1 | Cerner Corporation 2 | 3 | - Mike Hemesath [@mhemesath] 4 | - Wei Hou [@kafkahw] 5 | - Chris Gurba [@cmgurba] 6 | - Elliott Hoffman [@slor] 7 | - Greg Howdeshell [@poloka] 8 | - Matt Schile [@mschile] 9 | - Sam Milligan [@grneggandsam] 10 | - Supriti Yeotikar [@supritiy] 11 | - Cody Price [@dev-cprice] 12 | - Roxanne Calderon [@foxannefoxanne] 13 | - Yusuf Ali [@yusufali2205] 14 | - Jake Varness [@jvarness] 15 | - Kol Kheang [@kolkheang] 16 | 17 | [@mhemesath]: https://github.com/mhemesath 18 | [@kafkahw]: https://github.com/kafkahw 19 | [@cmgurba]: https://github.com/cmgurba 20 | [@slor]: https://github.com/slor 21 | [@poloka]: https://github.com/poloka 22 | [@mschile]: https://github.com/mschile 23 | [@grneggandsam]: https://github.com/grneggandsam 24 | [@supritiy]: https://github.com/supriticerner 25 | [@dev-cprice]: https://github.com/dev-cprice 26 | [@foxannefoxanne]: https://github.com/foxannefoxanne 27 | [@yusufali2205]: https://github.com/yusufali2205 28 | [@jvarness]: https://github.com/jvarness 29 | [@kolkheang]: https://github.com/kolkheang 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Copyright 2017 Cerner Innovation, Inc. 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); 4 | you may not use this file except in compliance with the License. 5 | You may obtain a copy of the License at 6 | 7 | http://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, 11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | See the License for the specific language governing permissions and 13 | limitations under the License. 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # XFC (Cross-Frame-Container) 2 | 3 | [![Build Status](https://travis-ci.org/cerner/xfc.svg?branch=master)](https://travis-ci.org/cerner/xfc) 4 | [![npm version](https://badge.fury.io/js/xfc.svg)](https://badge.fury.io/js/xfc) 5 | 6 | This project handles securely embedding web content into a 3rd party domain. Out of the box, it provides several features: 7 | 8 | * Clickjacking protection using either a trusted origin or secret 9 | * Automatic iFrame resizing 10 | * Event dispatching from embedded content into a framework 11 | 12 | ## Usage 13 | Include `xfc.js` in your project. 14 | 15 | Ensure `process.env.NODE_ENV` is set correctly in the build enviornment. Logging is only enabled in non-production environments. The environment can be set in webpack using the [DefinePlugin](https://webpack.js.org/guides/production-build/) 16 | 17 | ```js 18 | // webpack.config.js 19 | const webpack = require('webpack'); 20 | 21 | module.exports = { 22 | /*...*/ 23 | plugins:[ 24 | new webpack.DefinePlugin({ 25 | 'process.env.NODE_ENV': JSON.stringify('production') 26 | }) 27 | ] 28 | }; 29 | ``` 30 | 31 | ### Setting Up A Consumer 32 | The consumer is the application which is embedding the 3rd party applications within it. 33 | 34 | ```js 35 | // Create an app broker to manage embedded apps 36 | XFC.Consumer.init() 37 | 38 | // Mount the app at this URL and append its frame to the body element. 39 | var frame = XFC.Consumer.mount(document.body, 'http://localprovider.com:8080/example/provider.html') 40 | ``` 41 | 42 | If the embedded app does not know which domain to trust, it may require secret authorization. 43 | 44 | ```js 45 | var frame = XFC.Consumer.mount(document.body, 'http://localprovider.com:8080/example/provider_b.html', {secret: 'abc123'}) 46 | ``` 47 | 48 | To remove and clean up a mounted app, simply call `unmount` method. 49 | 50 | ```js 51 | frame.unmount() 52 | ``` 53 | 54 | To load a new page within the existing frame, simply call `load` method with the new URL. 55 | 56 | ```js 57 | frame.load(newURL) 58 | ``` 59 | 60 | 61 | #### Iframe Resizing Config 62 | By default, the height of iframe will automatically resize based on the height of the embedded content. This behavior can be changed by passing an extra option (`resizeConfig`) into `mount` method. 63 | 64 | ```js 65 | // Pass scrolling as true to resizeConfig to make scrollbar show up. 66 | XFC.Consumer.mount(document.body, 'http://localprovider.com:8080/example/provider.html', { resizeConfig: { scrolling: true } }); 67 | ``` 68 | 69 | `resizeConfig` is an object that accepts the following attributes. 70 | 71 | | name | type | default value | usage | 72 | |:---: |:---: |:---: |--- | 73 | | scrolling | boolean | `false` | When set to be `true`, scrollbar may show up on iframe. | 74 | | autoResizeWidth | boolean | `false` | When set to be `true`, iframe will autoresize on width instead of on height | 75 | | fixedHeight | string | empty string | If specified (e.g. '200px'), the height will stay at the specified value.

NOTE: setting this attribute will turn off autoresizing.| 76 | | fixedWidth | string | empty string | If specified (e.g. '400px'), the width of iframe will stay at the specified value.

NOTE: setting this attribute will turn off autoresizing. | 77 | | heightCalculationMethod | string | `'bodyOffset'` | Accepted values:
`'bodyOffset'` - use `document.body.offsetHeight`

`'bodyScroll'` - use `document.body.scrollHeight`

`'documentElementOffset'` - use `document.documentElement.offsetHeight`

`'documentElementScroll'` - use `document.documentElement.scrollHeight`

`'max'` - max of all of above options.

`'min'` - min of all of above options.| 78 | | widthCalculationMethod | string | `'scroll'` | Accepted values:
`'bodyOffset'` - use `document.body.offsetWidth`

`'bodyScroll'` - use `document.body.scrollWidth`

`'documentElementOffset'` - use `document.documentElement.offsetWidth`

`'documentElementScroll'` - use `document.documentElement.scrollWidth`

`'scroll'` - max of `bodyScroll` and `documentElementScroll`

`'max'` - max of all of above options.

`'min'` - min of all of above options.| 79 | | customCalculationMethod | function | null | When specified, XFC will use the given method to update iframe's size when necessary (e.g. dom changes, window resized, etc.)

NOTE: context `this` is provided as iframe to this method, so in the method you can access the iframe by accessing `this` | 80 | | targetSelectors | string | null | When the embedded page contains elements styled with `position: absolute`, the iframe resizing logic won't calculate the height of the embedded page correctly because those elements are removed from normal document flow.

In this case, targetSelectors can be used to specify those absolute positioned elements so that they will be taken into consideration when calculating the height of the embedded page. Multiple selectors may be specified by separating them using commas.

If not specified, normal resizing logic will be used.

NOTE: this attribute can be also specified from Provider's side, e.g. `XFC.Provider.init({targetSelectors: '#target'})`| 81 | 82 | 83 | ### Setting Custom Attributes on Iframe 84 | Sometimes, it's useful for developers to add more attributes onto mounted iframes. A common use case, for instance, is adding `allow` attribute to `