J3.x

Difference between revisions of "Adding JavaScript and CSS to the page"

From Joomla! Documentation
(Remove Stub)
(25 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
{{stub}}
+
{{version|1.5,2.5,3.0}}
  
−
To have a well-formed XHTML document, you must put all references to Javascript and CSS files within the <head> portion. Since Joomla! generates all of the HTML that makes up a page before output, it is possible to add these references to the <head> tag from your extension. To accomplish this, you first need to get a reference to the current document object:
+
== Inserting from a File ==
 +
To have a well-formed XHTML document, you must put all references to Javascript and CSS files within the <code><head></code> portion. Since Joomla! generates all the HTML that makes up a page before output, it is possible to add these references within the <head> tags from your extension. The simplest way to do this is to make use of the functionality built in to Joomla!:
 +
<source lang="php">
 +
// Add a reference to a Javascript file
 +
// The default path is 'media/system/js/'
 +
JHTML::script($filename, $path, $mootools);
  
−
<pre>
+
// Add a reference to a CSS file
 +
// The default path is 'media/system/css/'
 +
JHTML::stylesheet($filename, $path);
 +
</source>
 +
Using these functions, Joomla! will take care of any additional requirements. For example, if your Javascript requires Mootools, setting <code>$mootools = true</code> will automatically ensure that Mootools is loaded, if it has not already been done.
 +
 
 +
However, the above functions will not be flexible enough for every scenario, and so it is possible to tap into the underlying functionality instead. Of course, you will also need to manually code some of the steps that would be done automatically using the functions above.
 +
 
 +
First, get a reference to the current document object:
 +
<source lang="php">
 
$document =& JFactory::getDocument();
 
$document =& JFactory::getDocument();
−
</pre>
+
</source>
 +
For a stylesheet, use this code:
 +
<source lang="php">
 +
$document->addStyleSheet($url);
 +
</source>
  
 
To add a Javascript file, use this code:
 
To add a Javascript file, use this code:
−
<pre>
+
<source lang="php">
 
$document->addScript($url);
 
$document->addScript($url);
−
</pre>
+
</source>
 +
Note this will **NOT** include Mootools or jQuery. If your script requires Mootools or jQuery see [[Javascript_Frameworks]] for full details on how to include them (note jQuery can only be included natively on Joomla 3.0+).
 +
 
 +
== Inserting from within a PHP file ==
 +
 
 +
However, your Javascript or CSS might not be located in a separate file&mdash;you might want to generate them using PHP. In this case you can write the script or stylesheet directly into the head of your document:
 +
<source lang="php">
 +
$document =& JFactory::getDocument();
 +
// Add Javascript
 +
$document->addScriptDeclaration($javascript, $type);
 +
 
 +
// Add styles
 +
$document->addStyleDeclaration($styles, $type);
 +
</source>
 +
 
 +
== Javascript Examples ==
 +
 
 +
For example, the following code is used to define a custom tool tip that takes advantage of mootools.
 +
<source lang="php">
 +
function getToolTipJS($toolTipVarName, $toolTipClassName){
 +
    $javascript = 'window.addEvent(\"domready\", function(){' ."\n";
 +
    $javascript .= "\t"  .'var $toolTipVarName = new Tips($$("' . $toolTipVarName .'"), {' ."\n";
 +
    $javascript .= "\t\t"  .'className: "' .$toolTipClassName .'",' ."\n";
 +
    $javascript .= "\t\t"  .'initialize: function(){' ."\n";
 +
    $javascript .= "\t\t\t"    .'this.fx = new Fx.Style(this.toolTip, "opacity", {duration: 500, wait: false}).set(0);' ."\n";
 +
    $javascript .= "\t\t"  .'},' ."\n";
 +
    $javascript .= "\t\t"  .'onShow: function(toolTip){' ."\n";
 +
    $javascript .= "\t\t\t"    .'this.fx.start(1);' ."\n";
 +
    $javascript .= "\t\t"  .'},' ."\n";
 +
    $javascript .= "\t\t"  .'onHide: function(toolTip) {' ."\n";
 +
    $javascript .= "\t\t\t"    .'this.fx.start(0);' ."\n";
 +
    $javascript .= "\t\t"  .'}' ."\n";
 +
    $javascript .= "\t"  .'});' ."\n";
 +
    $javascript .= '});' ."\n\n";
 +
    return $javascript;
 +
}
 +
 
 +
$document =& JFactory::getDocument();
 +
$document->addStyleSheet("/joomla/components/com_mycustomcomponent/css/mytooltip.css",'text/css',"screen");
 +
$document->addScriptDeclaration(getToolTipJS("mytool","MyToolTip"));
 +
</source>
 +
Note that in order for this Javascript to be functionally useful, it would be necessary to include the appropriate class name in the HTML, as well as providing the <code>mytooltip.css</code> file. Both are outside the scope of this article.
 +
 
 +
== CSS Examples ==
 +
 
 +
This is also useful if your inserting a parameter/form field of CSS into your code. For example in a module, you might want a user to choose to call the colour of the border. After calling the parameter/form field and assigning it a variable $bordercolor in mod_example.php. Then in tmpl/default.php you can include the following
 +
<source lang="php">
 +
$document =& JFactory::getDocument();
 +
$document->addStyleSheet(JURI::base() . 'modules/mod_example/css/mod_example.css');
 +
$style = '#example {
 +
border-color:#' . $bordercolor . ';
 +
}';
 +
