This is an old revision of the document!

Downloading jqGrid

Once you have a basic understanding of what Java Script and jQuery are and what they do, you're ready to try jqGrid!

1) Run the Download Builder on the jqGrid website to download a copy of jqGrid. jqGrid's download builder allows you to choose the components you would like to download and get a custom version of the plugin for your project.

2) Get the JQuery UI theme files.

If you're new to jqGrid, you should download all the components so you can experiment freely with everything. This will result in a larger filesize, but will save you from coming back. If you're using jqGrid for a production environment, you might consider downloading with only the pieces used, which will result in faster downloads.

Choose which components you need

The main column of the Download Builder lists all of the javascript modules in jqGrid categorized into groups: base, editing, subgrid, treegrid, import/export and user contributed modules. Some components in jqGrid depend on other components. In the description part of the download manager is explained which module should be downloaded if they depend on other. You will need to do this manually. The components you select will all be combined into a custom jQuery javascript file called jquery.jqGrid.min.js.

Click Download!

You're finished with the download builder! Click the download button and you'll get a customized zip file containing everything you selected.

After Downloading

Once you've downloaded jqGrid, you'll get a zip containing the following files:

/css/
- ui-jqgrid.css

/js/
- /i18n/
  - grid.locale-bg.js
  - list of all language files (minified)
  - ….
- Changes.txt
- jquery-1.3.2.min.js
- jquery.jqGrid.min.js
/src/
- /i18n/
  - grid.locale-bg.js
  - list of all language files
  - ….
- /css/
  - ui-jqgrid.css
- grid.base.js
- grid.celledit.js
- grid.common.js
- grid.custom.js
- grid.filter.js
- grid.formedit.js
- grid.import.js
- grid.inlinedit.js
- grid.loader.js
- grid.jqueryui.js
- grid.subgrid.js
- grid.tbltogrid.js
- grid.treegrid.js
- jqDnR.js
- jqModal.js
- jquery.fmatter.js
- JsonXml.js

As can be seen from the structure, files needed for using jqGrid are in main /css/ and /js/ directories. These files are minified and can be used in production environment. In this package is included the last minified version of jQuery library, so you do not need to download the jQuery library.

Files in /src/ directory are actually the pure source code and can be used from developers to easily find bugs and make improvements. In order to not use the minified version a file grid.loader.js should be used. See installation

Download UI theme

Starting from version 3.5 jqGrid is fully compatible with jQuery UI Theming. In order to use the grid plugin you will need to download the desired theme. The theme can be downloaded from jQuery UI site http://jqueryui.com/themeroller/. Note that you can build your custom theme. More information and how to do this can be found on the same site http://jqueryui.com. If you plan to use only the grid component you do not need to have all the CSS files that come from the package. In this case you will need to use only basic theming files ui.theme.css and ui.core.css. These files are located in development-bundle/themes directory in the downloaded UI theme file.

Having all the needed files we can continue with the installation

You could leave a comment if you were logged in.