Customizing the print pop-up

From Joomla! Documentation

The /templates/$template/component.php file controls the print view of a given article. The component.php file acts just like index.php, in that it controls your template layout, module positions and CSS, among other things.

The component.php file can be customized with features such as module positions and custom CSS files. This is done using the same methods as with index.php.

At the heart of component.php is:

 <head>
 <jdoc:include type="head" />
   <link rel="stylesheet" href="/<?php echo $this->baseurl ?>/templates/system/css/general.css" />
   <link rel="stylesheet" href="/<?php echo $this->baseurl ?>/templates/<?php echo $this->template; ?>/css/template.css" />
   <?php if($this->direction == 'rtl') : ?>
    <link rel="stylesheet" href="/<?php echo $this->baseurl ?>/templates/<?php echo $this->template ?>/css/template_rtl.css" />
  <?php endif; ?>
  </head>
  <body class="contentpane">
   <jdoc:include type="message" />
   <jdoc:include type="component" />
  </body>
 </html>

Pop-up Only Styles[edit]

To add a specific style sheet for your print pop-up, simply change the style sheet in the head section to one that suits your needs. Use the media attribute to limit this new style sheet to print or screen. For example, our head may now look like:

 <head>
 <jdoc:include type="head" />
 <link rel="stylesheet" href="/<?php echo $this->baseurl ?>/templates/<?php echo $this->template; ?>/css/screen.css" media="screen print" />
 </head>

Depending on whether or not you have separated your style sheets by form and function, you could even use @import to grab your typography, module overrides, browser normalization rules and other styles. In some cases you may need to add a few extra lines of CSS to our new screen.css file to override some of your other rules. For example, screen.css could look like:

 @import url('normalization.css');
 @import url('typography.css');
 @import url('modules.css');
 @import url('style.css');
 html, body{background: #FFF}
 input {border:1px solid #666;}
 img{border:none}
 .componentheading {background:none;color:#000;font-weight:bold;padding-top:20px;width:100%;text-align:center}

Pop-up Only Modules[edit]

The component.php file allows for the same code to be used for creating module positions. This can be especially useful if you want a specific header image or content displayed on only certain articles when they are printed. To add a module position, use the same code that you would with index.php.

 <jdoc:include type="modules" name="popup" />

Since we want to display only certain print pop-ups, use the countModules method. For example:

 <?php if ($this->countModules('popup')) : ?>
  <jdoc:include type="modules" name="popup" style="raw" />
 <?php endif; ?>

Now, you can create a new module to contain whatever content or images that you'd like, assign it to your newly created position (popup in this example) and control when it appears by use of menu assignments.

The final contents of your component.php could look like:

 <head>
 <jdoc:include type="head" />
 <link rel="stylesheet" href="/<?php echo $this->baseurl ?>/templates/<?php echo $this->template; ?>/css/screen.css" media="screen print" />
 </head>
 <body class="contentpane">
        <?php if ($this->countModules('popup')) : ?>
        <jdoc:include type="modules" name="popup" style="raw" />
      <?php endif; ?>
    <jdoc:include type="message" />
    <jdoc:include type="component" />
 </body>
 </html>

References[edit]