- Getting Started
- Container Development @@ -185,8 +185,8 @@
- diff --git a/docs/dist/app-development.html b/docs/dist/app-development.html index 720db32c..c745d1a0 100644 --- a/docs/dist/app-development.html +++ b/docs/dist/app-development.html @@ -91,7 +91,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -855,7 +855,7 @@
- diff --git a/docs/dist/container-development.html b/docs/dist/container-development.html index 52fd4db3..6cd2b46e 100644 --- a/docs/dist/container-development.html +++ b/docs/dist/container-development.html @@ -91,7 +91,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -290,7 +290,7 @@
- diff --git a/docs/dist/extending-f2.html b/docs/dist/extending-f2.html index 5f766cf1..7c872a05 100644 --- a/docs/dist/extending-f2.html +++ b/docs/dist/extending-f2.html @@ -91,7 +91,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -165,7 +165,7 @@
- diff --git a/docs/dist/f2js-sdk.html b/docs/dist/f2js-sdk.html index f7c47c7a..7baa51db 100644 --- a/docs/dist/f2js-sdk.html +++ b/docs/dist/f2js-sdk.html @@ -91,7 +91,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -139,10 +139,10 @@
F2.js SDK
F2.js#
F2 is an open framework and to get Container and App Developers started, there is a JavaScript SDK—called F2.js—in addition to example apps as part of an open-source project maintained on GitHub.
Download#
Anyone is free to download F2.js from the F2 project repository on GitHub. Once downloaded, F2.js can be added to any web page using a script tag:
-<script src="//cdnjs.cloudflare.com/ajax/libs/F2/1.4.4/f2.min.js"></script> +
-<script src="//cdnjs.cloudflare.com/ajax/libs/F2/1.4.5/f2.min.js"></script>The latest version of F2.js is 1.4.4.
-Download F2.js 1.4.4 View on GitHub
+The latest version of F2.js is 1.4.5.
+Download F2.js 1.4.5 View on GitHub
Packages#
Packages are variants of F2.js. They are ideally used when, for example, a container already has jQuery or sandboxed apps aren’t needed. In circumstances where not all F2 features are required, Container Providers can use smaller, faster, lighter-weight versions of F2.js. Choose one below:
-
@@ -183,11 +183,11 @@
- diff --git a/docs/dist/index.html b/docs/dist/index.html index 2bcd3d74..6690ae39 100644 --- a/docs/dist/index.html +++ b/docs/dist/index.html @@ -91,7 +91,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -160,11 +160,11 @@
- diff --git a/docs/dist/sdk/classes/F2.App.html b/docs/dist/sdk/classes/F2.App.html index 33ea4fe3..29635c40 100644 --- a/docs/dist/sdk/classes/F2.App.html +++ b/docs/dist/sdk/classes/F2.App.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -443,7 +443,7 @@
- diff --git a/docs/dist/sdk/classes/F2.AppConfig.html b/docs/dist/sdk/classes/F2.AppConfig.html index 44b159c0..e2175357 100644 --- a/docs/dist/sdk/classes/F2.AppConfig.html +++ b/docs/dist/sdk/classes/F2.AppConfig.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -914,7 +914,7 @@
- diff --git a/docs/dist/sdk/classes/F2.AppHandlers.html b/docs/dist/sdk/classes/F2.AppHandlers.html index fdc10eb4..a55cd5de 100644 --- a/docs/dist/sdk/classes/F2.AppHandlers.html +++ b/docs/dist/sdk/classes/F2.AppHandlers.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -830,7 +830,7 @@
- diff --git a/docs/dist/sdk/classes/F2.AppManifest.AppContent.html b/docs/dist/sdk/classes/F2.AppManifest.AppContent.html index 97aaeda3..8b90c565 100644 --- a/docs/dist/sdk/classes/F2.AppManifest.AppContent.html +++ b/docs/dist/sdk/classes/F2.AppManifest.AppContent.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -370,7 +370,7 @@
- diff --git a/docs/dist/sdk/classes/F2.AppManifest.html b/docs/dist/sdk/classes/F2.AppManifest.html index 99490a8f..fcec09a1 100644 --- a/docs/dist/sdk/classes/F2.AppManifest.html +++ b/docs/dist/sdk/classes/F2.AppManifest.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -408,7 +408,7 @@
- diff --git a/docs/dist/sdk/classes/F2.Constants.AppHandlers.html b/docs/dist/sdk/classes/F2.Constants.AppHandlers.html index f7b7297f..954ed095 100644 --- a/docs/dist/sdk/classes/F2.Constants.AppHandlers.html +++ b/docs/dist/sdk/classes/F2.Constants.AppHandlers.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -826,7 +826,7 @@
- diff --git a/docs/dist/sdk/classes/F2.Constants.Css.html b/docs/dist/sdk/classes/F2.Constants.Css.html index ae3e35fd..b15b31b2 100644 --- a/docs/dist/sdk/classes/F2.Constants.Css.html +++ b/docs/dist/sdk/classes/F2.Constants.Css.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -573,7 +573,7 @@
- diff --git a/docs/dist/sdk/classes/F2.Constants.Events.html b/docs/dist/sdk/classes/F2.Constants.Events.html index aafa2c1c..e0126b84 100644 --- a/docs/dist/sdk/classes/F2.Constants.Events.html +++ b/docs/dist/sdk/classes/F2.Constants.Events.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -574,7 +574,7 @@
- diff --git a/docs/dist/sdk/classes/F2.Constants.Sockets.html b/docs/dist/sdk/classes/F2.Constants.Sockets.html index aeaee389..ff79bcb5 100644 --- a/docs/dist/sdk/classes/F2.Constants.Sockets.html +++ b/docs/dist/sdk/classes/F2.Constants.Sockets.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -467,7 +467,7 @@
- diff --git a/docs/dist/sdk/classes/F2.Constants.Views.html b/docs/dist/sdk/classes/F2.Constants.Views.html index 377d4cc0..76086011 100644 --- a/docs/dist/sdk/classes/F2.Constants.Views.html +++ b/docs/dist/sdk/classes/F2.Constants.Views.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -508,7 +508,7 @@
- diff --git a/docs/dist/sdk/classes/F2.Constants.html b/docs/dist/sdk/classes/F2.Constants.html index c37d5cce..6eed6c86 100644 --- a/docs/dist/sdk/classes/F2.Constants.html +++ b/docs/dist/sdk/classes/F2.Constants.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -244,7 +244,7 @@
- diff --git a/docs/dist/sdk/classes/F2.ContainerConfig.UI.Mask.html b/docs/dist/sdk/classes/F2.ContainerConfig.UI.Mask.html index 952d081a..165a0cbe 100644 --- a/docs/dist/sdk/classes/F2.ContainerConfig.UI.Mask.html +++ b/docs/dist/sdk/classes/F2.ContainerConfig.UI.Mask.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -452,7 +452,7 @@
- diff --git a/docs/dist/sdk/classes/F2.ContainerConfig.UI.html b/docs/dist/sdk/classes/F2.ContainerConfig.UI.html index 5571e698..516072a6 100644 --- a/docs/dist/sdk/classes/F2.ContainerConfig.UI.html +++ b/docs/dist/sdk/classes/F2.ContainerConfig.UI.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -244,7 +244,7 @@
- diff --git a/docs/dist/sdk/classes/F2.ContainerConfig.html b/docs/dist/sdk/classes/F2.ContainerConfig.html index 99f82684..33eb0210 100644 --- a/docs/dist/sdk/classes/F2.ContainerConfig.html +++ b/docs/dist/sdk/classes/F2.ContainerConfig.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -1499,7 +1499,7 @@
- diff --git a/docs/dist/sdk/classes/F2.Events.html b/docs/dist/sdk/classes/F2.Events.html index ea05ac37..86ea8961 100644 --- a/docs/dist/sdk/classes/F2.Events.html +++ b/docs/dist/sdk/classes/F2.Events.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -823,7 +823,7 @@
- diff --git a/docs/dist/sdk/classes/F2.Rpc.html b/docs/dist/sdk/classes/F2.Rpc.html index 350c6a7a..88a9543a 100644 --- a/docs/dist/sdk/classes/F2.Rpc.html +++ b/docs/dist/sdk/classes/F2.Rpc.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -349,6 +349,22 @@
- + instanceId + +
- + instanceId + +
-
+
instanceId+ String + + +++ +The Instance ID
+ +
+ - diff --git a/docs/dist/sdk/classes/F2.UI.Modals.html b/docs/dist/sdk/classes/F2.UI.Modals.html index 08501ece..18016987 100644 --- a/docs/dist/sdk/classes/F2.UI.Modals.html +++ b/docs/dist/sdk/classes/F2.UI.Modals.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -458,7 +458,7 @@
- diff --git a/docs/dist/sdk/classes/F2.UI.Views.html b/docs/dist/sdk/classes/F2.UI.Views.html index 954e7c93..36249792 100644 --- a/docs/dist/sdk/classes/F2.UI.Views.html +++ b/docs/dist/sdk/classes/F2.UI.Views.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -511,7 +511,7 @@
- diff --git a/docs/dist/sdk/classes/F2.UI.html b/docs/dist/sdk/classes/F2.UI.html index 87b3f678..0c226c1e 100644 --- a/docs/dist/sdk/classes/F2.UI.html +++ b/docs/dist/sdk/classes/F2.UI.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -895,7 +895,7 @@
- diff --git a/docs/dist/sdk/classes/F2.html b/docs/dist/sdk/classes/F2.html index db1c7e28..1ba70e30 100644 --- a/docs/dist/sdk/classes/F2.html +++ b/docs/dist/sdk/classes/F2.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -3271,7 +3271,7 @@
- diff --git a/docs/dist/sdk/data.json b/docs/dist/sdk/data.json index 2870452f..67d34601 100644 --- a/docs/dist/sdk/data.json +++ b/docs/dist/sdk/data.json @@ -2770,6 +2770,22 @@ "class": "F2.Rpc", "module": "f2" }, + { + "file": "sdk\\src\\rpc.js", + "line": 325, + "description": "Cleans up a given app instance", + "itemtype": "method", + "name": "destroy", + "params": [ + { + "name": "instanceId", + "description": "The Instance ID", + "type": "String" + } + ], + "class": "F2.Rpc", + "module": "f2" + }, { "file": "sdk\\src\\ui.js", "line": 58, diff --git a/docs/dist/sdk/files/sdk_src_F2.js.html b/docs/dist/sdk/files/sdk_src_F2.js.html index cf681d8c..91a137f8 100644 --- a/docs/dist/sdk/files/sdk_src_F2.js.html +++ b/docs/dist/sdk/files/sdk_src_F2.js.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -583,7 +583,7 @@
- diff --git a/docs/dist/sdk/files/sdk_src_app_handlers.js.html b/docs/dist/sdk/files/sdk_src_app_handlers.js.html index 0bb4a862..0d01b440 100644 --- a/docs/dist/sdk/files/sdk_src_app_handlers.js.html +++ b/docs/dist/sdk/files/sdk_src_app_handlers.js.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -860,7 +860,7 @@
- diff --git a/docs/dist/sdk/files/sdk_src_classes.js.html b/docs/dist/sdk/files/sdk_src_classes.js.html index 890a620d..a89de7e9 100644 --- a/docs/dist/sdk/files/sdk_src_classes.js.html +++ b/docs/dist/sdk/files/sdk_src_classes.js.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -770,7 +770,7 @@
- diff --git a/docs/dist/sdk/files/sdk_src_constants.js.html b/docs/dist/sdk/files/sdk_src_constants.js.html index 890f56af..10c26eea 100644 --- a/docs/dist/sdk/files/sdk_src_constants.js.html +++ b/docs/dist/sdk/files/sdk_src_constants.js.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -531,7 +531,7 @@
- diff --git a/docs/dist/sdk/files/sdk_src_container.js.html b/docs/dist/sdk/files/sdk_src_container.js.html index d65cfc8e..3e07bd6f 100644 --- a/docs/dist/sdk/files/sdk_src_container.js.html +++ b/docs/dist/sdk/files/sdk_src_container.js.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -1433,6 +1433,10 @@ _apps[instanceId] // the app instance ); + if (_apps[instanceId].config.isSecure) { + F2.Rpc.destroy(instanceId); + } + delete _apps[instanceId]; } } @@ -1473,7 +1477,7 @@
- diff --git a/docs/dist/sdk/files/sdk_src_events.js.html b/docs/dist/sdk/files/sdk_src_events.js.html index 05b9c2d4..3d31309f 100644 --- a/docs/dist/sdk/files/sdk_src_events.js.html +++ b/docs/dist/sdk/files/sdk_src_events.js.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -297,7 +297,7 @@
- diff --git a/docs/dist/sdk/files/sdk_src_rpc.js.html b/docs/dist/sdk/files/sdk_src_rpc.js.html index e5d52573..8556f178 100644 --- a/docs/dist/sdk/files/sdk_src_rpc.js.html +++ b/docs/dist/sdk/files/sdk_src_rpc.js.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -502,6 +502,18 @@ } else { F2.log('Unable to register socket connection. Please check container configuration.'); } + }, + + /** + * Cleans up a given app instance + * @method destroy + * @param {string} instanceId The Instance ID + */ + destroy: function(instanceId) { + if (_apps[instanceId] && _apps[instanceId].socket) { + _apps[instanceId].socket.destroy(); + } + delete _apps[instanceId]; } }; })()); @@ -539,7 +551,7 @@
- diff --git a/docs/dist/sdk/files/sdk_src_ui.js.html b/docs/dist/sdk/files/sdk_src_ui.js.html index 3a01884a..3faf6283 100644 --- a/docs/dist/sdk/files/sdk_src_ui.js.html +++ b/docs/dist/sdk/files/sdk_src_ui.js.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -634,7 +634,7 @@
- diff --git a/docs/dist/sdk/index.html b/docs/dist/sdk/index.html index 0493c929..ace043bc 100644 --- a/docs/dist/sdk/index.html +++ b/docs/dist/sdk/index.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -187,11 +187,11 @@
- diff --git a/docs/dist/sdk/modules/f2.html b/docs/dist/sdk/modules/f2.html index 0f0f70b4..26509a08 100644 --- a/docs/dist/sdk/modules/f2.html +++ b/docs/dist/sdk/modules/f2.html @@ -89,7 +89,7 @@
- Home
- Developers
-
- Docs v1.4.4
+ Docs v1.4.5
- Getting Started
- Container Development @@ -337,7 +337,7 @@
- diff --git a/package.json b/package.json index 09b26646..42f7e92d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "f2", "description": "An open framework for the financial services industry.", - "version": "1.4.4", + "version": "1.4.5", "main": "dist/f2.debug", "keywords": [ "openf2" @@ -47,9 +47,9 @@ "engines": { "node": ">=6" }, - "_releaseDate": "2018-01-31T23:18:46.833Z", - "_releaseDateFormatted": "31 January 2018", + "_releaseDate": "2018-03-02T20:52:10.133Z", + "_releaseDateFormatted": "2 March 2018", "dependencies": { "grunt-cli": "^1.2.0" } -} +} \ No newline at end of file
F2
Getting Started
To instantly F2-enable your solution, download and include F2.js on your web pages. It's only 7.6kb and works with jQuery, Angular, Dojo, ExtJS and other toolkits. You can use any backend you'd like; .NET, Java, Node.js, PHP and more are all supported.
Latest Version
-The latest version of F2 is 1.4.4. Previous versions are available on GitHub.
+The latest version of F2 is 1.4.5. Previous versions are available on GitHub.
- +Examples
@@ -268,7 +268,7 @@F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
Methods
Calls a remote function
++ + + destroy + ( + +-
+
Cleans up a given app instance
@@ -909,6 +925,60 @@ Parameters:
+
+ +++ destroy + ( +
+ +-
+
++ ++ Defined in +
+ + + +sdk\src\rpc.js:325+++ +Cleans up a given app instance
+ +++ +Parameters:
+ +-
+
@@ -1143,7 +1213,7 @@F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
F2
API Reference
-Latest Version#
The latest version of F2 is 1.4.4 which was released on 31 January 2018.
+Latest Version#
The latest version of F2 is 1.4.5 which was released on 2 March 2018.
F2 v1.0 was originally open sourced in October 2012. A detailed changelog and roadmap are available on GitHub.
- +
Examples#
There are a few different types of examples available below.
@@ -288,7 +288,7 @@F2
VersioningUpgrading#
It is our goal to make upgrading to the latest version of F2 a minor effort for development teams. The details from each release of F2, minor and major, are tracked in the changelog. As of version 1.2, no breaking changes have been introduced and therefore upgrading should be as simple as downloading the latest copy of F2.js and updating your website.
Developers can quick-link to the latest copy of F2.js:
-
-//cdnjs.cloudflare.com/ajax/libs/F2/1.4.4/f2.min.jsA download (zip) of the current version (1.4.4) of F2 is always available along with tags of previous releases.
+
+//cdnjs.cloudflare.com/ajax/libs/F2/1.4.5/f2.min.jsA download (zip) of the current version (1.4.5) of F2 is always available along with tags of previous releases.
Deprecated Features#
There is a page on the wiki tracking deprecated features in F2. Starting with version 1.2, three
ContainerConfigproperties have been retired. As F2 features and/or F2.js APIs are deprecated, we will attempt to give reasonable advance notice via any or all of the F2 communication channels. In addition, we will strive to ensure that backward compatibility will be maintained for at least one major version of F2. For example, ifFeature Xis deprecated in version1.3, we will attempt to maintain backward compatibility until the next major release (version2.0). F2 documentation will be updated accordingly to reflect any changes, and the conversation behind deprecated features will be publicly available on GitHub.Third Party Libraries#
F2 uses third party libraries inside F2.js (see Framework: Choices). These open-source libraries are all on their own release schedules. We cannot guarantee that we will always stay abreast and in tune with such latest releases, but in an effort to improve the F2 framework, we will attempt to update F2.js so that it uses the latest, most stable and most secure version of the third party software. These updates to F2 will be made through the normal release process on GitHub and comments will be open.
-Issues, Enhancements, Bugs#
Have a question? Ask it on the F2 Google Group (or send an email to OpenF2@googlegroups.com) or start a discussion using Issues on GitHub.
+Issues, Enhancements, Bugs#
Have a question? Ask it on the F2 Google Group (or send an email to OpenF2@googlegroups.com) or start a discussion using Issues on GitHub.
To track bugs, enhancements or other issues, F2 is using Issues on GitHub.
License#
F2 is licensed under the Apache License version 2.0. Details are available in the project readme.
@@ -223,7 +223,7 @@F2
Best Practices
Forum#
Have a question? Ask it on the F2 Google Group.
- +
@@ -199,7 +199,7 @@F2
Setting Up a Loading GIF
Included in the
F2.UI.Maskconfiguration object are the following properties:backgroundColor,loadingIcon,opacity,useClasses, andzIndex. Each of theseF2.UI.Maskproperties is detailed in the F2.js SDK docs.For more information on
-F2.UI, browse to the F2.js SDK docs.Override the AppManifest Request#
Occasionally Container Developers need more granular control over the
+AppManifestrequest mechanism in F2.js. The manifest request process—intentionally obscured from developers through theF2.registerApps()API—is handled by a simple ajax call to an HTTP endpoint. (F2 relies onjQuery.ajax()for this.) In version 1.4.4 of F2, theAppManifestrequest can be overridden in the Container Config.Override the AppManifest Request#
Occasionally Container Developers need more granular control over the
AppManifestrequest mechanism in F2.js. The manifest request process—intentionally obscured from developers through theF2.registerApps()API—is handled by a simple ajax call to an HTTP endpoint. (F2 relies onjQuery.ajax()for this.) In version 1.4.5 of F2, theAppManifestrequest can be overridden in the Container Config.Note The
AppManifestendpoint is configured in themanifestUrlproperty within eachAppConfig.The following example demonstrates how the
xhrproperty of theContainerConfigis used to override F2.js.F2.init({ @@ -340,7 +340,7 @@Type#
For more information on
-F2.ContainerConfig.xhr, browse to the F2.js SDK docs.Override the Request for App Dependencies#
Occasionally Container Developers need more granular control over the request mechanism in F2.js for
+AppManifest-defined dependencies. The current dependency request process is handled by the straightforwardcreateElement('script')andcreateStyleSheet()statements for scripts and styles, respectively. In version 1.4.4 of F2, the app dependency request can be overridden in theContainerConfig.Override the Request for App Dependencies#
Occasionally Container Developers need more granular control over the request mechanism in F2.js for
AppManifest-defined dependencies. The current dependency request process is handled by the straightforwardcreateElement('script')andcreateStyleSheet()statements for scripts and styles, respectively. In version 1.4.5 of F2, the app dependency request can be overridden in theContainerConfig.Override the Script Loader#
As defined in the
AppManifest, each F2 App can have script file dependencies. These are defined as URLs in theAppManifest.scriptsproperty (type array). The script loader can be replaced with any script loading mechanism such as those found in RequireJS, jQuery or HeadJS.To override the script loader, assign a function to
loadScriptsinF2.initas shown below. The function is passedscripts(array) andcallback(function) which needs to be called when all scripts have been loaded.F2.init({ @@ -992,7 +992,7 @@F2
F2
Why#
Spec Management#
F2 will continuously evolve to bring the community the best features, services and apps. F2’s promise is to do this by building on the existing spec, not by changing it. The specification aims high to solve many problems and suit many needs. As the standard evolves and new requirements come to light, the functionality in F2 will expand accordingly.
To achieve steady growth and stable release cycles, F2 will be maintained under the Semantic Versioning guidelines as much as possible. For more information, browse to the readme on GitHub.
.
-Track#
F2 v1.0 was released on October 15, 2012. The latest version of the F2 specification is 1.4.4 released on 31 January 2018. To provide transparency into the future of F2, a roadmap wiki will be available on GitHub. A changelog that tracks version-to-version changes, upgrades and deprecated features will offer a historical look at F2’s evolution.
-Note There is a separate changelog for the F2.js SDK which is currently version 1.4.4.
+Track#
F2 v1.0 was released on October 15, 2012. The latest version of the F2 specification is 1.4.5 released on 2 March 2018. To provide transparency into the future of F2, a roadmap wiki will be available on GitHub. A changelog that tracks version-to-version changes, upgrades and deprecated features will offer a historical look at F2’s evolution.
+Note There is a separate changelog for the F2.js SDK which is currently version 1.4.5.
Collaborate#
The F2 specification and the F2.js JavaScript library are open-source projects managed on GitHub. F2 chose this route to allow developers to contribute to the success of both the open standard and SDKs. GitHub’s tools make collaboration easy, and you can get started contributing today.
All contributors will be expected to follow consistent standards and guidelines when contributing to F2. Direct inquiries to info@openf2.org or post a question on the F2 mailing list.
Notational Conventions#
The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119. For readability, these words do not appear in all uppercase letters in this specification.
@@ -288,7 +288,7 @@ F2
.