Shortcut Widget with dynamic items

Hi all,

I'd like to create a shortcut widget which allows to dynamically assign items to it.

Thanks to the documentation and some source code exploration I'm pretty close, but I am still missing the possibility to trigger a browse within the same screen (as the standard widget does).

I think I need to look in the direction of the Context I am using, since the shortcuts will open in a new window if I use the PortalContext, but I'd like to be able to use a standard browse.

I saw the example in the documentation alerting the document ID on change event but since the shortcut view includes a defaultaction command with the onclick event I am not sure if I need to implement it that way?

Anyway, here's my code, this lists the shortcuts just fine, the document opens in a new popup but the folder/enterprise objects don't do anything.

csui.require([
'csui/lib/underscore', // Cross-browser utility belt
'csui/lib/marionette', // MVC application support
'csui/lib/jquery',
'csui/utils/contexts/page/page.context',
'csui/widgets/shortcuts/shortcuts.view'
], function (_,Marionette, $,PageContext,ShortcutsView) {
var shortcutRegion = new Marionette.Region({el: '#shortcutRegion'}),
pageContext = new PageContext(),
shortcutsView,
options={
context:pageContext,
data: {
shortcutItems:[
{type:141},
{id:130196},
{id:94507}
],
shortcutTheme:'csui-shortcut-theme-teal1'
}
}
shortcutsView = new ShortcutsView(options);
shortcutRegion.show(shortcutsView);
pageContext.fetch();
});

Thanks in advance for the help

Jasper

Find more posts tagged with

Comments

Jasper De Bruyckere

Bump.

Ferdinand Prantl

The "bump" was a good idea :-)

The Shortcuts widget executes the default action on click. It can be downloading document content, navigating to a URL, or most usually opening the default node perspective, if the perspective context is used. Because the navigation is driven by models in the context, its behaviour depends on the context type. As you found out, PortalContext always opens objects in a new window. It is supposed to serve a "guidepost" page.

I'm afraid, that there's no option to make PortalContext open the object URL in the same window. You can file a feature request for this. It will be fairly easy.

As a workaround, you can either take PageContext (which does nothing) and handle the transition from nextNode to node yourself. Or you can override opening nodes in PortalContext, which is easier. For example, the following custom context will open targeted nodes in the same window:

csui.define('my/portal.here.context', [  'csui/utils/contexts/portal/portal.context',  'csui/utils/node.links/node.links'], function (PortalContext, nodeLinks) {  'use strict';  var PortalHereContext = PortalContext.extend({    openNodePage: function (node) {      this.triggerMethod('before:open:page', this, this.nextNode);      location.href = nodeLinks.getUrl(node);    }  });  return PortalHereContext;});csui.require([       'csui/lib/marionette', 'my/portal.here.context',  'csui/widgets/shortcuts/shortcuts.view'], function (Marionette, PortalHereContext, ShortcutsView) {  'use strict';  var shortcutRegion = new Marionette.Region({el: '#shortcutRegion'}),      portalContext = new PortalHereContext(),      options = {        context: portalContext,        data: {          shortcutItems:[            {type: 141},            {id: 130196},            {id: 94507}          ],          shortcutTheme: 'csui-shortcut-theme-teal1'        }      },      shortcutsView = new ShortcutsView(options);  shortcutRegion.show(shortcutsView);  portalContext.fetch();});

Navigating away from your page to /app/nodes/:id will be the behavior on your custom page using PortalContext. You'll notice, that loading the full /app takes some time and going back and forward between your page and /app may slow you down at your work. If you place your widget to a perspective and show it using CS pages /app or /xecm, the node, which you click on, will open on the same page without reloading it fully.

Jasper De Bruyckere

Thanks a lot Ferdinand! We will manage it this way.

Bart_Maes

Hi Ferdinand

The PortalContext.openNodePage() approach works fine for shortcuts referring to an actual node (f.e. the Enterprise root 2000), but it does not work for shortcuts to a WebReport or Form type. Do you know any alternative for these kind of shortcuts?

Kind regards,

Bart Maes