Documentation Bugs - Ext 2.x

[neshaug]

It seems like there is alot more config options for components than I can find in the Ext 2.0 docs. I can find many examples that uses: region, minSize, split, margins, el and contentEl. I think I have seen more too, and the advice I get if it's used in an example I should to, but it would be nice to know what these options do.. I've searched the forums and I can't find any relevant posts about it, but I've just started with Ext so I am sorry if this is something obvious I just don't get..

[mikegiddens]

"shim" has a misspelling "opnly" -> "only"

[NBRed5]

The docs for the TabPanel contain config items that do not apply to a tab panel

1. header
2. headerAsText
3. title

Using any of these config items will have no effect as the TabPanel does not show a header and should be removed from the docs to avoid confusion.

[tof]

In Ext.Toolbar, the "maybeArray" is badly truncated :

insertButton( Number index, Object/Ext.Toolbar.Item/Ext.Toolbar.Button (may ) : Ext.Toolbar.Button/Item
Inserts any Ext.Toolbar.Item/Ext.Toolbar.Button at the specified index.
Inserts any Ext.Toolbar.Item/Ext.Toolbar.Button at the specified index.
Parameters:

    * index : Number
      The index where the item is to be inserted
    * (may : Object/Ext.Toolbar.Item/Ext.Toolbar.Button
      be Array)} item The button, or button config object to be inserted.

[aconran]

The listeners configuration option is missing from Ext.util.Observable.

Aaron

[tjcrowder]

There are some properties and other things used in the Portal layout example (examples/layout/portal.js) that aren't documented in the API documentation (or in many cases the code):

[...1 removed, it's fixed in beta1...]

2. ddScrollConfig (both it and its members). Seems to be used by the ScrollManager for this and that, recommend adding it either in the ScrollManager summary or to the description of the register method (or both).

3. Panel.bwrap property.

4. DragSource.proxy property.

The documentation for Ext.form.FormPanel is missing the getForm method.

In the summary for Ext.form.FormPanel, I recommend adding a link to Ext.form.Action.Submit so users can readily see the format for the JSON return data for the response to the default form submission feature (which is really cool).

Ext.form.FormPanel's documentation should discuss the 'items' config option as it relates to FormPanel (see this thread). It's currently inheriting the Component documentation, which doesn't help you figure out what it's going to do with the configs and specifically how it's going to map configs to classes.

With the exception of the redacted item above (which is now documented), none of these seems to be documented in beta1 but they're not addressed in this thread, either (e.g., listed in the lists of bugs or recommendations at the beginning, or rejected via a reply). Naturally everyone's very busy trying to get things out; have these reports been overlooked?

[mystix]

Naturally everyone's very busy trying to get things out; have these reports been overlooked?

don't worry, they haven't been overlooked.
i just haven't had the time to verify + consolidate all the newly-reported items since my last post.

just keep those reports coming though. i'll probably get some time to consolidate the new items this weekend.

[jerrybrown5]

Ext.data.Field is very important but it is not in the documentation.

I had to create my own notes on name, mapping, convert because none existed. Also, mapping and convert are not that useful on Array based stores since it requires you to put the field index (as opposed to the field name) in the mapping value. (Since convert uses the mapping value, it becomes equally underused. )

[tjcrowder]

i just haven't had the time to verify + consolidate all the newly-reported items since my last post.

Thanks, sorry for the re-post, I saw that the list had been updated since those reports so I thought I should check. Engage patience mode!

[tjcrowder]

The summary for BasicForm talks about overriding the onSubmit method if you want to do a "normal" form submission, but the onSubmit method isn't documented and is marked "private" in the source.