> ## Documentation Index
> Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# search:pagination

export const LwTemplate = ({title = "Key questions to get you started", icon = "sparkles", cta = "Powered by Agent Studio", linkHref = "https://lucidworks.com/demo/?utm_source=docs&utm_medium=referral&utm_campaign=docs_cta_ai"}) => {
  const [isLoaded, setIsLoaded] = useState(false);
  useEffect(() => {
    const timer = setTimeout(() => {
      setIsLoaded(true);
    }, 500);
    return () => clearTimeout(timer);
  }, []);
  return <div className="lw-template-container">
      <Card title={title} icon={icon}>
        {isLoaded && <span dangerouslySetInnerHTML={{
    __html: `<lw-template id="a029c1a9-28be-427e-b0e1-5d918920246a"></lw-template
            >`
  }} />}
        <Link href={linkHref} className="agent-studio-link text-left text-gray-600 gap-2 dark:text-gray-400 text-sm font-medium flex flex-row items-center hover:text-primary dark:hover:text-primary-light group-hover:text-primary group-hover:dark:text-primary-light">Powered by Lucidworks Agent Studio</Link>
      </Card>
    </div>;
};

[localhost link]: http://localhost:3000/docs/4/app-studio/reference/tags/lightning.directive.searchPagination

[mintlify link]: https://doc.lucidworks.com/docs/4/app-studio/reference/tags/lightning.directive.searchPagination

[old doc.lw link]: https://doc.lucidworks.com/app-studio/4.2/1055

<LwTemplate />

## Description

The pagination directive.

## Usage

as element:

```xml wrap  theme={"dark"}
<search:pagination
       response="{string}"
       [max-pages="{number}"]
       [page-limit="{number}"]
       [first-label="{string}"]
       [show-last="{boolean}"]
       [scroll-to="{string|boolean}"]>
</search:pagination>
```

### Directive info

* This directive creates new scope.

#### Parameters

| Param                     | Type                      | Details                                                                                                                                                                              |
| ------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| response                  | **string**                | The name of the response to use to generate the pagination.                                                                                                                          |
| max-pages  *(optional)*   | **number**                | Maximum number of page links to output (default is 10).                                                                                                                              |
| page-limit  *(optional)*  | **number**                | Maximum limit for which a pagination link is created (e.g. FAST ESP has a default offset limit of \~4000).                                                                           |
| first-label  *(optional)* | **string**                | Label for the link to the first page. Default: '1'                                                                                                                                   |
| show-last  *(optional)*   | **boolean**               | Whether to show a link to the last page. Default: false                                                                                                                              |
| scroll-to  *(optional)*   | **string]link:\[boolean** | The ID of an element to scroll to when the users selects a page. By default it will scroll to the top. You can disable this automatic scrolling by setting this attribute to `false` |

## Example

#### Source

```xml wrap  theme={"dark"}
<h3 id="example_normal">Normal</h3>
<search:pagination response="response" max-pages="3"></search:pagination>
<hr />

<h3 styling="text-center" id="example_center">Center (pagination-wrapper-center)</h3>
<search:pagination response="response" max-pages="3" styling="pagination-wrapper-center"></search:pagination>
<hr />

<h3 style="text-align:right;" id="example_right">Right (pagination-wrapper-right)</h3>
<search:pagination response="response" max-pages="3" styling="pagination-wrapper-right"></search:pagination>
```

```js wrap  theme={"dark"}
angular.module('lightning').controller('ExampleController', ['$scope', 'ResponseService', function($scope, ResponseService) {
    var response = {query:{rpp:10},hits:{act:[0,22555]},page:1};
    ResponseService.setResponse('response',response);
}]);
```

#### Result

<img src="https://mintcdn.com/lucidworks/ENcE8K39c0iEpL8J/assets/images/app-studio/as-examples/tags/searchPagination.png?fit=max&auto=format&n=ENcE8K39c0iEpL8J&q=85&s=801329b4db9ace2b054b611a40d1e738" alt="Result" width="1024" height="413" data-path="assets/images/app-studio/as-examples/tags/searchPagination.png" />
