• Stars
    star
    516
  • Rank 85,726 (Top 2 %)
  • Language
    JavaScript
  • License
    Other
  • Created over 16 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

scripty2: for a more delicious web

scripty2: for a more delicious web¶ ↑

scripty2 is an open source JavaScript framework for advanced HTML-based user interfaces. Or simply put, scripty2 helps you build a more delicious web:

  • Visual effects: scripty2’s heartpiece is an versatile real-time effects framework

  • CSS utilities

  • UI components (experimental)

And there’s more coming! scripty2 is currently in alpha status, so APIs can change and there’s still a lot more functionality planned.

scripty2 is a complete rewrite and reimplementation of script.aculo.us, with are modular structure intended to ease the development of highly customized user interface effects and behaviours.

Please use groups.google.com/group/scripty2 for any development questions for scripty2. Patches, tests, demos, updates and documentation are always welcome.

Build¶ ↑

For building, development and testing, you need to have a working Ruby setup. You’ll need the bluecloth, treetop and coderay gems installed.

To build the distribution, run:

rake && rake package

This will build the documentation (in /doc) and provides ready-to-deploy JavaScript packages in /dist.

The build process uses the YUI Compressor to build a minified version of the library file. This requires Java to be installed and available.

After the build process is done, you’ll find two files in /dist:

  • s2.js (for debugging)

  • s2.min.js (minified version for production use)

Though scripty2 has been used to great effect on several high-volume websites, keep in mind that scripty2 effects are in beta. APIs are subject to change before final release.

Build with UI¶ ↑

The scripty2 UI controls are under heavy development and are still in alpha. They’re not included when you run the standard rake tasks. To build a distributable with UI controls included, run:

rake dist:experimental

There are several other *:experimental tasks corresponding to common actions. Run rake -T to see the list of tasks.

Usage¶ ↑

scripty2 is dependent on the Prototype JavaScript framework. The download and source comes with a compatible version, or grab the latest version yourself from prototypejs.org/.

Put prototype.js and s2.js in a folder of your website, and include them as follows:

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

You’re ready to go! Now look at the documentation and demos (see below!).

Documentation¶ ↑

To build the documentation, run:

rake doc

The documentation is built with PDoc, which uses specially formatted source code comments to build a fully interactive HTML documentation set.

Navigate a browser to /doc/index.html to view and browse the documentation.

Tests¶ ↑

To run the unit tests, use:

rake test

You can run specific tests, or use only specific browsers:

rake test BROWSERS=safari TESTS=css,heartbeat

License¶ ↑

scripty2 is is licensed under the terms of the MIT License, see the included MIT-LICENSE file.

More Repositories

1

zepto

Zepto.js is a minimalist JavaScript library for modern browsers, with a jQuery-compatible API
HTML
14,992
star
2

keymaster

A simple micro-library for defining and dispatching keyboard shortcuts. It has no dependencies.
JavaScript
6,525
star
3

scriptaculous

script.aculo.us is an open-source JavaScript framework for visual effects and interface behaviours.
HTML
2,321
star
4

vapor.js

The World's Smallest & Fastest JavaScript Library
JavaScript
1,373
star
5

dom-monster

JavaScript
562
star
6

emile

emile.js is a no-frills stand-alone CSS animation JavaScript framework, named after Émile Cohl, early animator.
JavaScript
530
star
7

pragmatic.js

Pragmatic rules for writing JavaScript
381
star
8

textorize

Ruby
236
star
9

semicolon.js

A more secure. stable and reliable version of vapor.js
JavaScript
229
star
10

zaru

Filename sanitization for Ruby
Ruby
222
star
11

creditcard_js

A creditcard validation library for JavaScript using Prototype
JavaScript
184
star
12

downtime

Standardized JSON API to indicate downtime for apps and services
JavaScript
90
star
13

prototype_helpers

Various bits and helpers for Prototype and scriptaculous, that might prove useful or not. :)
JavaScript
75
star
14

bitarray.js

Pure JavaScript bit array/bitfield implementation
JavaScript
53
star
15

spark_pr

Pure Ruby sparklines.
Ruby
42
star
16

purrson-icon

39
star
17

creditcard_js_underscore

A port of creditcard_js to underscore.js
JavaScript
23
star
18

secure.js

JavaScript
20
star
19

jive

HTML
17
star
20

js-animation-course

JavaScript
16
star
21

gifs

Shell
15
star
22

box2d-js

Sprocketized version of box2jd-js
JavaScript
12
star
23

blink

12
star
24

zeptojs.com

JavaScript
12
star
25

dotvim

Vim Script
11
star
26

ponymizer

Generator of random pony names to be used as friendly and fun test data
Ruby
10
star
27

js1k-finals

7
star
28

jslogocrazyness

6
star
29

madrobby.github.com

5
star
30

acornkittens

JavaScript
5
star
31

yotta

A heavily-optimized JavaScript library with a large impact
HTML
5
star
32

plastic-clock

CSS
3
star
33

schnitzelconf-intro

1
star