RetailCRM-Mirror/select2
1
0
Fork 0
mirror of synced 2025-02-16 20:13:16 +03:00
Code Issues Projects Releases Wiki Activity

Docs for mapping id and text

Browse Source 
These modified snippets are from the announcement.

This closes https://github.com/select2/select2/issues/4086.
This commit is contained in:
Kevin Brown 2016-02-14 15:03:51 -05:00
parent 6369f5f173
commit ac109685a0
1 changed files with 53 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
docs/_includes/options/data/array.html
View File

@ -4,7 +4,10 @@
</h2>
<p>
While Select2 is designed to be used with a <code>&lt;select&gt;</code> tag, the data that is used to search through and display the results can be loaded from a JavaScript array using the <code>data</code> option. This option should be passed in during the initialization of Select2.
While Select2 is designed to be used with a <code>&lt;select&gt;</code> tag
the data that is used to search through and display the results can be
loaded from a JavaScript array using the <code>data</code> option. This
option should be passed in during the initialization of Select2.
</p>
{% highlight js linenos %}
@ -24,7 +27,10 @@ $('select').select2({
</h3>
<p>
The <code>id</code> and <code>text</code> properties are required on each object, and these are the properties that Select2 uses for the internal data objects. Any additional paramters passed in with data objects will be included on the data objects that Select2 exposes.
The <code>id</code> and <code>text</code> properties are required on each
object, and these are the properties that Select2 uses for the internal
data objects. Any additional paramters passed in with data objects will be
included on the data objects that Select2 exposes.
</p>
<h3>
@ -32,7 +38,11 @@ $('select').select2({
</h3>
<p>
Nested results should be specified using the <code>children</code> property on the data objects that are passed in. This <code>children</code> property should be an array of data objects that are grouped under this option, and the label for the group should be specified as the <code>text</code> property on the root data object.
Nested results should be specified using the <code>children</code> property
on the data objects that are passed in. This <code>children</code> property
should be an array of data objects that are grouped under this option, and
the label for the group should be specified as the <code>text</code>
property on the root data object.
</p>
{% highlight js linenos %}
@ -53,7 +63,11 @@ $('select').select2({
</h3>
<p>
Because Select2 falls back to an <code>&lt;optgroup&gt;</code> when creating nested options, only <a href="#how-many-levels-of-nesting-can-there-be">a single level of nesting</a> is supported. Any additional levels of nesting is not guarenteed to be displayed properly across all browsers and devices.
Because Select2 falls back to an <code>&lt;optgroup&gt;</code> when
creating nested options, only
<a href="#how-many-levels-of-nesting-can-there-be">a single level of nesting</a>
is supported. Any additional levels of nesting is not guarenteed to be
displayed properly across all browsers and devices.
</p>
<h3>
@ -61,28 +75,56 @@ $('select').select2({
</h3>
<p>
The <code>data</code> option is a shortcut that Select2 provides which allows you to load options into your <code>select</code> from a data array.
The <code>data</code> option is a shortcut that Select2 provides which
allows you to load options into your <code>select</code> from a data array.
</p>
{% include options/not-written.html %}
<h3>
My objects don&apos;t use <code>id</code> for their unique identifiers, what can I do?
My objects don&apos;t use <code>id</code> for their unique identifiers,
what can I do?
</h3>
<p>
You can re-map your identifier before passing it to Select2.
Select2 requires that the <code>id</code> property is used to uniquely
identify the options that are displayed in the results list. If you use a
property other than <code>id</code> (like <code>pk</code>) to uniquely
identify an option, you need to map your old property to <code>id</code>
before passing it to Select2.
</p>
{% include options/not-written.html %}
<p>
If you cannot do this on your server or you are in a situation where the
identifier cannot be changed, you can do this in JavaScript before passing
it to Select2.
</p>
{% highlight js linenos %}
var data = $.map(yourArrayData, function (obj) {
obj.id = obj.id || obj.pk; // replace pk with your identifier
return obj;
});
{% endhighlight %}
<h3>
My objects use a property other than <code>text</code> for the text that needs to be displayed
My objects use a property other than <code>text</code> for the text that
needs to be displayed
</h3>
<p>
These can also be re-mapped.
Just like with the <code>id</code> property, Select2 requires that the text
that should be displayed for an option is stored in the <code>text</code>
property. You can map this property from any existing property using the
following JavaScript.
</p>
{% include options/not-written.html %}
{% highlight js linenos %}
var data = $.map(yourArrayData, function (obj) {
obj.text = obj.text || obj.name; // replace name with the property used for the text
return obj;
});
{% endhighlight %}
</section>