diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 00000000..67680055 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,50 @@ +# Javascript Node CircleCI 2.0 configuration file +# +# Check https://circleci.com/docs/2.0/language-javascript/ for more details +# +version: 2 +jobs: + build: + docker: + # specify the version you desire here + - image: circleci/node:8 + + # Specify service dependencies here if necessary + # CircleCI maintains a library of pre-built images + # documented at https://circleci.com/docs/2.0/circleci-images/ + # - image: circleci/mongo:3.4.4 + + working_directory: ~/repo + + steps: + - checkout + + - run: + name: "Checking Versions" + command: | + node --version + npm --version + + - run: + name: update-npm + command: 'sudo npm install -g npm@latest' + + # Download and cache dependencies + - restore_cache: + key: dependency-cache-{{ checksum "package.json" }} + + - run: npm install + + - save_cache: + key: dependency-cache-{{ checksum "package.json" }} + paths: + - ./node_modules + + - run: + name: "Checking Versions" + command: | + node --version + npm --version + + # run tests! + - run: grunt test diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 00000000..5c8b7758 --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,346 @@ +module.exports = { + "env": { + "browser": true, + "jquery": true, + "node": true, + "amd": true + }, + "parserOptions": { + "ecmaVersion": 5, + "sourceType": "script" + }, + "extends": "eslint:recommended", + "rules": { + "array-bracket-spacing": [ + "warn", + "never" + ], + "array-callback-return": "warn", + "arrow-body-style": "error", + "arrow-parens": "error", + "arrow-spacing": "error", + "block-scoped-var": "warn", + "block-spacing": [ + "warn", + "always" + ], + "brace-style": [ + "error", + "1tbs" + ], + "callback-return": "error", + "camelcase": [ + "warn", + { "properties": "always" } + ], + "class-methods-use-this": "error", + "comma-dangle": [ + "error", + "never" + ], + "comma-spacing": "error", + "comma-style": "error", + "complexity": [ + "warn", + 20 + ], + "computed-property-spacing": "error", + "consistent-return": "error", + "consistent-this": [ + "error", + "that", + "outerThis", + "self" + ], + "curly": [ + "error", + "all" + ], + "default-case": "error", + "dot-location": [ + "error", + "property" + ], + "dot-notation": "error", + "eol-last": "error", + "eqeqeq": "error", + "func-call-spacing": "error", + "func-name-matching": "error", + "id-length": [ + "warn", + { "exceptions": ["$","e","i","j"] } + ], + "indent": [ + "error", + "tab" + ], + "key-spacing": [ + "warn", { + "singleLine": { + "beforeColon": false, + "afterColon": true + }, + "multiLine": { + "beforeColon": true, + "afterColon": true, + "align": "colon" + } + } + ], + "keyword-spacing": "error", + "linebreak-style": [ + "warn", + "unix" + ], + "max-depth": "warn", + "max-nested-callbacks": "error", + "max-params": [ + "warn", + { "max": 4 } + ], + "max-statements": [ + "warn", + { "max": 20 } + ], + "max-statements-per-line": [ + "error", + { "max": 2 } + ], + "multiline-ternary": [ + "error", + "never" + ], + "new-parens": "error", + "newline-per-chained-call": [ + "warn", + { "ignoreChainWithDepth": 3 } + ], + "no-alert": "error", + "no-array-constructor": "error", + "no-await-in-loop": "error", + "no-bitwise": "error", + "no-caller": "error", + "no-compare-neg-zero": "error", + "no-confusing-arrow": "error", + "no-continue": "warn", + "no-div-regex": "error", + "no-duplicate-imports": "error", + "no-else-return": [ + "error", + { "allowElseIf": false } + ], + "no-empty": [ + "error", + { "allowEmptyCatch": true } + ], + "no-empty-function": [ + "error", + { "allow": ["functions"] } + ], + "no-eq-null": "error", + "no-eval": [ + "error", + { "allowIndirect": true } + ], + "no-extend-native": "error", + "no-extra-bind": "error", + "no-extra-label": "error", + "no-extra-parens": [ + "warn", + "all", + { + "returnAssign": false, + "nestedBinaryExpressions": false + } + ], + "no-floating-decimal": "error", + "no-global-assign": "error", + "no-implicit-globals": "error", + "no-implied-eval": "error", + "no-inner-declarations": [ + "warn", + "both" + ], + "no-invalid-this": "warn", + "no-iterator": "error", + "no-label-var": "error", + "no-labels": "error", + "no-lone-blocks": "error", + "no-lonely-if": "error", + "no-loop-func": "error", + "no-magic-numbers": [ + "warn", + { + "ignore": [0,1], + "ignoreArrayIndexes": true + } + ], + "no-mixed-operators": "error", + "no-mixed-requires": "error", + "no-multi-assign": "warn", + "no-multi-spaces": "error", + "no-multi-str": "error", + "no-multiple-empty-lines": [ + "error", + { + max: 2, + maxEOF: 1, + maxBOF: 0 + } + ], + "no-negated-condition": "warn", + "no-nested-ternary": "error", + "no-new": "error", + "no-new-func": "error", + "no-new-object": "error", + "no-new-require": "error", + "no-new-wrappers": "error", + "no-octal-escape": "error", + "no-path-concat": "error", + "no-process-env": "error", + "no-process-exit": "error", + "no-proto": "error", + "no-prototype-builtins": "warn", + "no-restricted-globals": "error", + "no-restricted-imports": "error", + "no-restricted-modules": "error", + "no-restricted-properties": "error", + "no-restricted-syntax": "error", + "no-return-assign": "error", + "no-return-await": "error", + "no-script-url": "error", + "no-self-compare": "error", + "no-sequences": "error", + "no-shadow": "warn", + "no-shadow-restricted-names": "error", + "no-sync": "warn", + "no-template-curly-in-string": "error", + "no-ternary": "warn", + "no-throw-literal": "warn", + "no-trailing-spaces": "error", + "no-undef-init": "error", + "no-undefined": "warn", + "no-underscore-dangle": "error", + "no-unmodified-loop-condition": "error", + "no-unneeded-ternary": "error", + "no-unsafe-negation": "error", + "no-unused-expressions": "error", + "no-unused-vars": [ + "warn", + { + "vars": "local", + "args": "none" + } + ], + "no-use-before-define": [ + "error", + { + "functions": false + } + ], + "no-useless-call": "error", + "no-useless-computed-key": "error", + "no-useless-concat": "error", + "no-useless-constructor": "error", + "no-useless-escape": "error", + "no-useless-rename": "error", + "no-useless-return": "error", + "no-var": "warn", + "no-void": "error", + "no-warning-comments": "warn", + "no-whitespace-before-property": "error", + "no-with": "error", + "nonblock-statement-body-position": "error", + "object-curly-newline": "error", + "object-curly-spacing": [ + "error", + "never", + { + "arraysInObjects": true, + "objectsInObjects": true + } + ], + "object-property-newline": [ + "error", + { + "allowMultiplePropertiesPerLine": true + } + ], + "object-shorthand": [ + "warn", + "consistent" + ], + "operator-assignment": [ + "error", + "always" + ], + "operator-linebreak": "error", + "padding-line-between-statements": [ + "warn", + { "blankLine": "always", "prev": ["const", "let", "var"], "next": "*"}, + { "blankLine": "any", "prev": ["const", "let", "var"], "next": ["const", "let", "var"]}, + { "blankLine": "always", "prev": "directive", "next": "*" }, + { "blankLine": "any", "prev": "directive", "next": "directive" }, + { "blankLine": "always", "prev": "*", "next": "return" } + ], + "prefer-const": "error", + "prefer-promise-reject-errors": "error", + "quote-props": [ + "warn", + "consistent-as-needed" + ], + "quotes": [ + "error", + "single", + { + "avoidEscape": true, + "allowTemplateLiterals": true + } + ], + "radix": "error", + "require-await": "error", + "rest-spread-spacing": "error", + "semi": [ + "error", + "always" + ], + "semi-spacing": "error", + "sort-imports": "error", + "sort-keys": "warn", + "sort-vars": "warn", + "space-before-blocks": "warn", + "space-before-function-paren": [ + "warn", + { + "anonymous": "ignore", + "named": "never", + "asyncArrow": "ignore" + } + ], + "space-in-parens": "warn", + "space-infix-ops": "error", + "space-unary-ops": "error", + "spaced-comment": ["error", "always", { + "line": { + "markers": ["/"], + "exceptions": ["-", "+"] + }, + "block": { + "markers": ["!"], + "exceptions": ["*"], + "balanced": true + } + }], + "strict": [ + "warn", + "function" + ], + "template-curly-spacing": "error", + "template-tag-spacing": "error", + "unicode-bom": "error", + "vars-on-top": "warn", + "wrap-iife": "error", + "yield-star-spacing": "error", + "yoda": "error" + } +}; diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 00000000..9ef70fb6 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,17 @@ +Please review [Instructions for Reporting a Bug](https://github.com/jquery-form/form/blob/master/CONTRIBUTING.md#reporting-a-bug). + +### Description: + +### Expected Behavior: + +### Actual behavior: + +### Versions: +**LoadJSON:** +**jQuery:** +**Browsers:** + +### Demonstration +Link to demonstration of issue in [JSFiddle](https://jsfiddle.net/) or [CodePen](https://codepen.io/): + +### Steps to reproduce: diff --git a/.gitignore b/.gitignore index a7930eb2..efeb816b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,298 +1,229 @@ -################# -## Development Environment -################# +# Created by https://www.gitignore.io/api/composer,git,laravel,macos,node,phpstorm,pycharm,sublimetext,vim,visualstudiocode,webstorm,windows +# Edit at https://www.gitignore.io/?templates=composer,git,laravel,macos,node,phpstorm,pycharm,sublimetext,vim,visualstudiocode,webstorm,windows + +### Composer ### +composer.phar +.composer/auth.json +vendor/ + +### Git ### +*.orig + +# Created by git when using merge tools for conflicts +*.BACKUP.* +*.BASE.* +*.LOCAL.* +*.REMOTE.* +*_BACKUP_*.txt +*_BASE_*.txt +*_LOCAL_*.txt +*_REMOTE_*.txt + +### Laravel ### +node_modules/ +npm-debug.log +_ide_helper.php + +# Laravel 4 specific +bootstrap/compiled.php +app/storage/ + +# Laravel 5 & Lumen specific +public/storage +public/hot +storage/*.key +.env +Homestead.yaml +Homestead.json +config.cnf +config_open_data.cnf +/.vagrant +Vagrantfile + +# Rocketeer PHP task runner and deployment package. https://github.com/rocketeers/rocketeer +.rocketeer/ + +# PHPUnit +*.cache +/ci + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride -cache/ -deploy.txt -.svn -prepros.cfg +# Icon must end with two \r +Icon -# Node -node_modules +# Thumbnails +._* -# SASS Cache -*.scssc +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### Node ### +# Logs +logs +*.log +npm-debug.log* +# Runtime data +pids +*.pid +*.seed +*.pid.lock -############# -## OS generated files -############# +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release -# Windows image file caches -Thumbs.db -ehthumbs.db +# Optional npm cache directory +.npm -# Folder config file -Desktop.ini +# Optional eslint cache +.eslintcache -# Recycle Bin used on file shares -$RECYCLE.BIN/ +# Optional REPL history +.node_repl_history -# Mac crap -.DS_Store -.DS_Store? -._* -.Spotlight-V100 -.Trashes +# Output of 'npm pack' +*.tgz +### PhpStorm ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 -################# -## Compiled source -################# +# User-specific stuff +.idea/ -*.com -*.class -*.dll -*.exe -*.o -*.so +# CMake +cmake-build-*/ +# File-based project format +*.iws -################# -## Packages -################# +# IntelliJ +out/ -# it's better to unpack these files and commit the raw source -# git has its own built in compression methods -*.7z -*.dmg -*.gz -*.iso -*.jar -*.rar -*.tar -*.zip +# mpeltonen/sbt-idea plugin +.idea_modules/ +# JIRA plugin +atlassian-ide-plugin.xml -################# -## Logs and databases -################# +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties -*.log -*.sql -*.sqlite +### PhpStorm Patch ### +# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 +# *.iml +# modules.xml +# *.ipr -################# -## SublimeText -################# +### PyCharm ### -# cache files for sublime text +# Generated files +/tools/*.pyc + +### SublimeText ### +# Cache files for Sublime Text *.tmlanguage.cache *.tmPreferences.cache *.stTheme.cache -# workspace files are user-specific +# Workspace files are user-specific *.sublime-workspace - -# project files *.sublime-project -# sftp configuration file -sftp-config.json +# SFTP configuration file +sftp-config.json -################# -## Dreamweaver -################# - -_notes -*dwsync.xml -_includes/spry - - -################# -## Eclipse -################# - -*.pydevproject -.project -.metadata -bin/ -tmp/ -*.tmp -*.bak -*.swp -*~.nib -local.properties -.classpath -.settings -.loadpath - -# External tool builders -.externalToolBuilders/ - -# Locally stored "Eclipse launch configurations" -*.launch - -# CDT-specific -.cproject - -# PDT-specific -.buildpath - - -################# -## Visual Studio -################# - -## Ignore Visual Studio temporary files, build results, and -## files generated by popular Visual Studio add-ons. - -# User-specific files -*.suo -*.user -*.sln.docstates - -# Build results - -[Dd]ebug/ -[Rr]elease/ -x64/ -build/ -[Bb]in/ -[Oo]bj/ - -# MSTest test Results -[Tt]est[Rr]esult*/ -[Bb]uild[Ll]og.* - -*_i.c -*_p.c -*.ilk -*.meta -*.obj -*.pch -*.pdb -*.pgc -*.pgd -*.rsp -*.sbr -*.tlb -*.tli -*.tlh -*.tmp -*.tmp_proj -*.vspscc -*.vssscc -.builds -*.pidb -*.scc - -# Visual C++ cache files -ipch/ -*.aps -*.ncb -*.opensdf -*.sdf -*.cachefile - -# Visual Studio profiler -*.psess -*.vsp -*.vspx - -# Guidance Automation Toolkit -*.gpState - -# ReSharper is a .NET coding add-in -_ReSharper*/ -*.[Rr]e[Ss]harper - -# TeamCity is a build add-in -_TeamCity* - -# DotCover is a Code Coverage Tool -*.dotCover - -# NCrunch -*.ncrunch* -.*crunch*.local.xml - -# Installshield output folder -[Ee]xpress/ - -# DocProject is a documentation generator add-in -DocProject/buildhelp/ -DocProject/Help/*.HxT -DocProject/Help/*.HxC -DocProject/Help/*.hhc -DocProject/Help/*.hhk -DocProject/Help/*.hhp -DocProject/Help/Html2 -DocProject/Help/html - -# Click-Once directory -publish/ - -# Publish Web Output -*.Publish.xml -*.pubxml -*.publishproj - -# NuGet Packages Directory -## TODO: If you have NuGet Package Restore enabled, uncomment the next line -#packages/ - -# Windows Azure Build Output -csx -*.build.csdef - -# Windows Store app package directory -AppPackages/ - -# Others -sql/ -*.Cache -ClientBin/ -[Ss]tyle[Cc]op.* -~$* +# Package control specific files +Package Control.last-run +Package Control.ca-list +Package Control.ca-bundle +Package Control.system-ca-bundle +Package Control.cache/ +Package Control.ca-certs/ +Package Control.merged-ca-bundle +Package Control.user-ca-bundle +oscrypto-ca-bundle.crt +bh_unicode_properties.cache + +# Sublime-github package stores a github token in this file +# https://packagecontrol.io/packages/sublime-github +GitHub.sublime-settings + +### Vim ### +# Swap +[._]*.s[a-v][a-z] +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] + +# Session +Session.vim + +# Temporary +.netrwhist *~ -*.dbmdl -*.[Pp]ublish.xml -*.pfx -*.publishsettings - -# RIA/Silverlight projects -Generated_Code/ - -# Backup & report files from converting an old project file to a newer -# Visual Studio version. Backup files are not needed, because we have git ;-) -_UpgradeReport_Files/ -Backup*/ -UpgradeLog*.XML -UpgradeLog*.htm - -# SQL Server files -App_Data/*.mdf -App_Data/*.ldf - - -############# -## Python -############# - -*.py[cod] - -# Packages -*.egg -*.egg-info -build/ -eggs/ -parts/ -var/ -sdist/ -develop-eggs/ -.installed.cfg - -# Installer logs -pip-log.txt - -# Unit test / coverage reports -.coverage -.tox - -#Translations -*.mo - -#Mr Developer -.mr.developer.cfg +# Auto-generated tag files +tags +# Persistent undo +[._]*.un~ + +### VisualStudioCode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +### VisualStudioCode Patch ### +# Ignore all local history of files +.history + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# End of https://www.gitignore.io/api/composer,git,laravel,macos,node,phpstorm,pycharm,sublimetext,vim,visualstudiocode,webstorm,windows diff --git a/.travis.yml b/.travis.yml index 538c4baa..8392a2a5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,11 @@ language: node_js node_js: - - "node" -before_install: - - npm install grunt-cli -g + - "10" script: - grunt test +cache: + bundler: true + directories: + - "node_modules" # NPM packages +before_install: + - if [[ `npm -v ` != 5* ]]; then npm i -g npm@5; fi diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bcb67aa..a603da09 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,9 @@ Want to contribute to jQuery Form? That's great! Contributions are most welcome! Here are a couple of guidelines that will help you contribute. Before we get started: Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to ensure that this project is a welcoming place for **everyone** to contribute to. By participating in this project you agree to abide by its terms. #### Overview + * [Contribution workflow](#contribution-workflow) +* [Testing](#testing) * [Reporting a bug](#reporting-a-bug) * [Contributing to an existing issue](#contributing-to-an-existing-issue) * [Feature Requests](#feature-requests) @@ -12,33 +14,65 @@ Here are a couple of guidelines that will help you contribute. Before we get sta ## Contribution workflow -* Fork the repository in GitHub with the `Fork` button. -* Switch to a new branch (ie. `new-feature`), and work from there: +1. Fork the repository in GitHub with the `Fork` button. +2. Switch to a new branch (ie. `new-feature`), and work from there: `git checkout -b new-feature` -* Make your feature addition or bug fix. -* Send a pull request (PR). Bonus points for topic branches. +3. Make your feature addition or bug fix. +4. After setting up your [testing enviroment](#testing), run the tests: + + ```shell + grunt test + ``` + + If the tests all pass, move on to step 5. + +5. Send a pull request (PR). Bonus points for topic branches. * Please make sure all of your commits are atomic (one feature per commit). * Use sensible commit messages. * Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this: - -```shell + ```shell $ git commit -m "A brief summary of the commit" > > A paragraph describing what changed and its impact." -``` - + ``` * If your PR fixes a separate issue number, include it in the commit message. ### Things to keep in mind + * Smaller PRs are likely to be merged more quickly than bigger changes. -* If it is a useful PR it **will** get merged in eventually. +* If it is a useful PR, it **will** get merged in eventually. * This project is using [Semantic Versioning 2.0.0](http://semver.org/) +## Testing + +jQuery Form uses [Node.js](https://nodejs.org/), [Grunt](https://gruntjs.com/), [ESLint](http://eslint.org/), [Mocha](https://mochajs.org/), and [Chai](http://chaijs.com/) to automate the building and validation of source code. Here is how to set that up: + +1. Get [Node.js](https://nodejs.org/) (includes [NPM](https://www.npmjs.com/), necessary for the next step) +2. Install Grunt CLI: + + ```shell + npm install -g grunt-cli + ``` + +3. Install dependencies: + + ```shell + npm install + ``` + +4. Run the tests by opening `test/test.html` in your web browser or using Grunt: + + ```shell + grunt test + ``` + ## Reporting a bug So you've found a bug, and want to help us fix it? Before filing a bug report, please double-check the bug hasn't already been reported. You can do so [on our issue tracker](https://github.com/jquery-form/form/issues?q=is%3Aopen+is%3Aissue). If something hasn't been raised, you can go ahead and create a new issue with the following information: * Which version of the plugin are you using? +* Which version of the jQuery library are you using? +* What browsers (and versions) have you tested in? * How can the error be reproduced? * If possible, include a link to a [JSFiddle](https://jsfiddle.net/) or [CodePen](https://codepen.io/) example of the error. @@ -64,6 +98,7 @@ And if at any point you get stuck: don't hesitate to ask for help. We've outlined the contribution workflow [here](#contribution-workflow). If you're a first-timer, don't worry! GitHub has a ton of guides to help you through your first pull request: You can find out more about pull requests [here](https://help.github.com/articles/about-pull-requests/) and about creating a pull request [here](https://help.github.com/articles/creating-a-pull-request/). ## Feature Requests + * You can _request_ a new feature by [submitting an issue](https://github.com/jquery-form/form/issues). * If you would like to _implement_ a new feature: * For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. diff --git a/Gruntfile.js b/Gruntfile.js index 2141df4d..926abb55 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -5,19 +5,43 @@ module.exports = function(grunt) { banner: '/*! <%= pkg.name %> <%= grunt.template.today("yyyy-mm-dd HH:MM:ss") %> */' }, + githooks: { + options: { + hashbang: '#!/bin/sh', + template: 'install/template/shell.hb', + startMarker: '# GRUNT-GITHOOKS START', + endMarker: '# GRUNT-GITHOOKS END' + }, + all: { + 'pre-commit': 'pre-commit' + } + }, + + eslint: { + options: { + quiet: true + }, + target: ['src/**/*.js'] + }, + mocha: { all: { - src: ['test/**/*.html'], + src: ['test/*.html'] }, options: { - run: true + run: true, + growlOnSuccess: false } }, // Minifies JS files uglify: { options: { - preserveComments: /^!|@preserve|@license|@cc_on/i + output: { + comments: /^!|@preserve|@license|@cc_on/i + }, + sourceMap: true, + footer: '\n' }, dist: { files: [{ @@ -35,8 +59,12 @@ module.exports = function(grunt) { // Load tasks grunt.loadNpmTasks('grunt-contrib-uglify'); grunt.loadNpmTasks('grunt-mocha'); + grunt.loadNpmTasks('grunt-eslint'); + grunt.loadNpmTasks('grunt-githooks'); // Default task. - grunt.registerTask('test', [ 'mocha' ]); + grunt.registerTask('lint', [ 'eslint' ]); + grunt.registerTask('test', [ 'lint', 'mocha' ]); + grunt.registerTask('pre-commit', [ 'test' ]); grunt.registerTask('default', [ 'test', 'uglify' ]); }; diff --git a/LICENSE b/LICENSE index bade8ab7..19e30718 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,504 @@ -MIT License - -Copyright (c) 2017 jquery-form - -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. + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +(This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.) + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + + {signature of Ty Coon}, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/LICENSE-LGPLv3 b/LICENSE-LGPLv3 deleted file mode 100644 index 02bbb60b..00000000 --- a/LICENSE-LGPLv3 +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. \ No newline at end of file diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 00000000..bade8ab7 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 jquery-form + +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. diff --git a/README.md b/README.md index 9d4218ed..e506fc09 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,48 @@ -#jQuery Form +# jQuery Form [![Build Status](https://travis-ci.org/jquery-form/form.svg?branch=master)](https://travis-ci.org/jquery-form/form) -##Overview -The jQuery Form Plugin allows you to easily and unobtrusively upgrade HTML forms to use AJAX. The main methods, ajaxForm and ajaxSubmit, gather information from the form element to determine how to manage the submit process. Both of these methods support numerous options which allows you to have full control over how the data is submitted. +## Overview +The jQuery Form Plugin allows you to easily and unobtrusively upgrade HTML forms to use AJAX. The main methods, ajaxForm and ajaxSubmit, gather information from the form element to determine how to manage the submit process. Both of these methods support numerous options which allow you to have full control over how the data is submitted. No special markup is needed, just a normal form. Submitting a form with AJAX doesn't get any easier than this! -##Community +## Community Want to contribute to jQuery Form? Awesome! See [CONTRIBUTING](CONTRIBUTING.md) for more information. -###Code of Conduct +### Code of Conduct Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to ensure that this project is a welcoming place for **everyone** to contribute to. By participating in this project you agree to abide by its terms. -##Requirements -Requires jQuery 1.7+. +### Pull Requests Needed +#### Enhancements needed to to be fully compatible with jQuery 3 +jQuery 3 is removing a lot of features that have been deprecated for a long time. Some of these are still in use by jQuery Form. +Pull requests and assistance in updating jQuery Form to be compatible with jQuery 3 are greatly appreciated. +See [issue #544](https://github.com/jquery-form/form/issues/544) for more information. -##Download +## Compatibility +* Requires jQuery 1.7.2 or later. +* Compatible with jQuery 2. +* Partially compatible with jQuery 3. +* **Not** compatible with jQuery 3 Slim. ([issue #544](https://github.com/jquery-form/form/issues/544)) + +## Download * **Development:** [src/jquery.form.js ](https://github.com/jquery-form/form/blob/master/src/jquery.form.js) * **Production/Minified:** [dist/jquery.form.min.js ](https://github.com/jquery-form/form/blob/master/dist/jquery.form.min.js) -###CDN +### CDN +```html + +``` +or ```html - + ``` --- -##API +## API -###jqXHR +### jqXHR The jqXHR object is stored in element data-cache with the jqxhr key after each ajaxSubmit call. It can be accessed like this: @@ -42,38 +55,38 @@ xhr.done(function() { }); ```` -###ajaxForm( options ) +### ajaxForm( options ) Prepares a form to be submitted via AJAX by adding all of the necessary event listeners. It does **not** submit the form. Use `ajaxForm` in your document's `ready` function to prepare existing forms for AJAX submission, or with the `delegation` option to handle forms not yet added to the DOM. Use ajaxForm when you want the plugin to manage all the event binding for you. ````javascript // prepare all forms for ajax submission $('form').ajaxForm({ - target: '#myResultsDiv' + target: '#myResultsDiv' }); ```` -###ajaxSubmit( options ) +### ajaxSubmit( options ) Immediately submits the form via AJAX. In the most common use case this is invoked in response to the user clicking a submit button on the form. Use ajaxSubmit if you want to bind your own submit handler to the form. ````javascript // bind submit handler to form $('form').on('submit', function(e) { - e.preventDefault(); // prevent native submit - $(this).ajaxSubmit({ - target: 'myResultsDiv' - }) + e.preventDefault(); // prevent native submit + $(this).ajaxSubmit({ + target: '#myResultsDiv' + }) }); ```` --- -##Options +## Options **Note:** All standard [$.ajax](http://api.jquery.com/jQuery.ajax) options can be used. -###beforeSerialize -Callback function invoked prior to form serialization. Provides an opportunity to manipulate the form before its values are retrieved. Returning `false` from the callback will prevent the form from being submitted. The callback is invoked with two arguments: the jQuery wrapped form object and the options object. +### beforeSerialize +Callback function invoked before form serialization. Provides an opportunity to manipulate the form before its values are retrieved. Returning `false` from the callback will prevent the form from being submitted. The callback is invoked with two arguments: the jQuery wrapped form object and the options object. ````javascript beforeSerialize: function($form, options) { @@ -81,8 +94,8 @@ beforeSerialize: function($form, options) { } ```` -###beforeSubmit -Callback function invoked prior to form submission. Returning `false` from the callback will prevent the form from being submitted. The callback is invoked with three arguments: the form data in array format, the jQuery wrapped form object, and the options object. +### beforeSubmit +Callback function invoked before form submission. Returning `false` from the callback will prevent the form from being submitted. The callback is invoked with three arguments: the form data in array format, the jQuery wrapped form object, and the options object. ````javascript beforeSubmit: function(arr, $form, options) { @@ -92,35 +105,44 @@ beforeSubmit: function(arr, $form, options) { } ```` -###filtering +### beforeFormUnbind +Callback function invoked before form events unbind and bind again. Provides an opportunity to manipulate the form before events will be remounted. The callback is invoked with two arguments: the jQuery wrapped form object and the options object. + +````javascript +beforeFormUnbind: function($form, options) { + // your callback code +} +```` + +### filtering Callback function invoked before processing fields. This provides a way to filter elements. ````javascript filtering: function(el, index) { - if ( !$(el).hasClass('ignore') ) { - return el; - } + if ( !$(el).hasClass('ignore') ) { + return el; + } } ```` -###clearForm +### clearForm Boolean flag indicating whether the form should be cleared if the submit is successful -###data +### data An object containing extra data that should be submitted along with the form. ```` data: { key1: 'value1', key2: 'value2' } ```` -###dataType +### dataType Expected data type of the response. One of: null, 'xml', 'script', or 'json'. The dataType option provides a means for specifying how the server response should be handled. This maps directly to jQuery's dataType method. The following values are supported: * 'xml': server response is treated as XML and the 'success' callback method, if specified, will be passed the responseXML value -* 'json': server response will be evaluted and passed to the 'success' callback, if specified +* 'json': server response will be evaluated and passed to the 'success' callback, if specified * 'script': server response is evaluated in the global context -###delegation +### delegation true to enable support for event delegation *requires jQuery v1.7+* @@ -131,46 +153,52 @@ $('form').ajaxForm({ }); ```` -###error +### error +**Deprecated** Callback function to be invoked upon error. -###forceSync -Only applicable when explicity using the iframe option or when uploading files on browses that don't support XHR2. -Set to `true` to remove the short delay before posting form when uploading files. The delay is used to allow the browser to render DOM updates prior to performing a native form submit. This improves usability when displaying notifications to the user, such as "Please Wait..." +### forceSync +Only applicable when explicity using the iframe option or when uploading files on browsers that don't support XHR2. +Set to `true` to remove the short delay before posting form when uploading files. The delay is used to allow the browser to render DOM updates before performing a native form submit. This improves usability when displaying notifications to the user, such as "Please Wait..." -###iframe +### iframe Boolean flag indicating whether the form should *always* target the server response to an iframe instead of leveraging XHR when possible. -###iframeSrc +### iframeSrc String value that should be used for the iframe's src attribute when an iframe is used. -###iframeTarget -Identifies the iframe element to be used as the response target for file uploads. By default, the plugin will create a temporary iframe element to capture the response when uploading files. This options allows you to use an existing iframe if you wish. When using this option the plugin will make no attempt at handling the response from the server. +### iframeTarget +Identifies the iframe element to be used as the response target for file uploads. By default, the plugin will create a temporary iframe element to capture the response when uploading files. This option allows you to use an existing iframe if you wish. When using this option the plugin will not attempt handling the response from the server. + +### method +The HTTP method to use for the request (e.g. 'POST', 'GET', 'PUT'). -###replaceTarget -Optionally used along with the the target option. Set to true if the target should be replaced or false if only the target contents should be replaced. +### replaceTarget +Optionally used along with the target option. Set to true if the target should be replaced or false if only the target contents should be replaced. -###resetForm +### resetForm Boolean flag indicating whether the form should be reset if the submit is successful -###semantic -Boolean flag indicating whether data must be submitted in strict semantic order (slower). Note that the normal form serialization is done in semantic order with the exception of input elements of `type="image"`. You should only set the semantic option to true if your server has strict semantic requirements and your form contains an input element of `type="image"`. +### semantic +Boolean flag indicating whether data must be submitted in strict semantic order (slower). Note that the normal form serialization is done in semantic order except for input elements of `type="image"`. You should only set the semantic option to true if your server has strict semantic requirements and your form contains an input element of `type="image"`. -###success -Callback function to be invoked after the form has been submitted. If a `success` callback function is provided it is invoked after the response has been returned from the server. It is passed the following arguments: +### success +**Deprecated** +Callback function to be invoked after the form has been submitted. If a 'success' callback function is provided it is invoked after the response has been returned from the server. It is passed the following standard jQuery arguments: -1. responseText or responseXML value (depending on the value of the dataType option). -2. statusText -3. xhr (or the jQuery-wrapped form element if using jQuery < 1.4) -4. jQuery-wrapped form element (or undefined if using jQuery < 1.4) +1. `data`, formatted according to the dataType parameter or the dataFilter callback function, if specified +2. `textStatus`, string +3. `jqXHR`, object +4. `$form` jQuery object containing form element -###target +### target Identifies the element(s) in the page to be updated with the server response. This value may be specified as a jQuery selection string, a jQuery object, or a DOM element. -###type -The method in which the form data should be submitted, 'GET' or 'POST'. +### type +The HTTP method to use for the request (e.g. 'POST', 'GET', 'PUT'). +An alias for `method` option. Overridden by the `method` value if both are present. -###uploadProgress +### uploadProgress Callback function to be invoked with upload progress information (if supported by the browser). The callback is passed the following arguments: 1. event; the browser event @@ -178,55 +206,55 @@ Callback function to be invoked with upload progress information (if supported b 3. total (integer) 4. percentComplete (integer) -###url +### url URL to which the form data will be submitted. --- -##Utility Methods -###formSerialize +## Utility Methods +### formSerialize Serializes the form into a query string. This method will return a string in the format: `name1=value1&name2=value2` ````javascript var queryString = $('#myFormId').formSerialize(); ```` -###fieldSerialize +### fieldSerialize Serializes field elements into a query string. This is handy when you need to serialize only part of a form. This method will return a string in the format: `name1=value1&name2=value2` ````javascript var queryString = $('#myFormId .specialFields').fieldSerialize(); ```` -###fieldValue +### fieldValue Returns the value(s) of the element(s) in the matched set in an array. This method always returns an array. If no valid value can be determined the array will be empty, otherwise it will contain one or more values. -###resetForm +### resetForm Resets the form to its original state by invoking the form element's native DOM method. -###clearForm -Clears the form elements. This method emptys all of the text inputs, password inputs and textarea elements, clears the selection in any select elements, and unchecks all radio and checkbox inputs. It does *not* clear hidden field values. +### clearForm +Clears the form elements. This method empties all of the text inputs, password inputs and textarea elements, clears the selection in any select elements, and unchecks all radio and checkbox inputs. It does *not* clear hidden field values. -###clearFields +### clearFields Clears selected field elements. This is handy when you need to clear only a part of the form. --- -##File Uploads -The Form Plugin supports use of [XMLHttpRequest Level 2]("http://www.w3.org/TR/XMLHttpRequest/") and [FormData](https://developer.mozilla.org/en/XMLHttpRequest/FormData) objects on browsers that support these features. As of today (March 2012) that includes Chrome, Safari, and Firefox. On these browsers (and future Opera and IE10) files uploads will occur seamlessly through the XHR object and progress updates are available as the upload proceeds. For older browsers, a fallback technology is used which involves iframes. [More Info](http://malsup.com/jquery/form/#file-upload) +## File Uploads +The Form Plugin supports the use of [XMLHttpRequest Level 2]("http://www.w3.org/TR/XMLHttpRequest/") and [FormData](https://developer.mozilla.org/en/XMLHttpRequest/FormData) objects on browsers that support these features. As of today (March 2012) that includes Chrome, Safari, and Firefox. On these browsers (and future Opera and IE10) files uploads will occur seamlessly through the XHR object and progress updates are available as the upload proceeds. For older browsers, a fallback technology is used which involves iframes. [More Info](http://malsup.com/jquery/form/#file-upload) --- -##Contributors +## Contributors This project has transferred from [github.com/malsup/form](https://github.com/malsup/form/), courtesy of [Mike Alsup](https://github.com/malsup). See [CONTRIBUTORS](CONTRIBUTORS.md) for details. -##License +## License -This project is dual licensed under the MIT and LGPLv3 licenses: +This project is dual-licensed under the LGPLv2.1 (or later) or MIT licenses: -* [MIT](LICENSE) -* [GNU Lesser General Public License v3.0](LICENSE-LGPLv3) +* [GNU Lesser General Public License v2.1](LICENSE) +* [MIT](LICENSE-MIT) --- diff --git a/bower.json b/bower.json index b49cae0c..a094bc73 100644 --- a/bower.json +++ b/bower.json @@ -3,7 +3,7 @@ "description": "The jQuery Form Plugin allows you to easily and unobtrusively upgrade HTML forms to use AJAX.", "main": "src/jquery.form.js", "moduleType": [ "globals", "amd", "node" ], - "license": "(MIT OR LGPL-3.0)", + "license": "(LGPL-2.1+ OR MIT)", "ignore": [ "README.md", "composer.json", @@ -20,6 +20,6 @@ "url": "https://github.com/jquery-form/form.git" }, "dependencies": { - "jquery": ">=1.7 <3" + "jquery": ">=1.7.2" } } diff --git a/composer.json b/composer.json index 82cb6e19..f5bd7ed0 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "description": "The jQuery Form Plugin allows you to easily and unobtrusively upgrade HTML forms to use AJAX.", "keywords": [ "jquery", "ajax", "jquery-plugin", "json", "json-form", "html-form", "form", "jquery-form" ], "homepage": "https://github.com/jquery-form/form", - "license": "(MIT OR LGPL-3.0)", + "license": "(LGPL-2.1+ OR MIT)", "authors": [ { "name": "Kevin Morris" }, { "name": "Mike Alsup" } @@ -12,7 +12,7 @@ "issues": "https://github.com/jquery-form/form/issues" }, "require": { - "components/jquery": ">=1.7 <3" + "components/jquery": ">=1.7.2" }, "extra": { "component": { diff --git a/dist/jquery.form.min.js b/dist/jquery.form.min.js index 0e2ca4db..31ce43b2 100644 --- a/dist/jquery.form.min.js +++ b/dist/jquery.form.min.js @@ -1,11 +1,23 @@ /*! * jQuery Form Plugin - * version: 4.0.1 - * Requires jQuery v1.7 or later + * version: 4.3.0 + * Requires jQuery v1.7.2 or later + * Project repository: https://github.com/jquery-form/form + * Copyright 2017 Kevin Morris * Copyright 2006 M. Alsup - * Project repository: https://github.com/jquery-form/form - * Dual licensed under the MIT and LGPLv3 licenses. + + * Dual licensed under the LGPL-2.1+ or MIT licenses * https://github.com/jquery-form/form#license + + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. */ -!function(a){"use strict";"function"==typeof define&&define.amd&&define(["jquery"],a),a("undefined"!=typeof module?require("jquery"):"undefined"!=typeof jQuery?jQuery:window.Zepto)}(function(a){"use strict";function b(b){var c=b.data;b.isDefaultPrevented()||(b.preventDefault(),a(b.target).closest("form").ajaxSubmit(c))}function c(b){var c=b.target,d=a(c);if(!d.is("[type=submit],[type=image]")){var e=d.closest("[type=submit]");if(0===e.length)return;c=e[0]}var f=c.form;if(f.clk=c,"image"==c.type)if(void 0!==b.offsetX)f.clk_x=b.offsetX,f.clk_y=b.offsetY;else if("function"==typeof a.fn.offset){var g=d.offset();f.clk_x=b.pageX-g.left,f.clk_y=b.pageY-g.top}else f.clk_x=b.pageX-c.offsetLeft,f.clk_y=b.pageY-c.offsetTop;setTimeout(function(){f.clk=f.clk_x=f.clk_y=null},100)}function d(){if(a.fn.ajaxSubmit.debug){var b="[jquery.form] "+Array.prototype.join.call(arguments,"");window.console&&window.console.log?window.console.log(b):window.opera&&window.opera.postError&&window.opera.postError(b)}}var e={};e.fileapi=void 0!==a("").get(0).files,e.formdata=void 0!==window.FormData;var f=!!a.fn.prop;a.fn.attr2=function(){if(!f)return this.attr.apply(this,arguments);var a=this.prop.apply(this,arguments);return a&&a.jquery||"string"==typeof a?a:this.attr.apply(this,arguments)},a.fn.ajaxSubmit=function(b,c,g,h){function i(c){var d,e,f=a.param(c,b.traditional).split("&"),g=f.length,h=[];for(d=0;d').val(k.extraData[m].value).appendTo(x)[0]):j.push(a('').val(k.extraData[m]).appendTo(x)[0]));k.iframeTarget||p.appendTo("body"),q.attachEvent?q.attachEvent("onload",h):q.addEventListener("load",h,!1),setTimeout(b,15);try{x.submit()}catch(a){var r=document.createElement("form").submit;r.apply(x)}}finally{x.setAttribute("action",f),x.setAttribute("enctype",i),c?x.setAttribute("target",c):o.removeAttr("target"),a(j).remove()}}function h(b){if(!r.aborted&&!F){if(E=e(q),E||(d("cannot access response document"),b=A),b===z&&r)return r.abort("timeout"),void y.reject(r,"timeout");if(b==A&&r)return r.abort("server abort"),void y.reject(r,"error","server abort");if(E&&E.location.href!=k.iframeSrc||v){q.detachEvent?q.detachEvent("onload",h):q.removeEventListener("load",h,!1);var c,f="success";try{if(v)throw"timeout";var g="xml"==k.dataType||E.XMLDocument||a.isXMLDoc(E);if(d("isXml="+g),!g&&window.opera&&(null===E.body||!E.body.innerHTML)&&--G)return d("requeing onLoad callback, DOM not available"),void setTimeout(h,250);var i=E.body?E.body:E.documentElement;r.responseText=i?i.innerHTML:null,r.responseXML=E.XMLDocument?E.XMLDocument:E,g&&(k.dataType="xml"),r.getResponseHeader=function(a){var b={"content-type":k.dataType};return b[a.toLowerCase()]},i&&(r.status=Number(i.getAttribute("status"))||r.status,r.statusText=i.getAttribute("statusText")||r.statusText);var j=(k.dataType||"").toLowerCase(),l=/(json|script|text)/.test(j);if(l||k.textarea){var n=E.getElementsByTagName("textarea")[0];if(n)r.responseText=n.value,r.status=Number(n.getAttribute("status"))||r.status,r.statusText=n.getAttribute("statusText")||r.statusText;else if(l){var o=E.getElementsByTagName("pre")[0],s=E.getElementsByTagName("body")[0];o?r.responseText=o.textContent?o.textContent:o.innerText:s&&(r.responseText=s.textContent?s.textContent:s.innerText)}}else"xml"==j&&!r.responseXML&&r.responseText&&(r.responseXML=H(r.responseText));try{D=J(r,j,k)}catch(a){f="parsererror",r.error=c=a||f}}catch(a){d("error caught: ",a),f="error",r.error=c=a||f}r.aborted&&(d("upload aborted"),f=null),r.status&&(f=r.status>=200&&r.status<300||304===r.status?"success":"error"),"success"===f?(k.success&&k.success.call(k.context,D,"success",r),y.resolve(r.responseText,"success",r),m&&a.event.trigger("ajaxSuccess",[r,k])):f&&(void 0===c&&(c=r.statusText),k.error&&k.error.call(k.context,r,f,c),y.reject(r,"error",c),m&&a.event.trigger("ajaxError",[r,k,c])),m&&a.event.trigger("ajaxComplete",[r,k]),m&&!--a.active&&a.event.trigger("ajaxStop"),k.complete&&k.complete.call(k.context,r,f),F=!0,k.timeout&&clearTimeout(w),setTimeout(function(){k.iframeTarget?p.attr("src",k.iframeSrc):p.remove(),r.responseXML=null},100)}}}var i,j,k,m,n,p,q,r,t,u,v,w,x=o[0],y=a.Deferred();if(y.abort=function(a){r.abort(a)},c)for(j=0;j'),p.css({position:"absolute",top:"-1000px",left:"-1000px"})),q=p[0],r={aborted:0,responseText:null,responseXML:null,status:0,statusText:"n/a",getAllResponseHeaders:function(){},getResponseHeader:function(){},setRequestHeader:function(){},abort:function(b){var c="timeout"===b?"timeout":"aborted";d("aborting upload... "+c),this.aborted=1;try{q.contentWindow.document.execCommand&&q.contentWindow.document.execCommand("Stop")}catch(a){}p.attr("src",k.iframeSrc),r.error=c,k.error&&k.error.call(k.context,r,c,b),m&&a.event.trigger("ajaxError",[r,k,c]),k.complete&&k.complete.call(k.context,r,c)}},m=k.global,m&&0===a.active++&&a.event.trigger("ajaxStart"),m&&a.event.trigger("ajaxSend",[r,k]),k.beforeSend&&k.beforeSend.call(k.context,r,k)===!1)return k.global&&a.active--,y.reject(),y;if(r.aborted)return y.reject(),y;t=x.clk,t&&(u=t.name,u&&!t.disabled&&(k.extraData=k.extraData||{},k.extraData[u]=t.value,"image"==t.type&&(k.extraData[u+".x"]=x.clk_x,k.extraData[u+".y"]=x.clk_y)));var z=1,A=2,B=a("meta[name=csrf-token]").attr("content"),C=a("meta[name=csrf-param]").attr("content");C&&B&&(k.extraData=k.extraData||{},k.extraData[C]=B),k.forceSync?g():setTimeout(g,10);var D,E,F,G=50,H=a.parseXML||function(a,b){return window.ActiveXObject?(b=new ActiveXObject("Microsoft.XMLDOM"),b.async="false",b.loadXML(a)):b=(new DOMParser).parseFromString(a,"text/xml"),b&&b.documentElement&&"parsererror"!=b.documentElement.nodeName?b:null},I=a.parseJSON||function(a){return window.eval("("+a+")")},J=function(b,c,d){var e=b.getResponseHeader("content-type")||"",f="xml"===c||!c&&e.indexOf("xml")>=0,g=f?b.responseXML:b.responseText;return f&&"parsererror"===g.documentElement.nodeName&&a.error&&a.error("parsererror"),d&&d.dataFilter&&(g=d.dataFilter(g,c)),"string"==typeof g&&("json"===c||!c&&e.indexOf("json")>=0?g=I(g):("script"===c||!c&&e.indexOf("javascript")>=0)&&a.globalEval(g)),g};return y}if(!this.length)return d("ajaxSubmit: skipping submit process - no element selected"),this;var l,m,n,o=this;"function"==typeof b?b={success:b}:"string"==typeof b||b===!1&&arguments.length>0?(b={url:b,data:c,dataType:g},"function"==typeof h&&(b.success=h)):void 0===b&&(b={}),l=b.type||this.attr2("method"),m=b.url||this.attr2("action"),n="string"==typeof m?a.trim(m):"",n=n||window.location.href||"",n&&(n=(n.match(/^([^#]+)/)||[])[1]),b=a.extend(!0,{url:n,success:a.ajaxSettings.success,type:l||a.ajaxSettings.type,iframeSrc:/^https/i.test(window.location.href||"")?"javascript:false":"about:blank"},b);var p={};if(this.trigger("form-pre-serialize",[this,b,p]),p.veto)return d("ajaxSubmit: submit vetoed via form-pre-serialize trigger"),this;if(b.beforeSerialize&&b.beforeSerialize(this,b)===!1)return d("ajaxSubmit: submit aborted via beforeSerialize callback"),this;var q=b.traditional;void 0===q&&(q=a.ajaxSettings.traditional);var r,s=[],t=this.formToArray(b.semantic,s,b.filtering);if(b.data){var u=a.isFunction(b.data)?b.data(t):b.data;b.extraData=u,r=a.param(u,q)}if(b.beforeSubmit&&b.beforeSubmit(t,this,b)===!1)return d("ajaxSubmit: submit aborted via beforeSubmit callback"),this;if(this.trigger("form-submit-validate",[t,this,b,p]),p.veto)return d("ajaxSubmit: submit vetoed via form-submit-validate trigger"),this;var v=a.param(t,q);r&&(v=v?v+"&"+r:r),"GET"==b.type.toUpperCase()?(b.url+=(b.url.indexOf("?")>=0?"&":"?")+v,b.data=null):b.data=v;var w=[];if(b.resetForm&&w.push(function(){o.resetForm()}),b.clearForm&&w.push(function(){o.clearForm(b.includeHidden)}),!b.dataType&&b.target){var x=b.success||function(){};w.push(function(c){var d=b.replaceTarget?"replaceWith":"html";a(b.target)[d](c).each(x,arguments)})}else b.success&&(a.isArray(b.success)?a.merge(w,b.success):w.push(b.success));if(b.success=function(a,c,d){for(var e=b.context||this,f=0,g=w.length;f0,C="multipart/form-data",D=o.attr("enctype")==C||o.attr("encoding")==C,E=e.fileapi&&e.formdata;d("fileAPI :"+E);var F,G=(B||D)&&!E;b.iframe!==!1&&(b.iframe||G)?b.closeKeepAlive?a.get(b.closeKeepAlive,function(){F=k(t)}):F=k(t):F=(B||D)&&E?j(t):a.ajax(b),o.removeData("jqxhr").data("jqxhr",F);for(var H=0;H0)&&(e={url:e,data:f,dataType:g},"function"==typeof h&&(e.success=h)),e=e||{},e.delegation=e.delegation&&a.isFunction(a.fn.on),!e.delegation&&0===this.length){var i={s:this.selector,c:this.context};return!a.isReady&&i.s?(d("DOM not ready, queuing ajaxForm"),a(function(){a(i.s,i.c).ajaxForm(e)}),this):(d("terminating; zero elements found by selector"+(a.isReady?"":" (DOM not ready)")),this)}return e.delegation?(a(document).off("submit.form-plugin",this.selector,b).off("click.form-plugin",this.selector,c).on("submit.form-plugin",this.selector,e,b).on("click.form-plugin",this.selector,e,c),this):this.ajaxFormUnbind().on("submit.form-plugin",e,b).on("click.form-plugin",e,c)},a.fn.ajaxFormUnbind=function(){return this.off("submit.form-plugin click.form-plugin")},a.fn.formToArray=function(b,c,d){var f=[];if(0===this.length)return f;var g,h=this[0],i=this.attr("id"),j=b?h.getElementsByTagName("*"):h.elements;if(j&&(j=a.makeArray(j)),i&&(g=a(':input[form="'+i+'"]').get(),g.length&&(j=(j||[]).concat(g))),!j||!j.length)return f;a.isFunction(d)&&(j=a.map(j,d));var k,l,m,n,o,p,q;for(k=0,p=j.length;k').get(0).files,S.formdata=void 0!==window.FormData;var _=!!q.fn.prop;function o(e){var t=e.data;e.isDefaultPrevented()||(e.preventDefault(),q(e.target).closest("form").ajaxSubmit(t))}function i(e){var t=e.target,r=q(t);if(!r.is("[type=submit],[type=image]")){var a=r.closest("[type=submit]");if(0===a.length)return;t=a[0]}var n,o=t.form;"image"===(o.clk=t).type&&(void 0!==e.offsetX?(o.clk_x=e.offsetX,o.clk_y=e.offsetY):"function"==typeof q.fn.offset?(n=r.offset(),o.clk_x=e.pageX-n.left,o.clk_y=e.pageY-n.top):(o.clk_x=e.pageX-t.offsetLeft,o.clk_y=e.pageY-t.offsetTop)),setTimeout(function(){o.clk=o.clk_x=o.clk_y=null},100)}function N(){var e;q.fn.ajaxSubmit.debug&&(e="[jquery.form] "+Array.prototype.join.call(arguments,""),window.console&&window.console.log?window.console.log(e):window.opera&&window.opera.postError&&window.opera.postError(e))}q.fn.attr2=function(){if(!_)return this.attr.apply(this,arguments);var e=this.prop.apply(this,arguments);return e&&e.jquery||"string"==typeof e?e:this.attr.apply(this,arguments)},q.fn.ajaxSubmit=function(M,e,t,r){if(!this.length)return N("ajaxSubmit: skipping submit process - no element selected"),this;var O,a,n,o,X=this;"function"==typeof M?M={success:M}:"string"==typeof M||!1===M&&0',s)).css({position:"absolute",top:"-1000px",left:"-1000px"}),m=d[0],p={aborted:0,responseText:null,responseXML:null,status:0,statusText:"n/a",getAllResponseHeaders:function(){},getResponseHeader:function(){},setRequestHeader:function(){},abort:function(e){var t="timeout"===e?"timeout":"aborted";N("aborting upload... "+t),this.aborted=1;try{m.contentWindow.document.execCommand&&m.contentWindow.document.execCommand("Stop")}catch(e){}d.attr("src",l.iframeSrc),p.error=t,l.error&&l.error.call(l.context,p,t,e),f&&q.event.trigger("ajaxError",[p,l,t]),l.complete&&l.complete.call(l.context,p,t)}},(f=l.global)&&0==q.active++&&q.event.trigger("ajaxStart"),f&&q.event.trigger("ajaxSend",[p,l]),l.beforeSend&&!1===l.beforeSend.call(l.context,p,l))return l.global&&q.active--,g.reject(),g;if(p.aborted)return g.reject(),g;(a=i.clk)&&(n=a.name)&&!a.disabled&&(l.extraData=l.extraData||{},l.extraData[n]=a.value,"image"===a.type&&(l.extraData[n+".x"]=i.clk_x,l.extraData[n+".y"]=i.clk_y));var x=1,y=2;function b(t){var r=null;try{t.contentWindow&&(r=t.contentWindow.document)}catch(e){N("cannot get iframe.contentWindow document: "+e)}if(r)return r;try{r=t.contentDocument?t.contentDocument:t.document}catch(e){N("cannot get iframe.contentDocument: "+e),r=t.document}return r}var c=q("meta[name=csrf-token]").attr("content"),T=q("meta[name=csrf-param]").attr("content");function j(){var e=X.attr2("target"),t=X.attr2("action"),r=X.attr("enctype")||X.attr("encoding")||"multipart/form-data";i.setAttribute("target",o),O&&!/post/i.test(O)||i.setAttribute("method","POST"),t!==l.url&&i.setAttribute("action",l.url),l.skipEncodingOverride||O&&!/post/i.test(O)||X.attr({encoding:"multipart/form-data",enctype:"multipart/form-data"}),l.timeout&&(v=setTimeout(function(){h=!0,A(x)},l.timeout));var a=[];try{if(l.extraData)for(var n in l.extraData)l.extraData.hasOwnProperty(n)&&(q.isPlainObject(l.extraData[n])&&l.extraData[n].hasOwnProperty("name")&&l.extraData[n].hasOwnProperty("value")?a.push(q('',s).val(l.extraData[n].value).appendTo(i)[0]):a.push(q('',s).val(l.extraData[n]).appendTo(i)[0]));l.iframeTarget||d.appendTo(u),m.attachEvent?m.attachEvent("onload",A):m.addEventListener("load",A,!1),setTimeout(function e(){try{var t=b(m).readyState;N("state = "+t),t&&"uninitialized"===t.toLowerCase()&&setTimeout(e,50)}catch(e){N("Server abort: ",e," (",e.name,")"),A(y),v&&clearTimeout(v),v=void 0}},15);try{i.submit()}catch(e){document.createElement("form").submit.apply(i)}}finally{i.setAttribute("action",t),i.setAttribute("enctype",r),e?i.setAttribute("target",e):X.removeAttr("target"),q(a).remove()}}T&&c&&(l.extraData=l.extraData||{},l.extraData[T]=c),l.forceSync?j():setTimeout(j,10);var w,S,k,D=50;function A(e){if(!p.aborted&&!k){if((S=b(m))||(N("cannot access response document"),e=y),e===x&&p)return p.abort("timeout"),void g.reject(p,"timeout");if(e===y&&p)return p.abort("server abort"),void g.reject(p,"error","server abort");if(S&&S.location.href!==l.iframeSrc||h){m.detachEvent?m.detachEvent("onload",A):m.removeEventListener("load",A,!1);var t,r="success";try{if(h)throw"timeout";var a="xml"===l.dataType||S.XMLDocument||q.isXMLDoc(S);if(N("isXml="+a),!a&&window.opera&&(null===S.body||!S.body.innerHTML)&&--D)return N("requeing onLoad callback, DOM not available"),void setTimeout(A,250);var n=S.body?S.body:S.documentElement;p.responseText=n?n.innerHTML:null,p.responseXML=S.XMLDocument?S.XMLDocument:S,a&&(l.dataType="xml"),p.getResponseHeader=function(e){return{"content-type":l.dataType}[e.toLowerCase()]},n&&(p.status=Number(n.getAttribute("status"))||p.status,p.statusText=n.getAttribute("statusText")||p.statusText);var o,i,s,u=(l.dataType||"").toLowerCase(),c=/(json|script|text)/.test(u);c||l.textarea?(o=S.getElementsByTagName("textarea")[0])?(p.responseText=o.value,p.status=Number(o.getAttribute("status"))||p.status,p.statusText=o.getAttribute("statusText")||p.statusText):c&&(i=S.getElementsByTagName("pre")[0],s=S.getElementsByTagName("body")[0],i?p.responseText=i.textContent?i.textContent:i.innerText:s&&(p.responseText=s.textContent?s.textContent:s.innerText)):"xml"===u&&!p.responseXML&&p.responseText&&(p.responseXML=F(p.responseText));try{w=E(p,u,l)}catch(e){r="parsererror",p.error=t=e||r}}catch(e){N("error caught: ",e),r="error",p.error=t=e||r}p.aborted&&(N("upload aborted"),r=null),p.status&&(r=200<=p.status&&p.status<300||304===p.status?"success":"error"),"success"===r?(l.success&&l.success.call(l.context,w,"success",p),g.resolve(p.responseText,"success",p),f&&q.event.trigger("ajaxSuccess",[p,l])):r&&(void 0===t&&(t=p.statusText),l.error&&l.error.call(l.context,p,r,t),g.reject(p,"error",t),f&&q.event.trigger("ajaxError",[p,l,t])),f&&q.event.trigger("ajaxComplete",[p,l]),f&&!--q.active&&q.event.trigger("ajaxStop"),l.complete&&l.complete.call(l.context,p,r),k=!0,l.timeout&&clearTimeout(v),setTimeout(function(){l.iframeTarget?d.attr("src",l.iframeSrc):d.remove(),p.responseXML=null},100)}}}var F=q.parseXML||function(e,t){return window.ActiveXObject?((t=new ActiveXObject("Microsoft.XMLDOM")).async="false",t.loadXML(e)):t=(new DOMParser).parseFromString(e,"text/xml"),t&&t.documentElement&&"parsererror"!==t.documentElement.nodeName?t:null},L=q.parseJSON||function(e){return window.eval("("+e+")")},E=function(e,t,r){var a=e.getResponseHeader("content-type")||"",n=("xml"===t||!t)&&0<=a.indexOf("xml"),o=n?e.responseXML:e.responseText;return n&&"parsererror"===o.documentElement.nodeName&&q.error&&q.error("parsererror"),r&&r.dataFilter&&(o=r.dataFilter(o,t)),"string"==typeof o&&(("json"===t||!t)&&0<=a.indexOf("json")?o=L(o):("script"===t||!t)&&0<=a.indexOf("javascript")&&q.globalEval(o)),o};return g}},q.fn.ajaxForm=function(e,t,r,a){if(("string"==typeof e||!1===e&&0

