Ag-Grid React入门

Ag-Grid和React兼容性:

reactAg-Grid
15.x18 - 21.2.0
16.3X22+

安装

npm install --save ag-grid-community ag-grid-react ag-grid-enterprise
  • ag-grid-community: 原始版本,零依赖性,不会拉取第三方依赖关系到应用程序中
  • 分组等高级功能是ag-grid-enterprise独有的功能。可以免费试用,如果打算用于生产项目,需要获取企业许可证密钥。
  • ag-grid-enterprise自定义上下文菜单和更高级的列菜单弹出。
    高级列菜单控制grid显示或隐藏部分列数据;控制grid列的宽度是否自适应,列pin的位置。
    自定义的上下文菜单提供了复制、粘贴、导出数据(.cvs、.xlsx、.xml格式)的功能

使用

// import依赖
import React, { useState } from 'react'
import { AgGridColumn, AgGridReact } from 'ag-grid-react';
import 'ag-grid-enterprise'
import 'ag-grid-community/dist/styles/ag-grid.css';
import 'ag-grid-community/dist/styles/ag-theme-alpine.css';
// 定义数据rowData
const [rowData, setRowData] = useState([
	{ make: "Toyota", model: "Celica", price: 35000 },
	{ make: "Ford", model: "Mondeo", price: 32000 },
	{ make: "Porsche", model: "Boxter", price: 72000 }
])
// grid定义
<div className="ag-theme-alpine-dark" style={ { height: 400, width: 600 } }>
	<AgGridReact
		rowSelection="multiple"
		rowData={rowData}
	>
		<AgGridColumn field="make" sortable={true} filter={true} checkboxSelection={true}></AgGridColumn>
		<AgGridColumn field="model" filter={true}></AgGridColumn>
		<AgGridColumn field="price" sortable={true}></AgGridColumn>
	</AgGridReact>
</div>
  • 通过容器元素的className设置网格theme
  • rowData对象的字段与AgGridColumn中的field值匹配

基本使用

排序

  • 在AgGridColumn上定义sortable属性,点击表头在升序、降序、无序之间切换
<AgGridColumn field="price" sortable={true}></AgGridColumn>

过滤

  • 在AgGridColumn上定义filter属性,筛选功能显示在列菜单中显示
<AgGridColumn field="model" filter={true}></AgGridColumn>

选择

  • AgGridReact上定义rowSelection属性,定义checkboxSelection属性
  • 获取并保存选中状态需要用到Ag-Grid提供的api,onGridReady事件返回params,包含各种api
// params 包含有type、api(gridApi)、columnApi
const [gridApi, setGridApi] = useState(null)
const [gridColumnApi, setGridColumnApi] = useState(null)

function onGridReady(params) {
	setGridApi(params.api);
	setGridColumnApi(params.columnApi);
}
<AgGridReact
	rowSelection="multiple"
	rowData={rowData}
	onGridReady={onGridReady}
>
	<AgGridColumn field="make" checkboxSelection={true}></AgGridColumn>
</AgGridReact>

分组

  • AgGridReact上设置autoGroupColumnDef和groupSelectsChildren;
  • AgGridColumn上设置rowGroup
<AgGridReact
	rowSelection="multiple"
	rowData={rowData}
	onGridReady={onGridReady}
	groupSelectsChildren={true}
	autoGroupColumnDef={{
		headerName: "Price",
		field: "price",
		cellRenderer:'agGroupCellRenderer',
		cellRendererParams: {
			checkbox: true
		}
	}}
>
	<AgGridColumn field="make" filter={true} rowGroup={true}></AgGridColumn>