$document->addStyleDeclaration( $style );
 +
</source>
 +
Here mod_example.css contains the CSS file of any non-parameter based styles. Then the bordercolor parameter/form field is added in separately
 +
 
 +
==Add Custom Tag==
  
−
For a stylesheet, use this code:
+
There will be some occasions where even these functions are not flexible enough, as they are limited to writing the contents of <code><script /></code> or <code><style /></code> tags, and cannot add anything outside those tags. One example would be the inclusion of a stylesheet link within conditional comments, so that it is picked up only by Internet Explorer 6 and earlier. To do this, use <code>$document->addCustomTag</code>:
−
<pre>
+
<source lang="php">
−
$document->addStyleSheet($url);
+
$stylelink = '<!--[if lte IE 6]>' ."\n";
−
</pre>
+
$stylelink .= '<link rel="stylesheet" href="../css/IEonly.css" />' ."\n";
 +
$stylelink .= '<![endif]-->' ."\n";
 +
 
 +
$document =& JFactory::getDocument();
 +
$document->addCustomTag($stylelink);
 +
</source>
  
−
If you want to add custom HTML to the head tag, use this code:
+
[[Category:Development]]
−
<pre>
+
[[Category:Tutorials]][[Category:Component Development]][[Category:Module Development]]
−
$document->addCustomTag($html);
 
−
</pre>
 

Revision as of 06:50, 1 February 2013

This article is for Joomla! CMS Version(s) Joomla 1.5 Joomla 2.5 Joomla 3.0


Inserting from a File[edit]

To have a well-formed XHTML document, you must put all references to Javascript and CSS files within the <head> portion. Since Joomla! generates all the HTML that makes up a page before output, it is possible to add these references within the <head> tags from your extension. The simplest way to do this is to make use of the functionality built in to Joomla!: 

// Add a reference to a Javascript file
// The default path is 'media/system/js/'
JHTML::script($filename, $path, $mootools);

// Add a reference to a CSS file
// The default path is 'media/system/css/'
JHTML::stylesheet($filename, $path);

Using these functions, Joomla! will take care of any additional requirements. For example, if your Javascript requires Mootools, setting $mootools = true will automatically ensure that Mootools is loaded, if it has not already been done.

However, the above functions will not be flexible enough for every scenario, and so it is possible to tap into the underlying functionality instead. Of course, you will also need to manually code some of the steps that would be done automatically using the functions above.

First, get a reference to the current document object: 

