Git Product home page Git Product logo

alice's Introduction

AliceJS

AliceJS - (A Lightweight Independent CSS Engine) is a micro JavaScript library focused on using hardware-accelerated capabilities (in particular CSS3 features) in modern browsers for generating high-quality, high-end visual effects.

This library and the sample code is Open Source under the Apache 2.0 License.

Author(s):

Requirements:

  1. A WebKit-based browser with support for CSS3.

How to use AliceJS in a web project

  1. Download the source package (zip or tar.gz) and unzip it to your web folder (e.g., /var/www/html/your project name/js/alice).

  2. Include the AliceJS library in your HTML using one of the following:

    a. Full library (with comments):

         <script src="js/alice/alice.js"></script>
    

    b. Minified version of the full library:

         <script src="js/alice/alice-min.js"></script>
    

    c. Specific effect(s):

         <script src="js/alice/src/alice.core.js"></script>
         <script src="js/alice/src/alice.plugins.cheshire.js"></script>
    
  3. Create your HTML markup. For example:

         <div id="deck" class="cards">
             <div class="card"><span>2</span></div>
             <div class="card"><span>3</span></div>
             <div class="card"><span>4</span></div>
             <div class="card"><span>5</span></div>
             <div class="card"><span>6</span></div>
             <div class="card"><span>7</span></div>
             <div class="card"><span>8</span></div>
             <div class="card"><span>9</span></div>
             <div class="card"><span>10</span></div>
             <div class="card"><span>J</span></div>
             <div class="card"><span>Q</span></div>
             <div class="card"><span>K</span></div>
             <div class="card"><span>A</span></div>
         </div>
    
  4. Apply Alice's effects by specifying the ID of your target DIV and some parameters. These options will apply a "slide (left)" effect to your DIVs.

         <script type="text/javascript">
         var a = alice.init(),
             deck = document.getElementById("deck").children;
    
         a.slide(deck, "left", "", {
             "value": "1000ms",
             "randomness": "0%",
             "offset": "150ms"
         });
         </script>
    
  5. Add optional CSS styling to your DIVs:

         <style type="text/css">
         .card {
             float: left;
             background: transparent;
             border: 1px solid #CCC;
             border-radius: 20px;
             width: 75px;
             height: 100px;
             padding: 10px;
             text-align: center;
         }
         </style>
    

More Info

Contributing Changes

To contribute code to this repository, you must sign up as an official contributor.

To build the code you will need to have node installed. To build run the following in your shell(git-bash for windows):

./configure

This will install the dependancies. You should then be able to run:

jake

to build Alice.js

Bug Reporting and Feature Requests

If you find a bug or have an enhancement request, please report an Issue and send a message (via github messages) to the author(s) to let them know that you have filed an issue.

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

alice's People

Contributors

gtanner avatar psiborg avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.