scripty2 API

Welcome to the scripty2 API Documentation.

scripty2 is divided into three parts, core, fx, and ui, and supports IE6+, Safari 3+, Firefox 3+, Chrome, Opera 10 and most WebKit-based browsers.

This rewrite of the script.aculo.us library is in beta. While we advise to proceed with caution, scripty2 is used in many live, production projects like twistori and freckle and it works great!

Beta notice: scripty2 is currently in beta. The S2.UI API is not final and subject to change.

Sections

  • scripty2 core

    Core contains various JavaScript and DOM extensions used by scripty2 fx and scripty2 ui, plus developer utility classes.

  • scripty2 fx

    The scripty2 effects framework provides for time-based transformations of DOM elements and arbitrary JavaScript objects. This is at the core of scripty2 and presents a refinement of the visual effects framework of script.aculo.us 1.

  • scripty2 ui

    • S2.CSS: functions for CSS parsing, color normalization and CSS value interpolation.
    • S2.UI: User interface patterns that can be used to build components and page behaviours on top of it.

Getting started

  • scripty2 depends on Prototype 1.7 or later. For your convenience, a development copy and a minified version of Prototype is included in the distribution.

    To use scripty2, include this line in your HTML:

    <script src="prototype.s2.min.js" type="text/javascript"></script>

    For debugging, you can also include the libraries seperately:

    <script src="prototype.js" type="text/javascript"></script>
    <script src="s2.js" type="text/javascript"></script>

UI Controls

The scripty2 UI controls are under heavy development and are still in alpha. Consult the README for instructions on how to include these UI controls in the scripty2 distributable.

Tutorials & Demos

Help & Community