https://github.com/sboudrias/jquery.3dish-slider
3D "ish" slider plugin for jQuery - Work in progress
https://github.com/sboudrias/jquery.3dish-slider
Last synced: 4 months ago
JSON representation
3D "ish" slider plugin for jQuery - Work in progress
- Host: GitHub
- URL: https://github.com/sboudrias/jquery.3dish-slider
- Owner: SBoudrias
- License: gpl-2.0
- Created: 2012-05-02T17:30:03.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2016-11-19T22:44:18.000Z (almost 9 years ago)
- Last Synced: 2025-03-17T10:22:22.508Z (7 months ago)
- Language: JavaScript
- Size: 564 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-GPL
Awesome Lists containing this project
README
# 3dish Slider
Threedish is a basic 3d effet slider jQuery plugin. It use CSS 3 transform operation to scale down and up any kind of html content.
## Getting Started
Download the [production version][min] or the [development version][max].
[min]: https://raw.github.com/SimonBoudrias/jquery.3dish-slider/master/dist/jquery.3dish-slider.min.js
[max]: https://raw.github.com/SimonBoudrias/jquery.3dish-slider/master/dist/jquery.3dish-slider.js
In your web page:
```html
```
## Documentation
### Initialize
To initialize Threedish, just call on any element.
```javascript
$('.slider').ThreeDish();
```
You can of course chain other jQuery function afterward and pass personnalized option to the plugins (those will be explain later).
Initializing ThreeDish will only set up default style and create an instance of Threedish. It will not add any button; this is up to you using the [methods below](https://github.com/SBoudrias/jquery.3dish-slider#methods).
### Methods
You can call pretty basic method on a ThreeDish instance.
####next
```javascript
$('.slider').ThreeDish('next');
```
Move the slides forward
####prev
```javascript
$('.slider').ThreeDish('prev');
```
Move the slides backward
####goTo
```javascript
$('.slider').ThreeDish('goTo', '.className');
// the selector could be [name=myslide] or any valid jQuery selector
```
Move the slides to the first slide corresponding to the jQuery selector passed as argument.
####append
```javascript
$('.slider').ThreeDish('append', $('
'));
```
Append any jQuery element to the slider. Ideally, you'd have to give this new element the same class name as the other slides.
### Options
_(Coming soon)_
## Examples
_(Coming soon)_
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt).
_Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "src" subdirectory!_
## Release History
_(Nothing yet)_
## License
Copyright (c) 2012 Simon Boudrias
Licensed under the MIT, GPL licenses.