org.zkoss.web.util.resource.dir

 {{ZKConfigurationReferencePageHeader}}

=IMPORTANT=
Before enabling this feature upgrade to the latest available versions (older versions contain a critical security vulnerability).

The latest versions containing a fix are:
* for CE users 8.0.2.2 or later [https://www.zkoss.org/download/zk downloads]
* for PE/EE users 6.5.8.2, 7.0.8.1, 8.0.2.2, 8.0.3.1  or later [https://www.zkoss.org/download/premium premium downloads]

'''Property:'''
  org.zkoss.web.util.resource.dir

{{GlobalLibraryProperty}}

 Default: <i>none</i>
{{versionSince| 5.0.0}}

It specifies a directory, where ZK will load the so-called Class-Web Resources (CWR), in addition to the class path. CWR includes JavaScript files, CSS files, and other resources that are specified in the form of <code>~./xxx</code>.

By default, ZK only searches the class path for the required CWR. By specifying a directory here, ZK will search the directory first and then the class path. This implies that a developer can override the default behavior by providing a file with the same name.

Notice: never put security sensitive files in the directory specified here, since they can be accessed externally.

For example, assuming that we have a JavaScript package called <code>foo.great</code> and we want to put it to <code>WEB-INF/cwr</code>, we have to specify the following in <code>WEB-INF/zk.xml</code>:

<source lang="xml">
	<library-property>
		<name>org.zkoss.web.util.resource.dir</name>
		<value>/WEB-INF/cwr</value>
	</library-property>
</source>

You can place <code>zk.wpd</code> and the required JavaScript files under the <code>WEB-INF/cwr/js/foo/great</code> directory.

= Overriding JavaScript Files in a JAR=

Though rarely needed, sometimes you might need to override a JavaScript file of a JAR file with this option. One example is that you don't have to re-package <code>zul.jar</code> when replacing <code>zul/inp/Textbox.js</code> that is part of <code>zul.jar</code>.

Rather, you could specify this library property as described above, and place the modified version of <code>Textbox.js</code> under the  <code>/WEB-INF/cwr/js/zul/inp</code> directory. Then, ZK will load <code>/WEB-INF/cwr/js/zul/inp/Textbox.js</code> you placed rather than the default one in <code>zul.jar</code>.

== debug-js enabled ==
Notice that if [[ZK Configuration Reference/zk.xml/The client-config Element/The debug-js Element|debug-js]] is turned on, ZK will actually look for <code>Textbox.src.js</code> rather than <code>Textbox.js</code> in the above example. Thus, it is suggested to put both files:
* <code>Textbox.src.js</code> 
* <code>Textbox.js</code>
into the  <code>/WEB-INF/cwr/js/zul/inp</code> directories. In addition, <code>Textbox.src.js</code> is suggested to be the readable one (for debugging purpose), while <code>Textbox.js</code> is the compressed one (for production purpose).


== Overriding with Classpath Web Resource Path ==
ZK loads the JavaScript file under the classpath web resource path, '''<code>WEB-INF/classes/web/js</code>''', as the first priority. So that you can put javascript files there to override the JavaScript files in ZK jar under the corresponding path. 

Assume you have a Maven project, you need to put JavaScript files under the path:
<code>src/main/resources/web/[JAVASCRIPT_PATH_IN_JAR]</code>

So the js files will be packaged into <code>WEB-INF/classes/web/</code>.

The picture below demonstrates to override javascript files under <code>zkcharts.jar/web/js/chart/ext</code>:

[[File:overrideByClasspathWebResourcePath.png | center]]

After doing this, then ZK will load highcharts.js under <code>WEB-INF/classes/web/</code> instead of those js in jar.

{{ZKConfigurationReferencePageFooter}}