{{ site.description | default: site.github.project_tagline }}

  • Getting Started
  • API
  • Options
  • -
  • Examples
  • -
  • Form Fields
  • +
  • Examples
  • +
  • Form Fields
  • FAQ
  • Download
  • diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 00000000..ec5b2a43 --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,572 @@ +--- +--- + +## Examples + +### ajaxForm + +The following code controls the HTML form beneath it. It uses `ajaxForm` to bind the form and demonstrates how to use pre- and post-submit callbacks. + +```javascript +// prepare the form when the DOM is ready +$(document).ready(function() { + var options = { + target: '#output1', // target element(s) to be updated with server response + beforeSubmit: showRequest, // pre-submit callback + success: showResponse // post-submit callback + + // other available options: + //url: url // override for form's 'action' attribute + //type: type // 'get' or 'post', override for form's 'method' attribute + //dataType: null // 'xml', 'script', or 'json' (expected server response type) + //clearForm: true // clear all form fields after successful submit + //resetForm: true // reset the form after successful submit + + // $.ajax options can be used here too, for example: + //timeout: 3000 + }; + + // bind form using 'ajaxForm' + $('#myForm1').ajaxForm(options); +}); + +// pre-submit callback +function showRequest(formData, jqForm, options) { + // formData is an array; here we use $.param to convert it to a string to display it + // but the form plugin does this for you automatically when it submits the data + var queryString = $.param(formData); + + // jqForm is a jQuery object encapsulating the form element. To access the + // DOM element for the form do this: + // var formElement = jqForm[0]; + + alert('About to submit: \n\n' + queryString); + + // here we could return false to prevent the form from being submitted; + // returning anything other than false will allow the form submit to continue + return true; +} + +// post-submit callback +function showResponse(responseText, statusText, xhr, $form) { + // for normal html responses, the first argument to the success callback + // is the XMLHttpRequest object's responseText property + + // if the ajaxForm method was passed an Options Object with the dataType + // property set to 'xml' then the first argument to the success callback + // is the XMLHttpRequest object's responseXML property + + // if the ajaxForm method was passed an Options Object with the dataType + // property set to 'json' then the first argument to the success callback + // is the json data object returned by the server + + alert('status: ' + statusText + '\n\nresponseText: \n' + responseText + + '\n\nThe output div should have already been updated with the responseText.'); +} +``` + +
    + + + + + + + + + + +
    Name:
    Password:
    Multiple:
    Single:
    Single2:
    Check: + + + +
    Radio: + + + +
    Text:
    + + + + + + +
    + +#### Output Div (#output1): +
    AJAX response will replace this content.
    + +--- + +### ajaxSubmit + +The following code controls the HTML form beneath it. It uses `ajaxSubmit` to submit the form. +```javascript +// prepare the form when the DOM is ready +$(document).ready(function() { + var options = { + target: '#output2', // target element(s) to be updated with server response + beforeSubmit: showRequest, // pre-submit callback + success: showResponse // post-submit callback + + // other available options: + //url: url // override for form's 'action' attribute + //type: type // 'get' or 'post', override for form's 'method' attribute + //dataType: null // 'xml', 'script', or 'json' (expected server response type) + //clearForm: true // clear all form fields after successful submit + //resetForm: true // reset the form after successful submit + + // $.ajax options can be used here too, for example: + //timeout: 3000 + }; + + // bind to the form's submit event + $('#myForm2').submit(function() { + // inside event callbacks 'this' is the DOM element so we first + // wrap it in a jQuery object and then invoke ajaxSubmit + $(this).ajaxSubmit(options); + + // !!! Important !!! + // always return false to prevent standard browser submit and page navigation + return false; + }); +}); + +// pre-submit callback +function showRequest(formData, jqForm, options) { + // formData is an array; here we use $.param to convert it to a string to display it + // but the form plugin does this for you automatically when it submits the data + var queryString = $.param(formData); + + // jqForm is a jQuery object encapsulating the form element. To access the + // DOM element for the form do this: + // var formElement = jqForm[0]; + + alert('About to submit: \n\n' + queryString); + + // here we could return false to prevent the form from being submitted; + // returning anything other than false will allow the form submit to continue + return true; +} + +// post-submit callback +function showResponse(responseText, statusText, xhr, $form) { + // for normal html responses, the first argument to the success callback + // is the XMLHttpRequest object's responseText property + + // if the ajaxSubmit method was passed an Options Object with the dataType + // property set to 'xml' then the first argument to the success callback + // is the XMLHttpRequest object's responseXML property + + // if the ajaxSubmit method was passed an Options Object with the dataType + // property set to 'json' then the first argument to the success callback + // is the json data object returned by the server + + alert('status: ' + statusText + '\n\nresponseText: \n' + responseText + + '\n\nThe output div should have already been updated with the responseText.'); +} +``` + +
    + + + + + + + + + + +
    Name:
    Password:
    Multiple:
    Single:
    Single2:
    Check: + + + +
    Radio: + + + +
    Text:
    + + + +
    + +#### Output Div (#output2): +
    AJAX response will replace this content.
    + + +--- + +### Validation +This section gives several examples of how form data can be validated before it is sent to the server. The secret is in the `beforeSubmit` option. If this pre-submit callback returns false, the submit process is aborted. + +The following login form is used for each of the examples that follow. Each example will validate that both the *username* and *password* fields have been filled in by the user. + +#### Form Markup: + +```html +
    + Username: + Password: + +
    +``` + +First, we initialize the form and give it a `beforeSubmit` callback function - this is the validation function. + +```javascript +// prepare the form when the DOM is ready +$(document).ready(function() { + // bind form using ajaxForm + $('#myForm2').ajaxForm( { beforeSubmit: validate } ); +}); +``` + +#### Validate Using the `formData` Argument +
    + Username: + Password: + +
    + +```javascript +function validate(formData, jqForm, options) { + // formData is an array of objects representing the name and value of each field + // that will be sent to the server; it takes the following form: + // + // [ + // { name: username, value: valueOfUsernameInput }, + // { name: password, value: valueOfPasswordInput } + // ] + // + // To validate, we can examine the contents of this array to see if the + // username and password fields have values. If either value evaluates + // to false then we return false from this method. + + for (var i=0; i < formData.length; i++) { + if (!formData[i].value) { + alert('Please enter a value for both Username and Password'); + return false; + } + } + alert('Both fields contain values.'); +} +``` + +#### Validate Using the `jqForm` Argument +
    + Username: + Password: + +
    + +```javascript +function validate(formData, jqForm, options) { + // jqForm is a jQuery object which wraps the form DOM element + // + // To validate, we can access the DOM elements directly and return true + // only if the values of both the username and password fields evaluate + // to true + + var form = jqForm[0]; + if (!form.username.value || !form.password.value) { + alert('Please enter a value for both Username and Password'); + return false; + } + alert('Both fields contain values.'); +} +``` + +#### Validate Using the `fieldValue` Method +
    + Username: + Password: + +
    + +```javascript +function validate(formData, jqForm, options) { + // fieldValue is a Form Plugin method that can be invoked to find the + // current value of a field + // + // To validate, we can capture the values of both the username and password + // fields and return true only if both evaluate to true + + var usernameValue = $('input[name=username]').fieldValue(); + var passwordValue = $('input[name=password]').fieldValue(); + + // usernameValue and passwordValue are arrays but we can do simple + // "not" tests to see if the arrays are empty + if (!usernameValue[0] || !passwordValue[0]) { + alert('Please enter a value for both Username and Password'); + return false; + } + alert('Both fields contain values.'); +} +``` + +#### Note +You can find jQuery plugins that deal specifically with field validation on the [jQuery Plugins Page](http://docs.jquery.com/Plugins#Forms). + + +--- + +### JSON + +This page shows how to handle JSON data returned from the server. The form below submits a message to the server and the server echos it back in JSON format. + +#### Form markup: + +```html +
    + Message: + +
    +``` + +
    + Message: + +
    + +#### Server code in `json-echo.php`: +```php + +``` + +#### JavaScript: + +```javascript +// prepare the form when the DOM is ready +$(document).ready(function() { + // bind form using ajaxForm + $('#jsonForm').ajaxForm({ + // dataType identifies the expected content type of the server response + dataType: 'json', + + // success identifies the function to invoke when the server response + // has been received + success: processJson + }); +}); +``` + +#### Callback function + +```javascript +function processJson(data) { + // 'data' is the json object returned from the server + alert(data.message); +} +``` + +--- + +### XML +This page shows how to handle XML data returned from the server. The form below submits a message to the server and the server echos it back in XML format. + +#### Form markup: + +```html +
    + Message: + +
    +``` + +
    + Message: + +
    + +#### Server code in `xml-echo.php`: + +```php +' . $_POST['message'] . ''; +?> +``` + +#### JavaScript: + +```javascript +// prepare the form when the DOM is ready +$(document).ready(function() { + // bind form using ajaxForm + $('#xmlForm').ajaxForm({ + // dataType identifies the expected content type of the server response + dataType: 'xml', + + // success identifies the function to invoke when the server response + // has been received + success: processXml + }); +}); +``` + +#### Callback function + +```javascript +function processXml(responseXML) { + // 'responseXML' is the XML document returned by the server; we use + // jQuery to extract the content of the message node from the XML doc + var message = $('message', responseXML).text(); + alert(message); +} +``` + +--- + +### HTML +This page shows how to handle HTML data returned from the server. The form below submits a message to the server and the server echos it back in an HTML div. The response is added to this page in the `htmlExampleTarget` div below. + +#### Form markup: + +```html +
    + Message: + +
    +``` + +
    + Message: + +
    + +#### Server code in `html-echo.php`: + +```php +' . $_POST['message'] . ''; +?> +``` + +#### JavaScript: + +```javascript +// prepare the form when the DOM is ready +$(document).ready(function() { + // bind form using ajaxForm + $('#htmlForm').ajaxForm({ + // target identifies the element(s) to update with the server response + target: '#htmlExampleTarget', + + // success identifies the function to invoke when the server response + // has been received; here we apply a fade-in effect to the new content + success: function() { + $('#htmlExampleTarget').fadeIn('slow'); + } + }); +}); +``` + +#### htmlExampleTarget (output will be added below): +
    + +--- + +### File Upload +This page demonstrates the Form Plugin's file upload capabilities. There is no special coding required to handle file uploads. File input elements are automatically detected and processed for you. + +Browsers that support the [XMLHttpRequest Level 2](http://www.w3.org/TR/XMLHttpRequest/) will be able to upload files seamlessly and even get progress updates as the upload proceeds. For older browsers, a fallback technology is used which involves iframes since it is not possible to upload files using the level 1 implmenentation of the XMLHttpRequest object. This is a common fallback technique, but it has inherent limitations. The iframe element is used as the target of the form's submit operation which means that the server response is written to the iframe. This is fine if the response type is HTML or XML, but doesn't work as well if the response type is script or JSON, both of which often contain characters that need to be repesented using entity references when found in HTML markup. + +To account for the challenges of script and JSON responses when using the iframe mode, the Form Plugin allows these responses to be embedded in a `textarea` element and it is recommended that you do so for these response types when used in conjuction with file uploads and older browsers. + +It is important to note that even when the dataType option is set to 'script', and the server is actually responding with some javascript to a multipart form submission, the response's Content-Type header should be forced to `text/html`, otherwise Internet Explorer will prompt the user to download a "file". + +Also note that if there is no file input in the form then the request uses normal XHR to submit the form (not an iframe). This puts the burden on your server code to know when to use a textarea and when not to. If you like, you can use the `iframe` option of the plugin to force it to always use an *iframe mode* and then your server can always embed the response in a textarea. But the recommended solution is to test for the 'X-Requested-With' request header. If the value of that header is 'XMLHttpRequest' then you know that the form was posted via ajax. + +The following PHP snippet shows how you can be sure to return content successfully: + +```php +'; +?> + +// main content of response here + +'; +?> +``` + +The form below provides an input element of type "file" along with a select element to specify the dataType of the response. The form is submitted to `files.php` which uses the dataType to determine what type of response to return. + +
    + + File: + Return Type: + + +
    + +
    + +Examples that show how to display upload progress: +- [Progress Demo 1](http://malsup.com/jquery/form/progress.html) +- [Progress Demo 2](http://malsup.com/jquery/form/progress2.html) +- [Progress Demo 3](http://malsup.com/jquery/form/progress3.html) diff --git a/docs/faq.md b/docs/faq.md index 41294452..ea01ea8c 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -6,8 +6,7 @@ The only dependency is jQuery itself. #### Which versions of jQuery is jQuery Form Plugin compatible with? -jQuery Form Plugin is compatible with jQuery v1.7 and later. -It has not been throughly tested with jQuery 3. +jQuery Form Plugin is compatible with jQuery v1.7.2 and later, including jQuery 2.x.x and 3.x.x. #### Is jQuery Form Plugin fast? Does it serialize forms accurately? Yes! See our [comparison page](http://malsup.com/jquery/form/comp/) for a look at how jQuery Form Plugin compares to other libraries (including Prototype and dojo). diff --git a/docs/form-fields.md b/docs/form-fields.md new file mode 100644 index 00000000..fa356191 --- /dev/null +++ b/docs/form-fields.md @@ -0,0 +1,85 @@ +--- +--- + +## Form Fields +This page describes and demonstrates the Form Plugin's `fieldValue` and `fieldSerialize` methods. + +### fieldValue +`fieldValue` allows you to retrieve the current value of a field. For example, to retrieve the value of the password field in a form with the id of 'myForm' you would write: + +```javascript +var pwd = $('#myForm :password').fieldValue()[0]; +``` + +This method *always* returns an array. If no valid value can be determined the array will be empty, otherwise it will contain one or more values. + +### fieldSerialize +`fieldSerialize` allows you to serialize a subset of a form into a query string. This is useful when you need to process only certain fields. For example, to serialize only the text inputs of a form you would write: + +```javascript +var queryString = $('#myForm :text').fieldSerialize(); +``` + +
    +
    +

    Demonstration

    +

    + Enter a jQuery expression into the textbox below and then click 'Test' to see the results + of the fieldValue and fieldSerialize + methods. These methods are run against the test form that follows. +

    + jQuery expression: + + (ie: textarea, [@type='hidden'], :radio, :checkbox, etc)
    + [Successful controls](https://www.w3.org/TR/html5/forms.html#constructing-form-data-set) only
    + +
    +
    + + +
    + Test Form + + + + + + + + + + + + + + + + + + + + +
    <input type="hidden" name="Hidden" value="secret">
    <input name="Name" type="text" value="MyName1">
    <input name="Password" type="password">
    <select name="Multiple" multiple="multiple">
    <select name="Single">
    <input type="checkbox" name="Check" value="1">
    <input type="checkbox" name="Check" value="2">
    <input type="checkbox" name="Check" value="3">
    <input type="checkbox" name="Check2" value="4">
    <input type="checkbox" name="Check2" value="5">
    <input type="checkbox" name="Check3">
    <input type="radio" name="Radio" value="1">
    <input type="radio" name="Radio" value="2">
    <input type="radio" name="Radio" value="3">
    <input type="radio" name="Radio2" value="4">
    <input type="radio" name="Radio2" value="5">
    <textarea name="Text" rows="2" cols="20"></textarea>
    <input type="reset" name="resetButton" value="Reset">
    <input type="submit" name="sub" value="Submit">
    +
    + +By default, `fieldValue` and `fieldSerialize` only function on '[successful controls](https://www.w3.org/TR/html5/forms.html#constructing-form-data-set)'. This means that if you run the following code on a checkbox that is not checked, the result will be an empty array. +```javascript +// value will be an empty array if checkbox is not checked: +var value = $('#myUncheckedCheckbox').fieldValue(); +// value.length == 0 +``` + +However, if you really want to know the 'value' of the checkbox element, even if it's unchecked, you can write this: +```javascript +// value will hold the checkbox value even if it's not checked: +var value = $('#myUncheckedCheckbox').fieldValue(false); +// value.length == 1 +``` diff --git a/docs/index.md b/docs/index.md index de36059f..0eeade78 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,8 +18,8 @@ The jQuery Form Plugin allows you to easily and unobtrusively upgrade HTML forms ```html - - + + + +Lorem ipsum dolor sit amet + + + + + +Lorem ipsum dolor sit amet + + diff --git a/test/ajax/json.json b/test/ajax/json.json new file mode 100644 index 00000000..d5dad436 --- /dev/null +++ b/test/ajax/json.json @@ -0,0 +1 @@ +{ "name": "jquery-test" } \ No newline at end of file diff --git a/test/ajax/json.txt b/test/ajax/json.txt new file mode 100644 index 00000000..d5dad436 --- /dev/null +++ b/test/ajax/json.txt @@ -0,0 +1 @@ +{ "name": "jquery-test" } \ No newline at end of file diff --git a/test/ajax/script.txt b/test/ajax/script.txt new file mode 100644 index 00000000..99c5849e --- /dev/null +++ b/test/ajax/script.txt @@ -0,0 +1,3 @@ +formScriptTest = function() { + // no-op +} diff --git a/test/ajax/test.xml b/test/ajax/test.xml new file mode 100644 index 00000000..b16b62da --- /dev/null +++ b/test/ajax/test.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/test/ajax/text.html b/test/ajax/text.html new file mode 100644 index 00000000..c06ef4b8 --- /dev/null +++ b/test/ajax/text.html @@ -0,0 +1,12 @@ +Lorem ipsum dolor sit amet +consectetuer adipiscing elit +Sed lorem leo +lorem leo consectetuer adipiscing elit +Sed lorem leo +rhoncus sit amet +elementum at +bibendum at, eros +Cras at mi et tortor egestas vestibulum +sed Cras at mi vestibulum +Phasellus sed felis sit amet +orci dapibus semper. diff --git a/test/test.html b/test/test.html index c0018b31..96783b20 100644 --- a/test/test.html +++ b/test/test.html @@ -14,7 +14,7 @@