$document =& JFactory::getDocument();

For a stylesheet, use this code: 

$document->addStyleSheet($url);

To add a Javascript file, use this code: 

$document->addScript($url);

Note this will **NOT** include Mootools or jQuery. If your script requires Mootools or jQuery see Javascript_Frameworks for full details on how to include them (note jQuery can only be included natively on Joomla 3.0+).

Inserting from within a PHP file[edit]

However, your Javascript or CSS might not be located in a separate file—you might want to generate them using PHP. In this case you can write the script or stylesheet directly into the head of your document: 

$document =& JFactory::getDocument();
// Add Javascript
$document->addScriptDeclaration($javascript, $type);

// Add styles
$document->addStyleDeclaration($styles, $type);

Javascript Examples[edit]

For example, the following code is used to define a custom tool tip that takes advantage of mootools. 

function getToolTipJS($toolTipVarName, $toolTipClassName){
    $javascript = 'window.addEvent(\"domready\", function(){' ."\n";
    $javascript .= "\t"  .'var $toolTipVarName = new Tips($$("' . $toolTipVarName .'"), {' ."\n";
    $javascript .= "\t\t"   .'className: "' .$toolTipClassName .'",' ."\n";
    $javascript .= "\t\t"   .'initialize: function(){' ."\n";
    $javascript .= "\t\t\t"    .'this.fx = new Fx.Style(this.toolTip, "opacity", {duration: 500, wait: false}).set(0);' ."\n";
    $javascript .= "\t\t"   .'},' ."\n";
    $javascript .= "\t\t"   .'onShow: function(toolTip){' ."\n";
    $javascript .= "\t\t\t"    .'this.fx.start(1);' ."\n";
    $javascript .= "\t\t"   .'},' ."\n";
    $javascript .= "\t\t"   .'onHide: function(toolTip) {' ."\n";
    $javascript .= "\t\t\t"    .'this.fx.start(0);' ."\n";
    $javascript .= "\t\t"   .'}' ."\n";
    $javascript .= "\t"  .'});' ."\n";
    $javascript .= '});' ."\n\n";
    return $javascript;
}

$document =& JFactory::getDocument();
$document->addStyleSheet("/joomla/components/com_mycustomcomponent/css/mytooltip.css",'text/css',"screen");
$document->addScriptDeclaration(getToolTipJS("mytool","MyToolTip"));

Note that in order for this Javascript to be functionally useful, it would be necessary to include the appropriate class name in the HTML, as well as providing the mytooltip.css file. Both are outside the scope of this article.

CSS Examples[edit]

This is also useful if your inserting a parameter/form field of CSS into your code. For example in a module, you might want a user to choose to call the colour of the border. After calling the parameter/form field and assigning it a variable $bordercolor in mod_example.php. Then in tmpl/default.php you can include the following 

$document =& JFactory::getDocument();
$document->addStyleSheet(JURI::base() . 'modules/mod_example/css/mod_example.css');
$style = '#example {
	border-color:#' . $bordercolor . ';
	}';
$document->addStyleDeclaration( $style );

Here mod_example.css contains the CSS file of any non-parameter based styles. Then the bordercolor parameter/form field is added in separately

Add Custom Tag[edit]

There will be some occasions where even these functions are not flexible enough, as they are limited to writing the contents of <script /> or <style /> tags, and cannot add anything outside those tags. One example would be the inclusion of a stylesheet link within conditional comments, so that it is picked up only by Internet Explorer 6 and earlier. To do this, use $document->addCustomTag: 

$stylelink = '<!--[if lte IE 6]>' ."\n";
$stylelink .= '<link rel="stylesheet" href="../css/IEonly.css" />' ."\n";
$stylelink .= '<![endif]-->' ."\n";

$document =& JFactory::getDocument();
$document->addCustomTag($stylelink);
Retrieved from "https://docs.joomla.org/index.php?title=J3.x:Adding_JavaScript_and_CSS_to_the_page&oldid=80228"