Getting Started

From Documentation
Revision as of 11:20, 11 November 2011 by Tomyeh (talk | contribs) (→‎Java Usage)
Getting Started



Overview

ZUSS (ZK User-interface Style Sheet) is an extension to CSS. It is compatible with CSS, while allows to use variables, mixins, nested rules, expressions, and Java methods with existing CSS syntax.

Variables

/* ZUSS */
@nice-blue: #5B83AD;
@light-blue: @nice-blue + #111;
@dark-orange: orange - #010203;

div.hilite { color: @light-blue;}
div.hilite2 { color: @dark-orange;}
/* CSS */
div.hilite { color:  #6c94be;}
div.hilite2 { color: #fea300;}

Mixins

/* ZUSS */
@border_radious(@radius: 4px) {
  border-radius: @radius;
}

div.rounded {
  @border_radious();
}
button.rounded {
  @border_radious(3px);
}
/* CSS */
div.rounded {
  border-radius: 4px;
}
button.rounded {
  border-radius: 3px;
}

Nested Rules

/* ZUSS */
.bordered {
  &.float {
    float: left; 
  }
  .top {
    margin: 5px; 
  }
}
/* CSS */
.bordered.float {
  float: left;  
}
.bordered .top {
  margin: 5px;
}

Functions

/* ZUSS */
@nice_grey: #5B5B5B;
@darken(@color, @diff: 10%): @color * (1 - @diff);

div {
  color: @darken(@nice_grey);
}
/* CSS */
div {
  color: #525252;
}

Conditional Content

Include

/* ZUSS */
.box_shadow (@x: 0, @y: 0, @blur: 1px, @color: #000) {
  box-shadow: @arguments;
  @if (@gecko < 5) {
    -moz-box-shadow: @arguments;
  } @elif (@webkit) {
    -webkit-box-shadow: @arguments;
  }
}
/* ZUSS */
@include another.zuss;

Download

  • Download the binary distribution from here
  • Get zuss.jar under the dist/lib directory of the binary distribution[1]

Template:References

Servlet Usage

  • Copy zuss.jar to the WEB-INF/lib directory
  • Add the following content to WEB-INF/web.xml
	<servlet>
		<servlet-name>ZUSS</servlet-name>
		<servlet-class>org.zkoss.zuss.ZussServlet</servlet-class>
	</servlet>
	<servlet-mapping>
		<servlet-name>ZUSS</servlet-name>
		<url-pattern>*.zuss</url-pattern>
	</servlet-mapping>

For the configuration of the ZUSS servlet, please refer to the JavaDoc of org.zkoss.zuss.ZussServlet (which could be downloaded from here).

Command-line Usage

You could invoke the ZUSS compiler from the command-line.

java -jar zuss.jar foo.zuss

For a synopsis of standard options:

java -jar zuss.jar foo.zuss -h

Java Usage

The utilities to compile ZUSS can be found in the org.zkoss.zuss.Zuss class. The parse methods are used to parse a variable input source into an immediate format. The translate methods are used to translate the immediate format to CSS.

If your ZUSS file is dynamical, you could store the immediate format and then translate to CSS with an optional variables and function resolver (called org.zkoss.zuss.Resolver).

Bug Reports and Feature Requests

Please post and follow the issues at GitHub.

Version History

Last Update : 2011/11/11


Version Date Content
     



Last Update : 2011/11/11

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.


  1. If you'd like to debug with the source code of ZUSS with IDE, you could get zuss-sources.jar under the dist/src directory.