Data binding in React Listview component
30 Jan 202312 minutes to read
ListView provides the option to load the data either from local data sources or remote data services. This can be done through dataSource property which supports the data type of array or through DataManager.
ListView supports different kind of data services such as OData, OData V4, Web API and data formats like XML, JSON, JSONP with the help of DataManager Adaptors.
Fields | Type | Description |
---|---|---|
id | string | Specifies ID attribute of list item, mapped in dataSource. |
text | string | Specifies list item display text field. |
isChecked | string | Specifies checked status of list item. |
isVisible | string | Specifies visibility state of list item. |
enabled | string | Specifies enabled state of list item. |
iconCss | string | Specifies the icon class of each list item which will be add before to inner text. |
child | string | Specifies child dataSource fields. |
tooltip | string | Specifies tooltip title text field. |
groupBy | string | Specifies category of each list item. |
sortBy | string | Specifies sorting field, which is used to sort the listview data. |
htmlAttributes | string | Specifies list item html attributes field. |
When complex data bind to ListView, you should map the fields properly. Otherwise, the ListView properties remain as undefined or null.
Bind to local data
Local data represents in two ways, which are described below.
- Array of simple data
- Array of JSON data.
Array of simple data
ListView supports to load the array of primitive data like string and numbers. Here, both value and text field act as same.
import * as React from 'react';
import * as ReactDOM from "react-dom";
import { ListViewComponent } from '@syncfusion/ej2-react-lists';
function App() {
let data = ["Artwork", "Abstract", "Modern Painting", "Ceramics", "Animation Art", "Oil Painting"];
return (
// specifies the tag to render the ListView component
<ListViewComponent id='list' dataSource={data}></ListViewComponent>);
}
export default App;
ReactDOM.render(<App />, document.getElementById('element'));
import * as React from 'react';
import * as ReactDOM from "react-dom";
import { ListViewComponent } from '@syncfusion/ej2-react-lists';
function App() {
let data = ["Artwork", "Abstract", "Modern Painting", "Ceramics", "Animation Art", "Oil Painting"];
return (
// specifies the tag to render the ListView component
<ListViewComponent id='list' dataSource={data} ></ListViewComponent>
);
}
export default App;
ReactDOM.render(<App />, document.getElementById('element'));
Array of JSON data
ListView can generate its list items through an array of complex data. To get it work properly, you should map the appropriate columns to field property.
The below example illustrates the concept of binding Array of JSON data.
import * as React from 'react';
import * as ReactDOM from "react-dom";
import { ListViewComponent } from '@syncfusion/ej2-react-lists';
function App() {
//define the array of JSON
let settings = [
{
Name: "Display",
id: "list-01"
},
{
Name: "Notification",
id: "list-02"
},
{
Name: "Sound",
id: "list-03"
},
{
Name: "Apps",
id: "list-04"
},
{
Name: "Storage",
id: "list-05"
},
{
Name: "Battery",
id: "list-06"
}
];
let fields = { text: "Name", tooltip: "Name", id: "id" };
return (
// specifies the tag to render the ListView component
<ListViewComponent id="list" dataSource={settings} fields={fields} showHeader={true} headerTitle="Device settings"/>);
}
export default App;
ReactDOM.render(<App />, document.getElementById('element'));
import * as React from 'react';
import * as ReactDOM from "react-dom";
import { ListViewComponent } from '@syncfusion/ej2-react-lists';
function App() {
//define the array of JSON
let settings: { [key: string]: Object }[] = [
{
Name: "Display",
id: "list-01"
},
{
Name: "Notification",
id: "list-02"
},
{
Name: "Sound",
id: "list-03"
},
{
Name: "Apps",
id: "list-04"
},
{
Name: "Storage",
id: "list-05"
},
{
Name: "Battery",
id: "list-06"
}
];
let fields = { text: "Name", tooltip: "Name", id: "id" };
return (
// specifies the tag to render the ListView component
<ListViewComponent
id="list"
dataSource={settings}
fields={fields}
showHeader={true}
headerTitle="Device settings"
/>
);
}
export default App;
ReactDOM.render(<App />, document.getElementById('element'));
Bind to remote data
ListView supports to retrieve the data from remote data services with the help of DataManager component and Query property allows to fetch data and return it to ListView from the database.
In the below sample, displayed first 6 Products from Product table of NorthWind data service.
import * as React from 'react';
import * as ReactDOM from "react-dom";
import { ListViewComponent } from '@syncfusion/ej2-react-lists';
//import DataManager related classes
import { DataManager, Query } from '@syncfusion/ej2-data';
function App() {
//bind the DataManager instance to dataSource property
let data = new DataManager({ url: 'https://services.syncfusion.com/react/production/api/',
crossDomain: true });
//bind the Query instance to query property
let query = new Query().from('ListView').select('EmployeeID,FirstName').take(10);
//map the appropriate columns to fields property
let fields = {
id: 'EmployeeID',
text: 'FirstName'
};
return (
// specifies the tag to render the ListView component
<ListViewComponent id="list" dataSource={data} fields={fields} query={query} showHeader={true} headerTitle="Employees"/>);
}
export default App;
ReactDOM.render(<App />, document.getElementById('element'));
import * as React from 'react';
import * as ReactDOM from "react-dom";
import { ListViewComponent } from '@syncfusion/ej2-react-lists';
//import DataManager related classes
import { DataManager, Query, ODataV4Adaptor } from '@syncfusion/ej2-data';
function App() {
//bind the DataManager instance to dataSource property
let data = new DataManager({ url: 'https://services.syncfusion.com/react/production/api/',
crossDomain: true });
//bind the Query instance to query property
let query = new Query().from('ListView').select('EmployeeID,FirstName').take(10);
//map the appropriate columns to fields property
let fields = {
id: 'EmployeeID',
text: 'FirstName'
};
return (
// specifies the tag to render the ListView component
<ListViewComponent
id="list"
dataSource={data}
fields={fields}
query={query}
showHeader={true}
headerTitle="Employees"
/>
);
}
export default App;
ReactDOM.render(<App />, document.getElementById('element'));