Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kriszyp/xstyle
A declarative, reactive framework that extends CSS
https://github.com/kriszyp/xstyle
Last synced: 1 day ago
JSON representation
A declarative, reactive framework that extends CSS
- Host: GitHub
- URL: https://github.com/kriszyp/xstyle
- Owner: kriszyp
- License: other
- Created: 2011-02-05T14:50:35.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2018-11-29T14:55:13.000Z (about 6 years ago)
- Last Synced: 2024-12-16T12:37:05.093Z (9 days ago)
- Language: JavaScript
- Homepage: http://kriszyp.github.com/xstyle
- Size: 1.19 MB
- Stars: 97
- Watchers: 15
- Forks: 55
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
xstyle is a declarative language for defining reactive user interfaces. xstyle extends CSS, combining
familiar syntax with extensibility for creating componentized interfaces that can be used to present not only
HTML, but data objects, with functionally reactive bindings. With xstyle you
can define data bindings, UI elements, variables, extensions, and shims with a simple, stylesheet-driven approach. xstyle also includes tools for loading CSS and building and minifying CSS-driven applications.
xstyle is designed to maximize the maintainability and readability of applications, by allowing
developers to define relationships and extensions, with clear, concise declarations that express
purpose over mechanics, without the noise and repetitiveness of HTML.
xstyle is designed to maximize the performance of applications, allowing components to be defined
and built on modern techniques of event delegation and CSS properties, fully leveraging browser capabilities
without zero per-instance overhead.
# Why Extensible CSS with xstyle?
Modern web browsers have increasingly moved towards relying on CSS to define the
presentation of the user interface. Furthermore, CSS is fundamentally built on the
powerful paradigms of declarative, function reactive programming. By adding a few simple CSS constructs,
xstyle bridges the gap to provide the capabilities for composition and modular extensions that
allow virtually unlimited expression of user interfaces, with a familiar syntax in encapsulated form.
Xstyle goes beyond the capabilities of preprocessor because it runs in the browser and extensions
can interact with the DOM. Xstyle prevents the common abuse of HTML for UI, by allowing
the definition of UI elements with the presentation definition, where they belong, encouraging
both encapsulation and separation of concerns with intelligent organization.
# Getting Started
To start using xstyle's extensible CSS, you simply need to load the xstyle JavaScript library, xstyle.js and you can start using xstyle's CSS extensions:
<style>
/* my rules */
</style>
<script src="xstyle/xstyle.js"></script> <!-- or use the minified xstyle.min.js -->
Or xstyle can be used with an AMD module loader, like RequireJS or Dojo. Simply load the
xstyle/main module to initiate the css extension parsing:
<style>
/* my rules */
</style>
<script src="dojo/dojo.js" data-dojo-config="async: true, deps: ['xstyle/main']"></script>
You will also need to make sure you have installed the [put-selector](https://github.com/kriszyp/put-selector)
package (if you are using xstyle extensions), as xstyle depends on it.
Using a module loader is beneficial, as it provides for automatic loading of extension
modules when they are used in CSS.
Xstyle also includes a CSS loader, for dynamically loading CSS as a dependency of modules.
See the AMD Plugin Loader section for more information.
Xstyle supports all modern browsers, and Internet Explorer back to version 8
(although in IE8, it is not possible to use xstyle CSS directly in style tags, all xstyle CSS
must exist in CSS files, which is recommended anyway).
# Using Xstyle CSS
Once you have loaded the xstyle script or module, you can begin to use xstyle's extensible CSS,
making use of new definitions to develop your application within CSS.
## New Definitions
The key building block in xstyle is an extension for creating new definitions for features like
user defined properties, data sources, and functions. In traditional CSS, all properties, functions, and other
constructs are defined by the browser, and stylesheet rules are limited to using
these predefined properties. In xstyle, new properties, functions, and other elements can be defined with
extensible meaning. New definitions may be used as bindings to data models, shims (to fill in for standard properties
on other browsers), they may be compositions of other properties, or provide entirely new concepts.
Since definitions can be constructed using JavaScript modules that can interact with
the DOM, there is virtually no limit to the what can be created.
To create a new definition, we simply use the = operator to assign a name to
our new definition and assign an expression to indicate its meaning. For example, xstyle provides a property
definition expression that will automatically add a vendor specific prefix (like -webkit-) to a property.
We can create such a property:
transition = prefix;
New definitions can be defined anywhere in a stylesheet, including at the top level (amongst
rules), within rules (or nested rules), or even directly in property names. At the top level, a new definition makes
the definition or property available for use anywhere below the definition. Defined within a rule, the
new definition is available only within that rule declaration (or nested rules or extending rules)
below the definition. For example, we could use this property definition in a rule, to have
xstyle automatically generate vendor specific properties for the transition property
(including -webkit-transition, -moz-transition, etc.):
transition = prefix;
.content {
transition: color 0.5s;
}
Since property definitions can be used directly within a property name, we could inline the
definition to more succinctly write the same transition:
.content {
transition=prefix: color 0.5s;
}
When using property definitions for shimming properties, we generally only want to apply
the shim (vendor prefixing in the example above) if the standard property is not available.
We can conditionally define a new property only if the property has not already been defined
(by the browser or a previous definition) with the =? operator. We could update the
example above to use the standard 'transition' without prefixing if available:
.content {
transition=?prefix: color 0.5s;
}
However, shimming is only the beginning of what we can do with xstyle. We can also
create new definitions with custom behavior implemented in JavaScript module, which can
in turn create other custom rules or affect interaction with the DOM. We can use
rules as a definitions or JavaScript modules for more customized behavior:
my-custom-property = module(my/module);
We look at how how to implement a module in more detail later.
## Rule Definitions and Mixins
We can also create a new definitions as a composition of other properties, like a rule declaration.
Such definitions can be used as properties, to mix in their properties, they can
be used as base rules for extension, or they can be referred to like elements in
element generation (see below). For example, we could create a new definition
based on absolute positioning:
absolutely = {
top: 50px;
left: 50px;
position: absolute;
}
We could then style a class by mixing in our new definition. We do this simply by including
the using the definition as a property in our rule. If we want to simply mix in the properties
as defined in the base definition, we set the value to "defaults":
.my-class {
absolutely: defaults;
}
We can also override properties from our definition:
.my-class {
absolutely: defaults;
top: 60px;
}
And, we can do this shorthand, by putting values directly in the "absolutely" property. The
values are then assigned to the composite properties in order of declaration. For example:
.my-class {
absolutely: 60px 70px;
}
Would be the same as:
.my-class {
absolutely: defaults;
top: 60px;
bottom: 70px;
}
## Extending Rules
We can also create rule definitions that extend other rule definitions. We do this
by referencing the base definition after the '=' and before the rule declaration:
absolutely-green = absolutely {
background-color: green;
}
We can also extend from multiple base definitions. We do this by comma delimiting
all the base definitions we want to inherit from. For example, we could alternately create our
absolutely positioned element with green background from two other definitions:
green-background = {
background-color: green;
}
absolutely-green = absolutely, green-background {}
This provides similar functionality as using the base definition as a property, but there
are a couple of important distinctions. First, extensions will inherit all the definitions within
the base definition, whereas property mixins only inherit the property values (and their
meaning according to their own definitions). This means that if you have assigned
a new definition within a base rule definition, you can reference that definition in your
property definitions or element references.
The second capability that extending rules provides (that is not a part of property mixins),
is that you can refer to any tag or class selector as the base definition, and that tag or class (or a `tag.class` combination) will be used
when the definition is referenced in element generation (see section below). For example,
we can create our own big-header definition that inherits from an `h1`:
big-header = h1 {
font-size: 4em;
}
## Limitations
Due to goals of performance and minimizing the size and complexity of the xstyle library, there are several key limitations that should be understood.
First, definitions can only be referenced *after* they have been defined. This means that if you are going to reference a custom definition in your stylesheet, you must ensure that the definition is defined before (above) you use it.
Second, we can only extend other definitions or HTML elements. Xstyle does not support extending other types of selectors (like class references, etc.).
## Element Generation
With xstyle, you can declare the creation of DOM elements within rules, allowing for the creation
of complex presentation components. This can be thought of as templating functionality
(using CSS selector syntax, similar to jade), with reactive capabilities. This not only
simplifies the creation and composition of UI components, it helps to keep cleaner semantics in HTML,
and provides better encapsulation.
To create an element, we use the => operator, followed a selector designating the
tag of the element to create along with class names, id, and attributes to assign to the element.
For example, we could create a <div> with an class name of "tile" inside of any element
with a class name of "all-tiles":
.all-tiles {
=> div.tile;
}
You can create elements with ids and attributes as well, using standard selector syntax.
This will create a div with an id of "help" and a title of "Information":
.all-tiles {
=> div#help[title=Information];
}
Element generation can also generate multiple elements, and take advantage of indentation
to indicate the hierarchy of the elements. Deeper indentation indicates child elements,
and shallower indentation can be used to generate parents. For example, we could
create a simple hierarchy:
.simple {
=>
div.parent1
div.child
div.grandchild
div.parent2
div.another-child
}
Or, we could create a two by two table:
table.two-row {
=>
tr
td
td
tr
td
td;
}
We could also generate text nodes inside elements with quoted strings. We could create
an h1 header with some text like:
header {
=> h1 'The header of the page';
Xstyle will automatically handle applying any previously done element generation rules
within the generation of other elements. For example, if we were to create a
table.two-row element, with the element generation definition above, we can also
use this in another element generation. For example:
.content {
=> table.two-row; /* <- this will be expanded to create two rows */
As mentioned in the rule definition section, we can also reference any rule definitions
within our element generation. For example, we could reference the "big-header"
definition we created above, which will generate an <h1> element with a font-size
of 4em:
.content {
=> big-header;
}
## Nested Rules
With xstyle, you can nest CSS rules, allowing for multiple definitions using a given selector
prefix. For example, suppose we want to define several rules for elements within
.my-form. We can do so with nested rules:
.my-form {
input {
/* this rule's selector is equivalent to .my-form input */
}
select {
/* this rule's selector is equivalent to .my-form select */
}
}
Using nested rules can improve readability, add better organization, and make it easier to refactor stylesheets.
### Nested Element Generation
Nesting rules is particularly useful in combination with element generation, as we can
define the CSS for the generated elements without having to manually create and
synchronize an element identifier or selector with another CSS rule.
.content {
=>
h1 {
color: green;
}
p 'Blue Paragraph' {
color: blue;
};
}
We can nest element generation and CSS rules in any combination that we want, allowing
us to create sophisticated UI elements in a single modular unit.
## Programmatic Generation
From JavaScript, we can also leverage the generation capabilites to create new elements and instantiate and use classes and components that were defined in xstyle css. This is functionality is provided by the `xstyle/core/generate` module, and if using the xstyle script, is accessible from `xstyle.generate`. This function takes two arguments, and supports the same CSS selector syntax for defining elements to be created:
generate(parentElement, selector);
With this function we could generate a new element that has been defined as a component with generated sub-content. Here we could refer to the `content` class created above:
generate(target, 'div.content');
## Predefined Property and Function Definitions
Xstyle includes several predefined, or intrinsic definitions for properties. These can and usually
are assigned to other names to create property definitions for use in rules. The next
few sections describe these provided definitions.
One feature of the application of property definitions in xstyle is that when a property
with dashes in it, is encountered in a rule, xstyle will first look for a definition that
matches the full name, and then progressively remove the dash-delimited tokens from the
right to apply. For example, if we defined a property custom, than it our definition
would be applied for custom-foo as well as custom.
### var - Variables
Properties can be used as variables that can be referenced from other properties in CSS stylesheets.
For many, this concept may be very familiar from CSS preprocessors,
and the recent addition in modern browsers according to the W3C specification.
To create a variable property, we define our property by assigning it var. For
example, we could create a variable:
highlight-color=var: blue;
To reference the variable and use the value in another property, xstyle uses the standard W3C
syntax, referencing the variable with a var(variable-name) syntax:
.highlight {
background-color: var(highlight-color);
}
A variable can be declared at the top level, as well inside rules. A variable can referenced
that is within the current rule or any parent rule (see nested rules) including the top level.
### prefix - Vendor Prefixing
This definition will create a property like the declared property, except a vendor prefix
will be added that corresponds to the browser's vendor. The prefixes are -webkit- for
WebKit browsers, -moz- for Firefox, and -ms- for IE. A typical usage is:
appearance = prefix;
appearance: button;
### content - Insertion Point
This definition represents a reference to the contents of node prior to element generation.
This can be used within element generation to bring in the contents of the target.
For example:
.greeting {
=> h1 'Welcome:', content;
}
We could then have some HTML that starts as:
John Doe
And then xstyle would convert this to:
Welcome:
John Doe
### on - Event Handling
The "on" definition makes it possible to register handlers directly from rules. This property
definition does not need to be assigned to a new name. It utilizes sub-property names
to specify the event to listen for. The property name should be the form of on-<event-name>.
The value of the property should be an expression that should be executed in response to the event. For example, to register
a click handler, we could write a property:
on-click: click-handler();
The triggering event is also available in through the event definition:
on-click: click-handler(event);
See the Data Bindings section below, as you will probably want to access sub-properties of
definitions for your event handlers.
### get - Expressions in CSS property values
Normally standard CSS property values are not resolved as expressions. However, function calls in CSS properties are evaluated if a matching definition can be found. However, by using `get(expression)`, you can provide an expression to be evaluated in CSS property. For example, if we wanted to define a color that was dependent on another property value, we could write:
color: get(forecast/temperature > 80 ? 'red' : 'blue');
### set - Set the value of a definition
The set function can be used to set the value of a particular definition. This is particularly useful in event handlers, where you might want to set a value in response to an action. For example, we could write an `click` handler for a button to turn a flag on:
button {
on-click: set(enable-editing, true);
}
### toggle - Toggle a value
The `toggle` function works similar to get, but is a convience function for toggling. We could toggle a flag like:
on-click: toggle(enable-editing);
### margin, padding, border, etc. - Nested Definitions
Xstyle extends the margin, padding, and other properties to support nested rules to
specify the individual sides, or sub-properties of these properties. For example,
we could specify the margin-left and margin-right by writing:
margin: {
left: 10px;
right: 20px;
};
We can also assign the top level value by setting the `main` property. For example:
margin: {
main: 10px;
right: 20px;
};
Is equivalent too:
margin: 10px;
margin-right: 20px;
### element-property
This definition is mapped to a property that is stored on each element instance of the rule. This allows you to keep state information on elements, that is unique to each element. This could be mapped to an existing or native property or a custom property. For example, we could track selection state, by defining the `selected` variable as an element property, which could then be used to track the state of the element:
li {
selected = element-property;
background-color: get(selected ? 'yellow' : 'transparent');
button.select {
on-click: toggle(selected);
}
}
### element-class
This definition is a boolean value that corresponds to the presence or absence of a class name on each element instance of the rule. This is similar to the `element-property` definition, except that the state is stored with a class name. We could alternately write the example of tracking the selected state:
li {
selected = element-class;
button.select {
on-click: toggle(selected);
}
}
li.selected {
background-color: yellow;
}
### element
This returns a reference to the corresponding DOM element. The element definition can be defined/reassigned in a rule, so that the element for that rule can be referenced. For example, we could create a component, with a button that references the element for the higher level component:
component = {
component-element = element;
=>
button {
on-click: do-something(component-element);
};
}
## Data Binding
We can combine property definitions with element generation to create data bindings. With data
bindings, an element can be generated and the contents can be bound to a variable.
A basic example of a data binding would be to create a variable with a string value:
first-name = 'John';
div.content {
=> span(first-name);
}
The contents of the span that was created would then be set to the value of `firstName` (note that dashed nameds are converted to camelCase for JavaScript interaction). Changes in the
value of the `firstName` would automatically be updated in the span's contents.
We can also bind variables to inputs, and then the binding will work two ways, not only can
changes in the variable be reflected in the input, but user edits to the value will be updated
to the variable. For example:
first-name = 'John';
div.content {
=> input[type=text](first-name);
}
This provides the foundation for wiring components to data sources. We can also assign
variables to modules, providing an interface between JavaScript-driven data and the UI.
We bind a variable to a module like this:
person = module(package/person-model);
We can then bind to the object returned from the module. We use a / operator to refer
to properties of an object:
form.content {
=>
label 'First Name:',
input[type=text](person/first-name),
label 'Last Name:',
input[type=text](person/last-name);
}
Changes in property values will be automatically reflected in the rendered elements, and for inputs, and user changes will be reflected back to the source objects.
### Attribute Binding
All elements have default binding. For input elements, bindings are bound to the input's
"value" attribute, for other elements, to the text content of the element. However,
you can also bind to specific attributes of an element as well. This accomplished
by placing the parenthesis embedded binding reference in an attribute selector generator.
For example, we could bind the href of an anchor element to a variable:
targetUrl = 'http://target/';
.content {
=> a[href=(targetUrl)];
}
### List Binding
Not only can we bind scalar values to elements, we can also bind lists or array to elements
to generate a list of children elements corresponding to each item in an array. We bind
arrays just like we do scalar values. For example, we could easily output an array
of strings as a list like:
.content {
=> ul(array-of-items);
}
Xstyle will iterate through the array, outputting a <li/> element for each item, with the contents
corresponding to the item value. Different elements have different rendering for arrays,
<ul> and <ol> elements will have have <li> children, <select>'s will have <option> children,
and most others will have <div> children.
You can also declare your own rendering of children by defining an "each" property for the
targeted element. The
value of the each property should be a generating selector (just as we use with the => operator).
The item for each iteration in the array can be referenced with the "item" reference.
For example, we could generate a paragraph tag for each item:
.content {
=> div(array-of-items) {
each: p(item);
}
}
This makes it possible to render arrays of objects. For example, we could render
a table of objects, where the first column corresponds to the "name" property of the
items in the array, and the second column corresponds to the "age" property:
.content {
=> table(array-of-people) {
each: tr {
=>
td(item/name),
td(item/age);
};
};
}
In addition to using plain arrays, [dstore](https://github.com/SitePen/dstore) stores/collections can be used, providing real-time reflection of data sources.
### Expressions
Data bindings can include more than just a plain variable reference, we can also write
expressions that include other JavaScript operators. For example, we could bind
to the value of concatenation of two strings (again a live binding, automatically updated if either
variable or property changes):
h1.name {
=> span(person/first-name + person/last-name);
}
The following operators are available in expressions, and have the same meaning as in JavaScript:
+, -, *, /, ?:, !, %, (, ), >, <=, <, <=, == (same as JS ===), & (same as JS &&), | (same as JS ||).
## Creating Components
By combining the ability to create new definitions, bindings, and variables, we can create
new encapsulated components with CSS. For example, here we create a component
that renders an h1 and p element with content, as defined by the component.
my-component {
=>
h1 (label),
p (content);
label=var: 'Default Label';
content=var: 'Default Content';
background-color: #ddf;
}
We can then use this component as building block in our application:
body {
=> my-component {
label: 'My Label';
}
}
## Shims
Xstyle can also be used to define extensions can be used for filling in missing functionality in browsers. Xstyle's default stylesheet
provides shims for a few commonly used properties that are missing in some older browsers,
including box-shadow, transform, and border-radius. For example, we can write:
@import "xstyle/shims.css";
.my-class {
box-shadow: 10px 10px 5px #888888;
transform: rotate(10deg);
}
Here, we can use newer CSS properties like 'box-shadow' and 'transform' and Xstyle
will shim (or "polyfill" or "fix") older browsers for you, transforming these to
MS filters for older versions of Internet Explorer.
# Interfacing with JavaScipt
Xstyle provides expressive declarative capabilities, but any substantial application will need to interact
with JavaScript. We often need to interact with JavaScript to access data models, create custom components or functions, and
define other imperative operations.
There are a couple ways we can interact with JavaScript. The first, preferred approach is to reference a module.
To define a new definition from a JavaScript module, we use the module(module-id) to assign to a definition:
my-new-definition = module(package/module-id);
Using an AMD loader, xstyle will load the target module id and assign the result to the definition.
Alternately, we access the global window variable through the `window` definition (or `global`). For example:
my-new-definition = window.library.feature;
Note, that you need to be careful to ensure the global property/object is available before xstyle accesses it.
The JavaScript module can return an object (or provide an object to the define call), or we can reference a global
that has methods that will be called when the property or function is used in stylesheets. The following
methods will be called if they exist (they are all optional):
* object.put(value, rule, propertyName) - This is called whenever the property is used within a rule. The
value argument is the property value in the rule, and the rule
argument is the Rule object. This can return a contextualized object (see below).
* object.valueOf() - This is called to return the value of the current object. This can be used to return
scalar values if desired. It can also return a contextualized object (see below).
* object.dependencyOf(definition) - This is called to setup a dependency on your provide object. This is called
with another definition as the argument. If the value of this module changes, the `invalidate()` method on the definition
can be called to indicate a change in the value.
* object.define(rule, name) - This will be called when an object is assigned to a new
definition.
* object.property(name) - This is called when a property is accessed using the my-new-property/sub-property
syntax.
* object.apply(rule, args) - This is called when the definition is used a function, like
my-new-definition(). Note, you can also provide a function as the value of the module or the referenced global value,
in which case the apply() call will execute the function.
Note that all references that use dash-style-names in xstyle are converted to camelCase for JavaScript interaction.
## Contextualized Objects
The `valueOf()` and `put()` methods may return contextualized objects, which indicate that their value is dependent on
context. By including one or both of the follow methods, the return object is indicating that they need additional
information that is context-sensitive to compute their fina value:
* object.forElement(element) - If the value of a property is dependent on the element
that the rule is being applied, the contextualized object may provide a forElement(element)
function that would be executed (and return a value in the case of `valueOf`) based on the provided element.
It should be noted that there is additional processing overhead, since every
element needs to be processed individually with this approach.
* object.forRule(rule, name) - This indicates that the method needs to be executed for
each rule that this property applies to. The rule and the name of the property will be passed in. Note that a property
may be declared in a rule, triggering a single call to `put()` yet, the rule may be extended to create new rules, resulting
in multiple calls to `forRule()`
The Rule object has the following properties and methods that can be used by the module:
* setValue(name, value) - This performs the action of adding a new property value to
a rule. If there are any definition for the property, there are then executed.
* setStyle(name, value) - This sets a style on the native CSSOM rule object for the this rule. You can
apply additional native CSS properties directly by setting properties on the style object:
rule.setStyle('color', 'red');
For example, we could define a module that vertically expands a target element when it is clicked, and takes
two height values, with starting and ending values.
define([], function(){
return {
forParent: function(rule){
var heights;
return {
put: function(value){
// take the two heights and split them up
heights = value.split(/\s+/);
// define the starting height
rule.setStyle('height: ' + heights[0]);
// define a property for animating the change
rule.setStyle('transition: height 0.2s');
},
forElement: function(element){
element.addEventListener('click', function(){
// when the element is clicked, change the height
element.style.height = heights[1];
});
// note that when setting up event handling,
// it is strongly recommended that you use event delegation
// instead of forElement, when possible
}
};
}
};
});
We could now use our property definition in a xstyle stylesheet:
expandable-height = module(my-package/expandable);
.target-element {
expandable-height: 10px 30px; /* specify a starting and ending height*/
}
## Functions
As listed, the `apply()` method will be called when a function is encountered. However, there are several ways of handling functions.
By default, the function will be treated as a reactive function, the referenced definitions will be resolved, asynchronously, if needed, contextualized, and monitored for changes, such that any change will trigger the function execution again. For example, we could create a module that a function that computes the sum of values:
define(function () {
return function sum() {
var sum = 0;
for (var i = 0; i < arguments.length; i++) {
sum += arguments[i];
}
return sum;
};
});
We could then use this in our xstyle stylesheet:
sum = module(my-package/sum);
model = module(my-package/data-model);
#sum {
=>
span (sum(model/a, model/b, model/b))
}
The function will be executed with the values from the model objects, and will be re-executed whenever those values change so that the sum can be recomputed.
Alternately, we may wish to have greater control over the execution of a function. There are several flags that we can set to control how our function is executed.
If you wish to have the argument references/expressions resolved, but you would like to directly handle the definition objects that are passed to the argument, you can do so by setting a `selfExecuting` property on the function to true. Your function will be called with definition objects for the specified arguments. You can then determine if you and when you want to retrieve the current value (by calling `valueOf()`), and if you want to declare a dependency so that you can be notified of any changes in the arguments (using `dependencyOf()`). Note that `valueOf()` may return a promise if the value is not available yet. It also may return (or resolve to) a contextual object, which generally requires returning another contextual object to retrieve each current context.
Or, you can set a `selfResolving` property on the function to true, and your function will be called with the unresolved raw arguments as strings or sequences of tokens. The function will be executed without any argument resolution. For example, if our function is called like `func(a, b)`, the arguments will be the actual strings `'a'` and `'b'`. This gives us the greatest ultimate control of the behavior of the function, but generally requires the greatest effort if you want to achieve normal definition referencing and reactivity.
## Definition Object
A definition object is a core object in a xstyle. All definitions that are defined are stored in definition objects, to permit time-varying values, with dependency tracking. A definition object has the following methods:
* `valueOf()` - This will return the current value of the definition. This may be a plain primitive value or objects. However, there are several important types that can be returned as well:
* The value may be a promise, if the data is not available yet.
* The value may be a contextual object. See the contextualized object section above for more information on contextual objects.
* `dependencyOf(definition)` - This is a method that may be called to add a dependency on this definition. If you would like to be notified of any data changes, you can add an object with an `invalidate()` method to be notified if the argument is changed (and you can call `valueOf()` to get the latest value),
* `invalidate()` - Called to invalidate this definition. Generally this should only be called by the `dependencyOf()` method.
* `property(name)` - Called to retrieve a definition for a property of the value of this definition.
* `put(value)` - Set a new value into the definition. Some definitions may not have a `put()` method, indicating that they are read-only. This may return a contextual object, if the definition needs to know the context of where the value is being set.
## Pseudo Definitions
We can create new definitions for pseudo selectors. Pseudo selector definitions begin
with a colon. For example, we can could create a custom pseudo selector:
:custom = module(my-package/custom);
The module's returned object should have a pseudo method that will be called for handling
rule's with the defined pseudo selector.
Again, we can use a conditional operator if we only want to implement the pseudo if it
has not already been provided by the browser. For example, if wanted to shim support
for the :enabled pseudo, we could implement a shim module and conditionally load it:
:enabled =? module(my-package/enabled);
## Scoped Blocks Xstyle and Disabling Parsing
With xstyle, you can define blocks of CSS that have their own nested scope (without
a nested rule), to declare definitions without affecting other stylesheets. A new scope
can be started by using the @xstyle start directive to start a scoped block
and the @xstyle end to end a scoped block:
@xstyle start;
box-shadow = prefix;
/* box-shadow will have vendor-prefixing applied */
@xstyle end;
/* box-shadow will be ignored again */
Also, you may wish to completely disable xstyle, or import a stylesheet that should not be parsed
by xstyle. This may be due to conflicts with properties, or other issues. Xstyle parsing can be
turned off by using:
@xstyle end;
And it can be turned back on with:
@xstyle start;
You can also use the @xstyle start and end directives to
create nested scopes. For example, you might wish to apply to a shim to all CSS (without
nesting it in an inner rule), and you can do so by using this directive:
@xstyle start;
some-variable=var: some value;
@import 'stylesheet-that-uses-some-variable.css';
@xstyle end;
/* any definition above won't affect CSS below */
### Included Shim Stylesheets
The shims.css stylesheet also defines shims for pseudo selectors including hover and focus.
By @import'ing shims.css into a stylesheet, these shims will be defined and we can using.
The rule definitions are transitive, so if stylesheet A @import's stylesheet B, which @import's
shims.css, both A and B stylesheets will have the shims applied. If another stylesheet C is
later independently loaded and it doesn't import any stylesheets, none of the shims
will be applied to it.
#### Available Shims (and limitations)
The following experimental shim modules come with Xstyle:
* shim/transition - This provides animated CSS property changes to emulates the CSS transition property.
* shim/boxOffsets - This provides absolute positioning in older versions of IE to emulate
bottom and right CSS properties.
#### Available Extensions
The following (mostly experimental) extension modules come with Xstyle:
* ext/pseudo - This modules provides emulation of hover, focus and other pseudos that
are not present in older versions of IE.
* ext/scrollbar - This module provides scrollbar measurement so that elements can be sized
based on the size of the scrollbar.
* ext/supported - Matches elements that have native support in the browser. For example:
range:unsupported {
/* styling for browsers that don't support range */
}
range:supported {
/* styling for browsers that do support range */
}
* ext/widget - This module can instantiate widgets to be applied to elements that match
a rule's selector. This is designed to instantiate widgets with the form of Widget(params, targetNode),
and can be used to instantiate Dojo's Dijit widgets.
* ext/meta - This provides metadata information about fields, including validation.
## Validation and Metadata
The `xstyle/ext/meta` module can be used to provide metadata information about fields, including validation.
## Widgets
One of the extensions included in xstyle is a property for declaring
widgets that follow the Dojo widget API (like Dijit widgets). This extension module is
available in the xstyle/ext/widget module. This can assigned as a new property definition
and then the property can be used with a
nested rule with sub-property definitions corresponding to the properties that should
be passed to the widget. There should also be a "type" property that indicates
the id of the module with the widget to load. For example, we could add a "widget"
property definition:
widget = module(xstyle/ext/widget);
And then we could create progress bar using dijit/ProgressBar, using the "widget" property
in a rule:
.my-progress-bar {
widget: {
type: dijit/ProgressBar;
maximum: 20;
value: 10;
}
}
# Build
This functionality is partially implemented.
Xstyle includes built tools that serve several purposes. First, they provide CSS aggregation,
combining @import'ed stylesheets into parent stylesheets to reduce requests. Second,
it will perform CSS minification, eliminating unnecessary whitespace and comments.
Xstyle will also isolate extensions into a special property that allows the xstyle parser
to run signficantly faster with a built stylesheet. To run the build tool, run the build.js
with node, providing a path to a stylesheet or directory of stylesheets to process, and
a target to save the stylesheet to. For example, if we want to build app.css, we could do:
node build.js app.css ../built/app.css
The xstyle build tool is also capable of inline resources like images directly in the stylesheet
with data: URLs. This can be very useful for reducing the number of requests. To mark resources for inlining, simply append a hash of #inline to the URL of the resource.
For example, if we had a background image pointing back.png, we could write the following rule
.content {
background: url(back.png#inline);
}
When the build tool runs, this URL will be transformed to a data URL, and no extra request
will be necessary to fetch this background image. While this can reduce the number of
requests, this is best used for images that are small and very likely to be used. Since
the URL is inline in the stylesheet, it increases the load time of the stylesheet, and
if the image might not be used or is large, this may be more detrimental than the
improved overall load time afforded by the reduced requests.
# AMD Plugin Loader
You can also use Xstyle as a CSS loader plugin for AMD loaders like Dojo and RequireJS.
To use the CSS loader, use the AMD plugin syntax, with xstyle/css as the plugin loader
and the path to the stylesheet afterwards:
require(['xstyle/css!path/to/stylesheet.css'], function(){
// after after css is loaded
});
Note, that simply using the plugin loader will not load xstyle, and trigger parsing of the stylesheet,
so you will not be able to use the extensions, unless you have specifically included
the xstyle module as well.
This functionality is implemented and has been well tested.
# Building with AMD Plugin
When used as an AMD plugin, xstyle can also integrate with a Dojo build, automatically
including CSS dependencies of modules in a build. To run utilize xstyle in a Dojo build,
you need to include the xstyle AMD build plugin. This can be specified in your build profile:
plugins: {
"xstyle/css": "xstyle/build/amd-css"
},
After that, you can simply run a build as normal, and the CSS dependencies will
automatically be inlined in the built layer.
While inlining CSS text in a JavaScript built layer is the easiest approach, and can also
help reduce the number of requests, it is generally preferable to keep CSS in stylesheets,
and leverage browser's optimized patterns for loading stylesheets. This can be accomplished
as well with the integrated Dojo build. You simply need to specify a target stylesheet
in the layer definition in the build profile:
layers: [
{
name: "path/to/targetModule.js",
targetStylesheet: "my-package/css/main-stylesheet.css",
...
When the build runs, any CSS dependencies that are encountered in modules will then
be added to main-stylesheet.css (which will be created if it does not already exist), rather
than inlined in the JavaScript build layer. One
can still use the #inline URL directive to inline resources in combination with the AMD
build plugin.
## Import Correction
Another feature Xstyle provides is reliable @import behavior. Internet Explorer is not
capable of loading multiples levels deep @imports. Xstyle provides @import "flattening"
to fix this IE deficiency.
Xstyle also normalizes @import once behavior. If two stylesheets both @import the
same sheetsheet, Xstyle ensures that the @import'ed stylesheet is only imported once (by the first
stylesheet) and the second @import is removed. This is a powerful feature because
it allows stylesheets to @import another stylesheet without worrying about overriding
another stylesheet that expected to come after the target sheet due to it's @import statement.
# Additional Modules
## has-class
The has-class module provides decoration of the root <html> element with class names
based on feature detection. The has-class module works in conjunction with the has()
module in Dojo (dojo/has) to detect features, and adds a class name for matches with
a "has-" prefix. For example, if we wanted to create a CSS rule that was conditional on the detection of
the "quirks" feature, first we would need to register this feature detection with the has-class module:
define(['xstyle/has-class'], function(hasClass){
hasClass("quirks");
});
And then we could create a rule that uses this conditional class name:
html.has-quirks .row {
/* rule only applied if in quirks mode */
height: auto;
}
We can also base rules on the absence of a feature. In converse, we could create
a rule for when quirks mode is not present:
hasClass("no-quirks");
And then use this in the selector:
html.has-no-quirks .row {
/* rule only applied if in quirks mode */
width: auto;
}
We can also base rules on a numerical feature values. We could create a rule that
just matches IE7 with:
hasClass("ie-7");
Or version IE8 through IE10:
hasClass("ie-8-10");
## Philosophy
Xstyle is driven by several guiding ideas:
* Leveraging declarative transforms as functionally reactive, bidirection mechanism for mapping data to a UI
* Integration and interoperability of CSS with JS, to facilitate separation of declarative and imperative code.
* A pragmatic extension of CSS so that it leverage existing CSS loading and parsing facilities in the browser.
* Extending and polyfilling with using the same extension mechanism most commonly used by browsers for new UI features.
## License
xstyle is freely available under *either* the terms of the modified BSD license *or* the
Academic Free License version 2.1. More details can be found in the [LICENSE](LICENSE).
The xstyle project follows the IP guidelines of Dojo foundation packages and all contributions require a Dojo CLA.
If you feel compelled to make a monetary contribution, consider some of the author's [favorite
charities](http://thezyps.com/2012-giving-guide/) like [Innovations for Poverty Action](http://www.poverty-action.org/) or
the [UNFPA](http://www.friendsofunfpa.org/).