How to get the pagination page size in React AG Grid

We'll demonstrate the process to get the pagination page size in React AG Grid. This will be used for the both client side and server side pagination.

Refer to the following article to implement pagination

Here, we will add button to get the pagination page size from the AG Grid on button click event.

Demo Application

Output - How to get the pagination page size in React AG Grid - Clue Mediator

Package Version

ag-grid-react

^25.2.0

ag-grid-community

^25.2.1

1. Add AG Grid in React component

Let’s create a react application using the `create-react-app` and implement AG Grid in React. Check the following article for more information.

How to implement AG Grid in React

2. Get the Grid API

In the next step, we need to fetch the Grid API to perform the action. Refer to the following article to get the Grid API & Column API.

How to get Grid API and Column API in AG Grid

3. Render the button to get the page size

Here, we will use the `gridApi.paginationGetPageSize()` function to get the page size of the paginated grid on a button click. Refer the following code for the more information.

function App() {

  const [gridApi, setGridApi] = useState(null);

  const onGridReady = (e) => {
    setGridApi(e.api);
  }

  const handleBtnAction = () => {
    const pageSize = gridApi.paginationGetPageSize();
    console.log('Page size: ', pageSize);
  }

  // ...
  // ...

  return (
    <div class="App">
      <h2>Get the pagination page size in AG Grid - <a href="https://www.cluemediator.com" target="_blank" rel="noopener">Clue Mediator</a></h2>
      <button class="btn-action" onclick={handleBtnAction}>Get Page Size</button>
      <div class="ag-theme-alpine ag-style">
        <aggridreact ...="" pagination={true} paginationpagesize={5} ongridready={onGridReady}>
          ...
          ...
        </aggridreact>
      </div>
    </div>
  );
}

export default App;

Here, we have added the log of the page size in the console window.

4. Output

Run the React application and check the output in the browser.

I hope you find this article helpful.
Thank you for reading. Happy Coding..!! 🙂

Demo & Source Code

GitHub Repository StackBlitz Project