Difference between revisions of "AppSuite:Extending the UI (best practices)"

(Created page with "{{Stability-experimental}} <div class="title">Extension points:<br> Best practices</div> '''Abstract''' ''The flexibility of the extension points system usually allows more...")
 
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Stability-experimental}}
+
The content on this page has moved to https://documentation.open-xchange.com/latest/ui/extension-points/13-best-practices.html
  
−
<div class="title">Extension points:<br> Best practices</div>
+
Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.
−
 
 
−
'''Abstract'''
 
−
 
 
−
''The flexibility of the extension points system usually allows more than one strategy to realize the desired logic. This is a list of solutions for common scenarios showing advantages or disadvantages ''
 
−
 
 
−
 
 
−
__TOC__
 
−
==Scenarios==
 
−
 
 
−
=== hide/show action ===
 
−
 
 
−
''simply register a fresh new extension with an index less than the original action extension.''
 
−
 
 
−
<code>
 
−
    // original extension
 
−
    new Action('io.ox/mail/actions/compose', {
 
−
        id: 'compose',
 
−
        index: 100,
 
−
        requires: function () {
 
−
            return true;
 
−
        },
 
−
        ...
 
−
    });
 
−
 
 
−
    // your extension to hide it
 
−
    ext.point('io.ox/mail/actions/compose').extend({
 
−
        // must be a different id than used in original extension
 
−
        id: 'compose_preprocess',
 
−
        // important: must be smaller than the one used in original extension
 
−
        index: 50,
 
−
        requires: function (e) {
 
−
            // is your condition meet?
 
−
            if (myCondition = true) {
 
−
                // stop propagation to suppress execution of
 
−
                // requires-handlers of extensions with a higher index
 
−
                e.stopPropagation();
 
−
                // force hide (or force show with 'return true')
 
−
                return false;
 
−
            }
 
−
        }
 
−
    });
 
−
</code>
 
−
 
 
−
 
 
−
'''common pitfalls'''
 
−
 
 
−
''use ext.point(...).replace''
 
−
 
 
−
* original requires function is replaced and can not be accessed anymore
 
−
* also copy and paste it contents does not help cause future changes are not carried over automatically
 
−
* see [[AppSuite:Extending_the_UI#replace_extension | documentation for .replace ]]
 
−
<code>
 
−
    ext.point('io.ox/mail/actions/compose').replace({
 
−
        id: 'compose',
 
−
        requires: function () {
 
−
            // my custom logic
 
−
        }
 
−
})
 
−
 
 
−
</code>
 
−
 
 
−
 
 
−
 
−
 
 
−
 
 
−
[[Category:AppSuite]]
 
−
[[Category:UI]]
 
−
[[Category:Extension points]]
 

Latest revision as of 09:48, 22 May 2017

The content on this page has moved to https://documentation.open-xchange.com/latest/ui/extension-points/13-best-practices.html

Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.

Retrieved from "https://oxpedia.org/wiki/index.php?title=AppSuite:Extending_the_UI_(best_practices)&oldid=23352"