Actions

Difference between revisions of "Module chrome"

From Joomla! Documentation

(What is Module chrome?)
m (Reverted edits by Isidrobaq (talk) to last revision by Tom Hutchison)
 
(29 intermediate revisions by 9 users not shown)
Line 1: Line 1:
===== What is Module chrome? =====
+
<noinclude><languages /></noinclude>
 +
<translate>
 +
<!--T:1-->
 +
{{Chunk:Module chrome/en}}
  
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.
+
<!--T:3-->
 +
'''See also:''' [[Standard Module Chromes]]
  
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:
+
<!--T:2-->
<source lang="php">
+
<noinclude>
<jdoc:include type="modules" name="user1" style="custom" />
+
[[Category:Advanced|Chrome]]
</source>
+
[[Category:Module Development]]
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').
+
[[Category:Template Development]]
 
+
[[Category:CSS]]
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!
+
[[Category:Glossary]]
 
+
</noinclude>
{| style="width:100%" class="wikitable"
+
</translate>
|+Comparison of the Joomla! 1.5 standard Module chromes
+
!Style
+
!Output
+
!width="204" | Appearance
+
|-
+
!rounded<br />(default for menus on milkyway)
+
|
+
<source lang="html4strict">
+
<div class="module_menu">
+
  <div>
+
    <div>
+
      <div>
+
        <h3>Main Menu</h3>
+
        <ul class="menu">
+
          <li><!-- various menu items --></li>
+
        </ul>
+
      </div>
+
    </div>
+
  </div>
+
</div>
+
</source>
+
|
+
[[Image:Module_chrome_rounded.png]]
+
|-
+
!none
+
|
+
<source lang="html4strict">
+
<ul class="menu">
+
  <li><!-- various menu items --></li>
+
</ul>
+
</source>
+
|
+
[[Image:Module_chrome_none.png]]
+
|-
+
!table
+
|
+
<source lang="html4strict">
+
<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>
+
</source>
+
|
+
[[Image:Module_chrome_table.png]]
+
|-
+
!horz
+
|
+
<source lang="html4strict">
+
<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>
+
</source>
+
|
+
[[Image:Module_chrome_horz.png]]
+
|-
+
!xhtml
+
|
+
<source lang="html4strict">
+
<div class="moduletable_menu">
+
  <h3>Main Menu</h3>
+
  <ul class="menu">
+
    <li><!-- various menu items --></li>
+
  </ul>
+
</div>
+
</source>
+
|
+
[[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:Modules]]</noinclude>
+
<noinclude>[[Category:Templates]]</noinclude>
+
<noinclude>[[Category:Topics]]</noinclude>
+

Latest revision as of 12:22, 5 March 2014

Other languages: català 100% • ‎English 100% • ‎español 100% • ‎français 100% • ‎Bahasa Indonesia 100% • ‎日本語 100% • ‎Nederlands 100% • ‎Kiswahili 100%

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 which 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 may be used in 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!


See also: Standard Module Chromes