[ALOY-545] Setting widget view-controller from within XML views

GitHub Issuen/a
Resolution Date2013-03-18T20:50:20.000+0000
Affected Version/sn/a
Fix Version/sAlloy 1.1.0, 2013 Sprint 06
Labelsalloy, compiler, controller, views, xml
ReporterFokke Zandbergen


If you require a widget in a XML view like this:
<widget src="nl.fokkezb.tweetsView" foo="bar" id="myWidget"></widget>
It generates code like this:
$.__views.myWidget = Alloy.createWidget("nl.fokkezb.tweetsView", "widget", {
     id: "myWidget",
     foo: "bar"
Let’s take a look at the code for createWidget in alloy.js:
exports.createWidget = function(id, name, args) {
    return new (require("alloy/widgets/" + id + "/controllers/" + (name || "widget")))(args);
As you can see, the second argument specifies the controller to require from the widget. You might not have known this, but the docs do mention that widget can contain multiple view-controllers, just like your app does. Unfortunately, to use this feature you need to create the widget in your controller using code similar to the second fragment above. It’s currently not possible to do this in the view. This is a missed opportunity to use a singe widget to expose a collection of reusable UI elements:
     <widget src="nl.fokkezb.ui" name="myFancyButton"></widget>
     <widget src="nl.fokkezb.ui" name="myCustomView"></widget>
     <widget src="nl.fokkezb.ui" name="myHorizontalTable"></widget>
Or create a widget that can be used in multiple contexts:
     <widget src="nl.fokkezb.tweetsView" name="tab"></widget>
          <widget src="nl.fokkezb.tweetsView" name="window"></widget>
So my feature request / improvement would be to support the name attribute for elements, whose value would be used as the second argument for createWidget. I’ve made the necessary changes to Alloy.Require.js and did a pull request for this: https://github.com/appcelerator/alloy/pull/111


  1. Tony Lukasavage 2013-03-18 Also updated widgets/basic test app to use this functionality: https://github.com/appcelerator/alloy/tree/master/test/apps/widgets/basic
  2. Shyam Bhadauria 2013-05-14 Tested the app - https://github.com/appcelerator/alloy/tree/master/test/apps/widgets/basic It is working fine with alloy version 1.1.2.Can close the bug.

JSON Source