How to get the current page number in AG Grid

Today, we’ll show you how to get the current page number in AG Grid. This will be used for the both client side and server side pagination.

Refer to the following article to implement pagination

• Implement client side pagination in React AG Grid
• Implement server side pagination in React AG Grid

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

Demo Application

Output - How to get the current page number in AG Grid - Clue Mediator

Package Version

ag-grid-react

^25.2.0

ag-grid-community

^25.2.1

Step to get the current page number in AG Grid

1. Add AG Grid in React component
2. Get the Grid API
3. Render the button to get the current page number
4. Output

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 current page number

Here, we will use the `gridApi.paginationGetCurrentPage()` function to get the current page number on 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 currentPage = gridApi.paginationGetCurrentPage();
    console.log('Current Page Number: ', currentPage);
  }

  // ...
  // ...

  return (
    <div class="App">
      <h2>Get the current page number in AG Grid - <a href="https://www.cluemediator.com" target="_blank" rel="noopener">Clue Mediator</a></h2>
      <button class="btn-action" onclick={handleBtnAction}>Get Current Page</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 console log of the current page number.

Note: This function will returns the 0-based index of the page.

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