How do I set the value property in AngularJS’ ng-options?
Here is what seems to be bothering a lot of people (including me).
When using the ng-options directive in AngularJS to fill in the options for a
When resultOptions is for example:
[
{
“value”: 1,
“text”: “1st”
},
{
“value”: 2,
“text”: “2nd”
}
]
It should be (and probably is) the most simple thing to set the option values, but so far I just don’t get it.
Solutions/Answers:
Solution 1:
See ngOptions
ngOptions(optional) – {
comprehension_expression=
} – in one of the
following forms:For array data sources:
label for value in array
select as label for value in array
label group by group for value in array
select as label group by group for value in array track by trackexpr
For object data sources:
label for (key , value) in object
select as label for (key , value) in object
label group by group for (key, value) in object
select as label group by group for (key, value) in object
In your case, it should be
array = [{ "value": 1, "text": "1st" }, { "value": 2, "text": "2nd" }];
<select ng-options="obj.value as obj.text for obj in array"></select>
Update
With the updates on AngularJS, it is now possible to set the actual value for the value
attribute of select
element with track by
expression.
<select ng-options="obj.text for obj in array track by obj.value">
</select>
How to remember this ugly stuff
To all the people who are having hard time to remember this syntax form: I agree this isn’t the most easiest or beautiful syntax. This syntax is kind of an extended version of Python’s list comprehensions and knowing that helps me to remember the syntax very easily. It’s something like this:
Python code:
my_list = [x**2 for x in [1, 2, 3, 4, 5]]
> [1, 4, 9, 16, 25]
# Let people to be a list of person instances
my_list2 = [person.name for person in people]
> my_list2 = ['Alice', 'Bob']
This is actually the same syntax as the first one listed above. However, in <select>
we usually need to differentiate between the actual value in code and the text shown (the label) in a <select>
element.
Like, we need person.id
in the code, but we don’t want to show the id
to the user; we want to show its name. Likewise, we’re not interested in the person.name
in the code. There comes the as
keyword to label stuff. So it becomes like this:
person.id as person.name for person in people
Or, instead of person.id
we could need the person
instance/reference itself. See below:
person as person.name for person in people
For JavaScript objects, the same method applies as well. Just remember that the items in the object is deconstructed with (key, value)
pairs.
Solution 2:
How the value attributes gets its value:
- When using an array as datasource, it will be the index of the array element in each iteration;
- When using an object as datasource, it will be the property name in each iteration.
So in your case it should be:
obj = { '1': '1st', '2': '2nd' };
<select ng-options="k as v for (k,v) in obj"></select>
Solution 3:
I had this issue too. I wasn’t able to set my value in ng-options. Every option that was generated was set with 0, 1, …, n.
To make it right, I did something like this in my ng-options:
HTML:
<select ng-options="room.name for room in Rooms track by room.price">
<option value="">--Rooms--</option>
</select>
I use “track by” to set all my values with room.price
.
(This example sucks: because if there were more than one price equal, the code would fail. So BE SURE to have different values.)
JSON:
$scope.Rooms = [
{ name: 'SALA01', price: 100 },
{ name: 'SALA02', price: 200 },
{ name: 'SALA03', price: 300 }
];
I learned it from blog post How to set the initial selected value of a select element using Angular.JS ng-options & track by.
Watch the video. It’s a nice class 🙂
Solution 4:
If you want to change the value of your option
elements because the form will eventually be submitted to the server, instead of doing this,
<select name="text" ng-model="text" ng-options="select p.text for p in resultOptions"></select>
You can do this:
<select ng-model="text" ng-options="select p.text for p in resultOptions"></select>
<input type="hidden" name="text" value="{{ text }}" />
The expected value will then be sent through the form under the correct name.
Solution 5:
To send a custom value called my_hero
to the server using a normal form submit:
JSON:
"heroes": [
{"id":"iron", "label":"Iron Man Rocks!"},
{"id":"super", "label":"Superman Rocks!"}
]
HTML:
<select ng-model="hero" ng-options="obj.id as obj.label for obj in heroes"></select>
<input type="hidden" name="my_hero" value="{{hero}}" />
The server will receive either iron
or super
as the value of my_hero
.
This is similar to the answer by @neemzy, but specifying separate data for the value
attribute.
Solution 6:
It appears that ng-options
is complicated (possibly frustrating) to use, but in reality we have an architecture problem.
AngularJS serves as an MVC framework for a dynamic HTML+JavaScript application. While its (V)iew component does offer HTML “templating,” its primary purpose is to connect user actions, via a controller, to changes in the model. Therefore the appropriate level of abstraction, from which to work in AngularJS, is that a select element sets a value in the model to a value from a query.
- How a query row is presented to the user is the (V)iew’s concern and
ng-options
provides thefor
keyword to dictate what the contents of the option element should be i.e.p.text for p in resultOptions
. - How a selected row is presented to the server is the (M)odel’s concern. Therefore
ng-options
provides theas
keyword to specify what value is provided to the model as ink as v for (k,v) in objects
.
The correct solution this is problem is then architectural in nature and involves refactoring your HTML so that the (M)odel performs server communication when required (instead of the user submitting a form).
If an MVC HTML page is unnecessary over-engineering for the problem at hand: then use only the HTML generation portion of AngularJS’s (V)iew component. In this case, follow the same pattern that is used for generating elements such as <li />
‘s under <ul />
‘s and place a ng-repeat on an option element:
<select name=“value”>
<option ng-repeat=“value in Model.Values” value=“{{value.value}}”>
{{value.text}}
</option>
</select>
As kludge, one can always move the name attribute of the select element to a hidden input element:
<select ng-model=“selectedValue” ng-options=“value.text for value in Model.Values”>
</select>
<input type=“hidden” name=“value” value=“{{selectedValue}}” />