Bixby Developer Center

Guides
References

list-of

optionalvalue required

Creates a list from an array of returned results.

The list-of expression binds a variable to the concept holding the results; the where-each expression loops over that concept, binding its variable to each individual value within the array. Only card components can be in a list-of list. If you want the cards to be tappable, you need to define an on-click for these cards.

If you want to display the details of an item when a card is tapped, use the view-for key in your on-click to open that item's details layout.

Example

result-view {
match {
Movie (results)
}
message {
if (size(results) == 0) {
template ("#{event(results, 'NoResult')}")
} else {
template ("#{event(results, 'Result')}")
}
}
render {
if (size(results) == 1) {
layout-macro (MOVIE_DETAILS) {
param (movie) {
expression (results)
}
}
}
else-if (size(results) > 1) {
list-of (results) {
navigation-mode {
if ($handsFree) {
read-one {
list-summary {
template ("#{event(results, 'Result')}")
}
page-content {
item-selection-question {
template-macro (HANDS_FREE_MOVIE_ITEM_SELECTION_QUESTION)
}
overflow-statement {
template-macro (HANDS_FREE_MOVIE_OVERFLOW_STATEMENT)
}
overflow-question {
template-macro (HANDS_FREE_MOVIE_OVERFLOW_QUESTION)
}
underflow-statement {
template-macro (HANDS_FREE_MOVIE_UNDERFLOW_STATEMENT)
}
}
}
}
}
highlights {
select (pick) {
label {
template-macro (MOVIE_HIGHLIGHT_LABEL)
}
layout-macro (MOVIE_HIGHLIGHT) {
param (movie) {
expression (pick)
}
}
summary {
template-macro (HANDS_FREE_MOVIE_HIGHLIGHT_SUMMARY) {
param (movie) {
expression (pick)
}
}
}
}
}
where-each (result) {
if ($handsFree) {
layout-macro (MOVIE_HIGHLIGHT) {
param (movie) {
expression (result)
}
}
}
else {
layout-macro (MOVIE_SUMMARY) {
param (movie) {
expression (result)
}
}
}
spoken-summary {
template-macro (HANDS_FREE_MOVIE_NORMAL_SUMMARY) {
param (movie) {
expression (result)
}
}
}
}
}
}
}
}

View master on GitHub

You can run the sample capsule in the Simulator to see how this component displays on different devices, if supported.

Child Keys

default-sort-order
optional
Provides a single sort option that overrides the natural-sort-order defined in the concept
has-details[deprecated]
optional
This key is deprecated
header
optional
Header container for Bixby Views
highlights
optional
Highlight specific results on the first page of a rendered list in result-view and input-view of a selection list
navigation-mode
optional
Navigation mode defines the list navigation experience for the user
where-each
optional
Determines what displays in the view for users per the specified binding variable
where-each-page[deprecated]
optional
This key is deprecated