Actions

Difference between revisions of "Module chrome"

From Joomla! Documentation

(What is Module chrome?)
(What is Module chrome?)
Line 12: Line 12:
  
 
{| style="width:100%" class="wikitable"
 
{| style="width:100%" class="wikitable"
! Style
+
|+Comparison of the Joomla! 1.5 standard Module chromes
! Output
+
!Style
! width="204" | Appearance
+
!Output
 +
!width="204" | Appearance
 
|-
 
|-
|
+
!rounded<br />(default for menus on milkyway)
'''rounded''' (default for menus on milkyway)
+
 
|
 
|
 
<source lang="html4strict">
 
<source lang="html4strict">
Line 36: Line 36:
 
[[Image:Module_chrome_rounded.png]]
 
[[Image:Module_chrome_rounded.png]]
 
|-
 
|-
|
+
!none
'''none'''
+
 
|
 
|
 
<source lang="html4strict">
 
<source lang="html4strict">
Line 47: Line 46:
 
[[Image:Module_chrome_none.png]]
 
[[Image:Module_chrome_none.png]]
 
|-
 
|-
|
+
!table
'''table'''
+
 
|
 
|
 
<source lang="html4strict">
 
<source lang="html4strict">
Line 67: Line 65:
 
[[Image:Module_chrome_table.png]]
 
[[Image:Module_chrome_table.png]]
 
|-
 
|-
|
+
!horz
'''horz'''
+
 
|
 
|
 
<source lang="html4strict">
 
<source lang="html4strict">
Line 93: Line 90:
 
[[Image:Module_chrome_horz.png]]
 
[[Image:Module_chrome_horz.png]]
 
|-
 
|-
|
+
!xhtml
'''xhtml'''
+
 
|
 
|
 
<source lang="html4strict">
 
<source lang="html4strict">
Line 106: Line 102:
 
|
 
|
 
[[Image:Module_chrome_xhtml.png]]
 
[[Image:Module_chrome_xhtml.png]]
 +
|-
 +
!outline
 +
|
 +
<source lang="html4strict">
 +
<div class="mod-preview">
 +
  <div class="mod-preview-info">left[outline]</div>
 +
  <div class="mod-preview-wrapper">
 +
    <ul class="menu">
 +
      <li><!-- various menu items --></li>
 +
    </ul>
 +
  </div>
 +
</div>
 +
</source>
 +
|
 +
[[Image:Module_chrome_outline.png]]
 
|}
 
|}
 +
''Note that the Module chrome doesn't necessarily change the appearance all that much - this depends on the CSS used in the template. For example, the 'none' and 'horz' chromes look very similar, although the underlying HTML code is very different.''
  
 
<noinclude>[[Category:Advanced]]</noinclude>
 
<noinclude>[[Category:Advanced]]</noinclude>

Revision as of 16:04, 18 January 2008

What is Module chrome?

Module chrome allows template designers to have a certain amount of control over the way the output from a Module is displayed in their template. Essentially, it consists of a small amount of predefined HTML which is inserted before, after, or around the output from each module, and can then be styled using CSS. Module chrome is commonly used to provide borders around modules, especially with rounded corners, but it can be used for much more than that.

Module chrome is determined by using the 'style' attribute in the statement calling the module. For example, the following statement is used the index.php file of a template to insert the Modules in the 'user1' position and apply the 'custom' Module chrome:

<jdoc:include type="modules" name="user1" style="custom" />

It can be seen that the same Module chrome is applied to every Module in that position - in other words, if you want to have two Modules in a column, but want them to have different Module chrome, then they would need to be set up as two different 'positions' (e.g. 'user1' and 'user2').

The standard Joomla! 1.5 package includes six default Module chrome styles. However, the flexibility of the template system means that you are not limited to these styles - it's very easy to create as many new styles as you want!

Comparison of the Joomla! 1.5 standard Module chromes
Style Output Appearance
rounded
(default for menus on milkyway)
<div class="module_menu">
  <div>
    <div>
      <div>
        <h3>Main Menu</h3>
        <ul class="menu">
          <li><!-- various menu items --></li>
        </ul>
      </div>
    </div>
  </div>
</div>

Module chrome rounded.png

none
<ul class="menu">
  <li><!-- various menu items --></li>
</ul>

Module chrome none.png

table
<table cellpadding="0" cellspacing="0" class="moduletable_menu">
  <tr>
    <th valign="top">Main Menu</th>
  </tr>
  <tr>
    <td>
      <ul class="menu">
        <li><!-- various menu items --></li>
      </ul>
    </td>
  </tr>
</table>

Module chrome table.png

horz
<table cellspacing="1" cellpadding="0" border="0" width="100%">
  <tr>
    <td valign="top">
      <table cellpadding="0" cellspacing="0" class="moduletable_menu">
        <tr>
          <th valign="top">Main Menu</th>
        </tr>
        <tr>
          <td>
            <ul class="menu">
              <li><!-- various menu items --></li>
            </ul>
          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>

Module chrome horz.png

xhtml
<div class="moduletable_menu">
  <h3>Main Menu</h3>
  <ul class="menu">
    <li><!-- various menu items --></li>
  </ul>
</div>

Module chrome xhtml.png

outline
<div class="mod-preview">
  <div class="mod-preview-info">left[outline]</div>
  <div class="mod-preview-wrapper">
    <ul class="menu">
      <li><!-- various menu items --></li>
    </ul>
  </div>
</div>

Module chrome outline.png

Note that the Module chrome doesn't necessarily change the appearance all that much - this depends on the CSS used in the template. For example, the 'none' and 'horz' chromes look very similar, although the underlying HTML code is very different.