SPServices is a jQuery library which abstracts SharePoint's Web Services and makes them easier to use. It also includes functions which use the various Web Service operations to provide more useful (and cool) capabilities. It works entirely client side and requires no server install.
SPServices is a jQuery library which abstracts SharePoint's Web Services and makes them easier to use. It also includes functions which use the various Web Service operations to provide more useful (and cool) capabilities. It works entirely client side and requires no server install.
SPServices is primarily hosted on Codeplex, with this repository mirroring most of the downloads there.
Until otherwise announced, this is not a fully functional version of SPServices. When complete, this version will be:
For full documentation, please visit http://spservices.codeplex.com/documentation
Would you like to contribute to the next generation of SPServices?
Fork this repository and checkout the source
From the root of the project, run:
npm install
This will install all of the necessary dependencies
run:
gulp
TODO: complete documentation here on what a build will actually do.
A gulp
target called watch
is available for linting code as files are changed and saved. To use it, simply run:
gulp watch
This will start a job that watches the sources files as they are saved and runs the linting tool to ensure they are clean of issues.
Unit test cases are written under the test folder using QUnit. Tests will run in the dev.aspx above.
Currently the tests require a real SharePoint server. The tests will create and delete some test data to validate basic core calls.
Documentation is generated using the files in the /docs
directory of this repo. Pages are written in Markdown with YAML front matter and then converted to HTML for hosting on GitHub pages via the gh-pages
branch. The gh-pages
branch should never need to be directly edited or modified.
To edit documentation and see a live preview of changes in the browser, run:
gulp servedocs
This will build the documentation and serve the HTML files using Browsersync. Any changes to the source files in /docs
will be reloaded in the browser automatically.
When documentation changes are complete:
Stop the servedocs
task (Ctrl+C or Cmd+C)
Run gulp docs
to clean the dist/docs
folder and rebuild it using the latest source files from /docs
If ready to deploy to gh-pages, run:
gulp deploydocs
This will package everything in the /dist
folder into a ZIP file, then update the gh-pages
branch with the ZIP file and all documentation files. Changes may take a few minutes to show up on http://sympmarc.github.io/SPServices.