Permalink
Browse files

Updating some files.

  • Loading branch information...
1 parent be5cada commit 748a654c8f49de7408f3617e87ad5da01469acbf @wbotelhos committed Feb 28, 2013
Showing with 95 additions and 87 deletions.
  1. +0 −4 .gitignore
  2. +0 −79 README.markdown
  3. +91 −0 README.md
  4. +4 −4 changelog.markdown → changelog.md
View
@@ -1,6 +1,2 @@
*.zip
.DS_Store
-.project
-.settings
-annotations.txt
-test/runner.htm
View
@@ -1,79 +0,0 @@
-# jQuery Stepy - A Wizard Plugin - http://wbotelhos.com/stepy
-
-jQuery Stepy is a plugin based on FormToWizard that generates a customizable wizard.
-
-## Version
-
- @version 1.1.0
- @since 2010.07.03
- @author Washington Botelho
- @documentation wbotelhos.com/stepy
- @twitter twitter.com/wbotelhos
-
-## Required Files
-
-+ jquery.stepy.min.js
-+ jquery.stepy.css
-
-## Default values
-
- back: undefined // Callback before the backward action.
- backLabel: '< Back' // Change the back button label.
- block: false // Block the next step if the current is invalid.
- description: false // Choose if the descriptions of the titles will be showed.
- errorImage: false // If an error occurs, a image is showed in the title of the corresponding step.
- finish: undefined // Callback before the finish action.
- finishButton: true // Include the button with class called '.finish' into the last step.
- ignore: '' // Choose the fields to be ignored on validation.
- legend: false // Choose if the legends of the steps will be showed.
- nextLabel: 'Next >' // Change the next button label.
- next: undefined // Callback before the forward action.
- titleClick: true // Active the back and next action in the titles.
- titleTarget: undefined // Choose the place where titles will be placed.
- select: undefined // Callback executed when the step is shown.
- validate: false // Active the jQuery Validation for each step.
- transition: 'hide' // Use transition between steps ('hide', 'fade' or 'slide').
- duration: 0 // Duration of the transition between steps in ms.
-
-## Usage with default values
-
- $('#step').stepy();
-
- <form id="step">
- <fieldset title="Step 1">
- <legend>description one</legend>
- <!-- input fields -->
- </fieldset>
-
- <fieldset title="Step 2">
- <legend>description two</legend>
- <!-- input fields -->
- </fieldset>
-
- <input type="submit" class="finish"/>
- </form>
-
-## Public functions
-
- $('#step').stepy('step', 2); // Change the form to the second step.
-
-## Contributors:
-
-+ Almir Mendes
-+ Andrey Fedoseev
-+ Igor Tamashchuk
-+ Rafael Machado
-
-The MIT License
-
-Copyright (c) 2012 Washington Botelho
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-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.
-
-## Buy me a coffee
-
-You can do it by [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=jQuery%20Stepy). Thanks! (:
View
@@ -0,0 +1,91 @@
+# jQuery Stepy - A Wizard Plugin - [wbotelhos.com/stepy](http://wbotelhos.com/stepy)
+
+jQuery Stepy is a plugin based on FormToWizard that generates a customizable wizard.
+
+## Version
+
+```
+@version 1.1.0
+@since 2010-07-03
+@author Washington Botelho
+@documentation wbotelhos.com/stepy
+@twitter twitter.com/wbotelhos
+```
+
+## Required Files
+
++ jquery.stepy.min.js
++ jquery.stepy.css
+
+## Options
+
+```js
+back : undefined // Callback before the backward action.
+backLabel : '< Back' // Change the back button label.
+block : false // Block the next step if the current is invalid.
+description : false // Choose if the descriptions of the titles will be showed.
+duration : 0 // Duration of the transition between steps in ms.
+errorImage : false // If an error occurs, a image is showed in the title of the corresponding step.
+finish : undefined // Callback before the finish action.
+finishButton : true // Include the button with class called '.finish' into the last step.
+ignore : '' // Choose the fields to be ignored on validation.
+legend : false // Choose if the legends of the steps will be showed.
+next : undefined // Callback before the forward action.
+nextLabel : 'Next >' // Change the next button label.
+select : undefined // Callback executed when the step is shown.
+titleClick : true // Active the back and next action in the titles.
+titleTarget : undefined // Choose the place where titles will be placed.
+transition : 'hide' // Use transition between steps ('hide', 'fade' or 'slide').
+validate : false // Active the jQuery Validation for each step.
+```
+
+## Usage
+
+```html
+<form>
+ <fieldset title="Step 1">
+ <legend>description one</legend>
+ <!-- inputs -->
+ </fieldset>
+
+ <fieldset title="Step 2">
+ <legend>description two</legend>
+ <!-- inputs -->
+ </fieldset>
+
+ <input type="submit" class="finish" />
+</form>
+```
+
+```js
+$('form').stepy();
+```
+
+## Functions
+
+```js
+$('form').stepy('step', 2); // Changes the form to the second step.
+```
+
+## Contributors
+
++ Almir Mendes
++ Andrey Fedoseev
++ Igor Tamashchuk
++ Rafael Machado
+
+## Licence
+
+The MIT License
+
+Copyright (c) 2012 Washington Botelho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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.
+
+## Donate
+
+You can do it via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=jQuery%20Stepy). Thanks! (:
@@ -5,7 +5,7 @@
+ Added 'ignore' option to choose the fields to be ignored on validation:
- It must be blank '' to override jQuery Validation 1.9.0 default value and avoid error;
- I hope my fix be accepted, then this option may be used freely;
- - But, you never can use ':hidden' as the do, because Wizards needs to validate hidden steps/fields. (;
+ - But, you never can use ':hidden' as the do, because Wizards needs to validate hidden steps/fields. (;
+ Fixed the index number given to Stepy binded by class without id.
### 1.0.0
@@ -24,7 +24,7 @@
+ Fixed the focus of the first error field (reported by luckyong);
+ Avoided highlight only the first field when has multiple invalids fields on the form.
-
+
### 0.5.0
+ Added the 'titleTarget' attribute to choose the place where titles will be placed;
@@ -70,7 +70,7 @@
+ All the code was refactored and improved.
### 0.1
-
+
+ Added a backLabel and nextLabel parameter to specify the labels of the corresponding buttons;
+ Added click on the title and description to go to the corresponding step;
+ Added a public function 'step' that is possible choose which step to go;
@@ -87,4 +87,4 @@
+ Changed the selectors for the same current element $(this);
+ Changed the extends to a defaults developers plugins;
+ Keys were placed on single line blocks to avoid error on IE;
-+ Changed the styles name with a hifen style;
++ Changed the styles name with a hifen style;

0 comments on commit 748a654

Please sign in to comment.