1
0
mirror of synced 2024-11-26 06:46:04 +03:00

Document data object format

So far this just documents how <select> elements have their options
converted to a data object.
This commit is contained in:
Kevin Brown 2015-09-13 11:33:21 -04:00
parent 46ab1ebc8d
commit bc82856fb6

View File

@ -24,10 +24,34 @@
</h3>
<p>
No.
No. This is a limitation of the HTML specification and is not a limitation that Select2 can overcome.
</p>
<h3>
How are <code>&lt;option&gt;</code> and <code>&lt;optgroup&gt;</code> tags serialized into data objects?
</h3>
<p>
Select2 will convert the <code>&lt;option&gt;</code> tag into a data object based on the following rules.
</p>
<pre class="prettyprint linenums">
{
"id": "value attribute" || "option text",
"text": "label attribute" || "option text",
"element": HTMLOptionElement
}
</pre>
<p>
And <code>&lt;optgroup&gt;</code> tags will be converted into data objects using the following rules
</p>
<pre class="prettyprint linenums">
{
"text": "label attribute",
"children": [ option data object, ... ],
"elment": HTMLOptGroupElement
}
</pre>
</section>