diff options
Diffstat (limited to 'src/fauxton/extensions.md')
| -rw-r--r-- | src/fauxton/extensions.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/fauxton/extensions.md b/src/fauxton/extensions.md new file mode 100644 index 000000000..13fcf8d6e --- /dev/null +++ b/src/fauxton/extensions.md @@ -0,0 +1,17 @@ +#Extensions + +Extensions allow Fauxton views to be have extra functionality. + +A module registers an extension by + + FauxtonAPI.registerExtension('extensionName', myObjectToRegister); + +Any other module wanting to use that extension can then get +all objects registered for an extension by: + + var extensions = FauxtonAPI.getExtensions('extensionName'); + // extensions will always be an array + +The module can then use those extensions to extend its functionality. +An example of extensions in the compaction module (app/addons/compaction/base.js) +and in documents module (app/modules/documents/views line 1003) |