ExtJS beginner - Samples/Extensions where is the documentation ?

Question

Hello

We have been looking at the ExtJS samples quite a few times over the years and recently decided to use it because I was looking at the samples and saw a Tree Grid and felt like "Yes this is exactly what I need". So I download ExtJS read a bit on the getting started/FAQ/Tutorial from the website.

Then I decide to try to use the Tree Grid to find out it's not in the documentation anywhere. so I thought it was just that the documentation was not fully updated for the latest 3.1 release so I look at the sample code to realize that most of the JS classes used for that sample are under the ux/treegrid folder, and the only place I could find that code was by downloading it directly from the sample. I never found any documentation for it anywhere.

Not only that, I also found that there are two very similar samples: Tree Grid and a Column Tree that shows how to customize the Tree Panel component, which confuses me even more. Neither have documentation for them and I can't tell if this code is supported or which one I should use or even if I should use any of them in fact; is this code production ready or just something that was thrown out there to show a nice sample and the extensibility of ExtJS ?

I noticed that many of the samples shown on ExtJS website are using components that are not part of the 'ext-all.js' and are not really documented. So I guess I am missing something about what ExtJS is supposed to be or the general philosophy behind this library ?

I guess I was expecting that most of the samples on their website would be available widgets from the library demonstrating how to use them, not showing me "Here's what you could do if you knew how to extend those components".

Any help/comments to enlighten me would be appreciated! Thanks

Answer 1

I encountered the exact same problem recently when I went to use the row editor capability (attached to grid). Being a long time ExtJS user, I never stopped to think about the lack of documentation accompanying the examples, but your comments are spot on.

For the RowEditor, I found documentation on the internet. I also find the ExtJS forums to be a great place to find suggestions, code samples, and links to documentation .

Answer 2

With user extensions, generally, you are on your own - which is not a bad thing. Although you can find some documentation at extjs-ux.org, your best bet is to read the code and if it's well documented, you may be able to run jsdoc on it. I know this is not what most people want to hear, but it's best to understand the code you are adding to your project as if it was your own.

Specifically for the ux.treegrid.TreeGrid you are using, there are plenty of examples in the forums and on the net to get you rolling (I think TreeGrid is newer than the ColumnTree). If you get stuck on a specific issue, the forums and stackoverflow are the perfect places to get a quick answer.

So I guess my answer is, "Download the extension and start playing with it as if you wrote it yourself. When you run into a problem, post it here.".

Answer 3

I have found site where you can download more or less full ExtJS documentation with ux (User eXtension)

http://www.diloc.de/blog/extdocsuite/

Short description of the link.

ExtDocSuite

The ExtDocSuite is an Adobe Air Application that includes the current ExtJS 3.2 Documentation in a single application to install. We provide this package, because ExtJS has not yet updated the Air Documentation app for Ext 3.2.

Features:

* Includes the latest Documentation for ExtJS 3.2.0
* Includes the latest ux Documentation from the examples/ folder (using ext-doc)
* Includes the latest Ext.Air Documentation. (using ext-doc)
* Search works (online)
* EXPERIMENTAL per-class search aids in finding the right documentation in big classes
* Integrated Update-System so that your documentation always stays up to date