[ALOY-1256] Widget/Require as top-level element uses controller as view

GitHub Issuen/a
Resolution Date2020-08-12T13:10:59.000+0000
Affected Version/sAlloy 1.5.1, Alloy 1.7.0
Fix Version/sCLI Release 8.1.0
Labelsgriffin-app, merge-to-next, require, view, widgets, xml
ReporterFokke Zandbergen
AssigneeBrenton House


When a controller-view has a widget or require as a root element, the compiled code will use the required controller as the view, as seen in the following example: *index.xml*
  <Widget src="foo" />
    <Label>I'm the default widget</Label>
*index.js (compiled)*
    $.__views.index = Alloy.createWidget("foo", "widget", {
        id: "index"
    $.__views.index && $.addTopLevelView($.__views.index);
[ERROR] TypeError: undefined is not a function (evaluating '$.index.open()')
[ERROR] File: app.js
[ERROR] Line: 33
[ERROR] SourceId: <null>
[ERROR] Backtrace:
[ERROR]  undefined
*index.js (expected)*
    $.__views.index = Alloy.createWidget("foo", "widget", {
        id: "index"
    $.__views.index && $.addTopLevelView($.__views.index.getView());
    // OR: $.__views.index && $.addTopLevelView($.__views.index.getViewEx({recurse:true}));
Found via this GitHub ticket, which includes a link to a full example: https://github.com/FokkeZB/nl.fokkezb.pullToRefresh/issues/39


  1. Fokke Zandbergen 2015-03-04 It might seem like it doesn't make sense to have a widget/require as top-level element, but as https://github.com/miko91/test-widget/blob/master/app/views/news.xml shows with the recent support for children tags it can be very useful.
  2. Nuno Costa 2015-05-08 There is a temporary fix for this situation? I have the same issue.
       <View class="container">
       <Widget id="ptr" src="nl.fokkezb.pullToRefresh" onRelease="myRefresher">
       <ListView id="listView" backgroundColor="white" defaultItemTemplate="template" module="CollectionView" method="createCollectionView">
       still fails with the view.`
    P.S Just on Android
  3. Nuno Costa 2015-05-10 You can ignore my report above, please see what happened. [https://github.com/FokkeZB/nl.fokkezb.pullToRefresh/issues/39]
  4. Brenton House 2019-12-18 Transferring work from ALOY-1713 as it was a duplicate
  5. Brenton House 2019-12-18 Created PR: https://github.com/appcelerator/alloy/pull/949
  6. Ewan Harris 2020-02-10 Test project https://github.com/brentonhouse/alloy-widget-test
  7. Ewan Harris 2020-07-20 Test steps: Check out the test project at https://github.com/brentonhouse/alloy-widget-test
  8. Samir Mohammed 2020-08-12 Closing ticket, fix verified in CLI version 8.1.0-master.10, tested using the test case above.
  9. Muhammad Qasim 2021-05-18 What if someone need to refer the widget controller itself to call certain controller methods? Previously with this code
       <Widget id="drawer" src="my.widget" />
    $.drawer would refer to the Widget controller object but now it only refer to the top level view from the widget. No way to access controller object from xml except creating the widget in js code.

JSON Source