</AgGridReact>
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
### 回答1: 要为 ag-grid-react 自定义单元格编辑器创建带搜索和输入的输入框,你可以按照以下步骤进行操作: 1. 创建一个新的 React 组件,该组件将作为自定义单元格编辑器。 2. 在该组件的 render() 方法中,使用一个文本输入框和一个搜索输入框来创建你的输入框。 3. 在 componentDidMount() 方法中,使用 ag-grid-react 的 ICellEditorParams 接口中的方法获取单元格的当前值。 4. 在 ag-grid-react 的 ICellEditorParams 接口中实现 getValue() 方法,该方法将返回输入框的当前值。 5. 在 ag-grid-react 的 ICellEditorParams 接口中实现 isPopup() 方法,该方法将返回 true,以便输入框显示为弹出式窗口。 6. 在 ag-grid-react 中使用你的新自定义单元格编辑器。 以下是一个示例代码,演示如何创建一个带搜索和输入的输入框作为 ag-grid-react 自定义单元格编辑器: ```javascript import React, { Component } from 'react'; import PropTypes from 'prop-types'; import { AgEditorCellDef } from 'ag-grid-react'; class SearchInputEditor extends Component { constructor(props) { super(props); this.state = { value: props.value, }; } componentDidMount() { this.refs.input.focus(); } getValue() { return this.state.value; } isPopup() { return true; } handleChange = (event) => { this.setState({ value: event.target.value }); } handleKeyDown = (event) => { if (event.keyCode === 13) { this.props.stopEditing(); } } render() { return ( <div> <input ref="input" type="text" value={this.state.value} onChange={this.handleChange} onKeyDown={this.handleKeyDown} /> <input type="text" placeholder="Search..." /> </div> ); } } SearchInputEditor.propTypes = { value: PropTypes.string, stopEditing: PropTypes.func.isRequired, }; export default class GridExample extends Component { constructor(props) { super(props); this.state = { columnDefs: [ { headerName: 'Name', field: 'name', editable: true, cellEditorFramework: SearchInputEditor, }, { headerName: 'Age', field: 'age', editable: true, }, { headerName: 'Gender', field: 'gender', editable: true, }, ], rowData: [ { name: 'John Smith', age: 35, gender: 'Male' }, { name: 'Jane Doe', age: 28, gender: 'Female' }, { name: 'Bob Johnson', age: 42, gender: 'Male' }, ], }; } render() { return ( <div className="ag-theme-balham" style={{ height: '500px', width: '600px' }} > <AgGridReact columnDefs={this.state.columnDefs} rowData={this.state.rowData} enableSorting={true} /> </div> ); } } ``` ### 回答2: ag-grid-react允许我们自定义单元格编辑器,以满足特定的需求。要创建一个带搜索和输入框的自定义单元格编辑器,我们可以按照以下步骤进行: 1. 首先,我们需要创建一个React组件作为单元格编辑器。我们可以使用antd或其他UI库中的输入框组件,该组件已经带有搜索功能。在该组件内部,我们可以添加输入框和搜索按钮。 2. 在自定义编辑器组件中,我们需要实现ag-Grid的IAgEditorReact接口,以便它可以与ag-Grid进行交互。我们必须实现接口中的相关方法,如getValue()、isPopup()、isCancelBeforeStart()等。 3. 实现getValue()方法时,我们可以在函数内部获取输入框的值并返回它。这样,编辑器就可以将输入框的值传回给ag-Grid。 4. 其他方法如isPopup()和isCancelBeforeStart()可以根据需求进行实现,以控制编辑器的弹出和取消行为。 5. 在创建自定义单元格时,我们需要指定单元格的编辑器。我们可以设置editType为"custom",并将我们之前创建的自定义编辑器组件作为cellEditor设置。这将使ag-Grid在需要编辑单元格时使用我们的自定义编辑器。 这样,我们就可以利用自定义单元格编辑器为ag-grid-react创建一个带有搜索功能的输入框了。每次需要编辑单元格时,ag-Grid将显示我们定义的自定义编辑器组件,并且我们可以在自定义编辑器组件中自由定义输入框的样式和功能。 ### 回答3: ag-grid-react是一个用于创建数据网格的React组件库。它允许我们自定义单元格编辑器,以便满足特定的需求。对于要求带搜索功能的输入框,我们可以创建一个自定义的单元格编辑器组件。 首先,我们可以创建一个名为SearchInput的React组件,该组件包含一个带搜索功能的输入框。在这个组件中,我们可以使用合适的逻辑和UI库来实现搜索功能,例如在输入框中实时过滤并显示匹配的结果。 接下来,我们可以创建一个名为CustomCellEditor的React组件,并在其中使用SearchInput组件作为单元格编辑器。在CustomCellEditor组件中,我们需要实现ag-grid-react提供的ICellEditor接口,并重写相关方法。 在getGui方法中,我们返回SearchInput组件作为单元格编辑器的UI。在getValue方法中,我们可以获取SearchInput组件中输入框的值并返回。在isPopup方法中,我们可以定义是否显示这个单元格编辑器的弹出框。 最后,我们可以将CustomCellEditor组件应用到我们的数据网格中的特定列。在ag-grid-react配置中的columnDefs中,我们可以为需要使用自定义单元格编辑器的列设置cellEditor属性为CustomCellEditor组件。 通过以上步骤,我们可以创建一个带有搜索功能的输入框作为ag-grid-react的自定义单元格编辑器。这样,在网格中的相关列中,当用户需要编辑单元格时,就会显示这个带搜索的输入框。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值