Jul 14, 2010

Dojo Layout Tips

Dojo has gone through much work to build a nice set of widgets to help with the layout of your web applications.  They currently have many different layout managers.  From the highly usable dijit.layout.BorderContainer, to the functional, (or at least it doesn’t crash) dijit.layout.AccordianContainer.

But with all these layout managers, you can also use a multitude of pane objects.  SplitPane, SliderPane and so on.  But it’s the ContentPane, that really holds the guts of your application together.

Dojo now has 3 different content panes.  The dojo.layout.ContentPane, the dijit.layout.ContentPane, and the (you guessed it)…  the dojox.layout.ContentPane.

All three can be declaratively or programmatically created.

Declarative

<script type="text/javascript">
    dojo.require("dijit.layout.ContentPane");
</script>
<div dojoType="dijit.layout.ContentPane">
    &lt;!—Put your info here à
</div>

Programmatic

<div id="targetID">
    IE Rules
</div>
&lt;script type="text/javascript"&gt;
    dojo.require("dijit.layout.ContentPane");
    dojo.addOnLoad(function() {
        new dijit.layout.ContentPane({
            content: "<p>Honestly, it sucks</p>",
            style: "height:125px"
        },
        "targetID");
    });
&lt;/script&gt;
 
 

Where, once again, Dojo fails to excel is in their documentation.  While working on an application with many nested containers and layouts, I encountered several headaches, which forced me to head to Google to solve.

Back when in the early days of Dojo (0.4 to be honest), Dojo had the dojo.widget.ContentPane, which executed javascript when you the set the executeScripts parameter to true.

This was removed in 0.9, to make the widget more streamlined (Huh???).  Since the dijit ContentPane was next logically choice, they must have added to the ability to run script code there. Well not exactly  To run script code, you need to should actually use dojox.layout.ContentPane.  Even though its in the dojox package it has been well tested and used.

Another helpful tip, when nesting multiple panes and containers together, the dojo.addOnLoad() method is ONLY executed on the first load.  Even if you href another page in, that addOnLoad will not be executed.  This means you can declaratively build your initial page, but subsequent pages that are “sucked in” your existing content panes, need to be built programmatically.

About the Author

Object Partners profile.
Leave a Reply

Your email address will not be published. Required fields are marked *

Related Blog Posts
An Exploration in Rust: Musings From a Java/C++ Developer
Why Rust? It’s fast (runtime performance) It’s small (binary size) It’s safe (no memory leaks) It’s modern (build system, language features, etc) When Is It Worth It? Embedded systems (where it is implied that interpreted […]
Getting Started with CSS Container Queries
For as long as I’ve been working full-time on the front-end, I’ve heard about the promise of container queries and their potential to solve the majority of our responsive web design needs. And, for as […]
Simple improvements to making decisions in teams
Software development teams need to make a lot of decisions. Functional requirements, non-functional requirements, user experience, API contracts, tech stack, architecture, database schemas, cloud providers, deployment strategy, test strategy, security, and the list goes on. […]
JavaScript Bundle Optimization – Polyfills
If you are lucky enough to only support a small subset of browsers (for example, you are targeting a controlled set of users), feel free to move along. However, if your website is open to […]