https://github.com/nhn/tui.pagination
Component that automatically calculate and generate page numbers.
https://github.com/nhn/tui.pagination
component
Last synced: 3 months ago
JSON representation
Component that automatically calculate and generate page numbers.
- Host: GitHub
- URL: https://github.com/nhn/tui.pagination
- Owner: nhn
- License: mit
- Created: 2015-05-06T09:20:07.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T13:43:42.000Z (over 2 years ago)
- Last Synced: 2025-05-24T00:08:02.416Z (5 months ago)
- Topics: component
- Language: JavaScript
- Homepage: https://nhn.github.io/tui.pagination/latest/
- Size: 4.73 MB
- Stars: 53
- Watchers: 16
- Forks: 24
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TOAST UI Component : Pagination
> Component that automatically calculate and generate page numbers.
[](https://github.com/nhn/tui.pagination/releases/latest)
[](https://www.npmjs.com/package/tui-pagination)
[](https://github.com/nhn/tui.pagination/blob/production/LICENSE)
[](https://github.com/nhn/tui.project-name/labels/help%20wanted)
[](https://github.com/nhn)
## 🚩 Table of Contents
- [Collect statistics on the use of open source](#collect-statistics-on-the-use-of-open-source)
- [📙 Documents](#-documents)
- [🎨 Features](#-features)
- [🐾 Examples](#-examples)
- [💾 Install](#-install)
- [Via Package Manager](#via-package-manager)
- [npm](#npm)
- [bower](#bower)
- [Via Contents Delivery Network (CDN)](#via-contents-delivery-network-cdn)
- [Download Source Files](#download-source-files)
- [🔨 Usage](#-usage)
- [HTML](#html)
- [JavaScript](#javascript)
- [Using namespace in browser environment](#using-namespace-in-browser-environment)
- [Using module format in node environment](#using-module-format-in-node-environment)
- [🌏 Browser Support](#-browser-support)
- [🔧 Pull Request Steps](#-pull-request-steps)
- [Setup](#setup)
- [Develop](#develop)
- [Running dev server](#running-dev-server)
- [Running test](#running-test)
- [Pull Request](#pull-request)
- [💬 Contributing](#-contributing)
- [🍞 TOAST UI Family](#-toast-ui-family)
- [📜 License](#-license)
## Collect statistics on the use of open source
TOAST UI Pagination applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Pagination is used throughout the world.
It also serves as important index to determine the future course of projects.
`location.hostname` (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage.
To disable GA, use the following `usageStatistics` option when creating the instance.
```js
const options = {
...
usageStatistics: false
}
const instance = new Pagination(container, options);
```
Or, include [`tui-code-snippet`](https://github.com/nhn/tui.code-snippet)(**v2.2.0** or **later**) and then immediately write the options as follows:
```js
tui.usageStatistics = false;
```
## 📙 Documents
* [Getting Started](https://github.com/nhn/tui.pagination/blob/production/docs/getting-started.md)
* [Tutorials](https://github.com/nhn/tui.pagination/tree/production/docs)
* [APIs](https://nhn.github.io/tui.pagination/latest)
You can also see the older versions of API page on the [releases page](https://github.com/nhn/tui.pagination/releases).
## 🎨 Features
* Creates page number buttons.
* Creates previous, next, first, and last buttons.
* Supports templates.
* Supports custom events.
* Provides the file of default css style.
## 🐾 Examples
* [Basic](https://nhn.github.io/tui.pagination/latest/tutorial-example01-basic) : Example of using default options.
More examples can be found on the left sidebar of each example page, and have fun with it.
## 💾 Install
TOAST UI products can be used by using the package manager or downloading the source directly.
However, we highly recommend using the package manager.
### Via Package Manager
TOAST UI products are registered in two package managers, [npm](https://www.npmjs.com/) and [bower](https://bower.io/).
You can conveniently install it using the commands provided by each package manager.
When using npm, be sure to use it in the environment [Node.js](https://nodejs.org/ko/) is installed.
#### npm
``` sh
$ npm install --save tui-pagination # Latest version
$ npm install --save tui-pagination@ # Specific version
```
#### bower
``` sh
$ bower install tui-pagination # Latest version
$ bower install tui-pagination# # Specific version
```
### Via Contents Delivery Network (CDN)
TOAST UI products are available over the CDN powered by [TOAST Cloud](https://www.toast.com).
You can use the CDN as below.
```html
```
If you want to use a specific version, use the tag name instead of `latest` in the url's path.
The CDN directory has the following structure.
```
tui.pagination/
├─ latest/
│ ├─ tui-pagination.css
│ ├─ tui-pagination.js
│ ├─ tui-pagination.min.css
│ └─ tui-pagination.min.js
├─ v3.2.0/
│ ├─ ...
```
### Download Source Files
* [Download bundle files](https://github.com/nhn/tui.pagination/tree/production/dist)
* [Download all sources for each version](https://github.com/nhn/tui.pagination/releases)
## 🔨 Usage
### HTML
Add the container element to create the component. A wrapper element should have `tui-pagination` as a class name to apply tui-pagination's style.
``` html
```
### JavaScript
This component can be used by creating an instance with the constructor function.
To get the constructor function, you should import the module using one of the following ways depending on your environment.
#### Using namespace in browser environment
``` javascript
const Pagination = tui.Pagination;
```
#### Using module format in node environment
``` javascript
const Pagination = require('tui-pagination'); /* CommonJS */
```
``` javascript
import Pagination from 'tui-pagination'; /* ES6 */
```
You can create an instance with [options](https://nhn.github.io/tui.pagination/latest/Pagination) and call various APIs after creating an instance.
``` javascript
const container = document.getElementById('tui-pagination-container');
const instance = new Pagination(container, { ... });
instance.getCurrentPage();
```
For more information about the API, please see [here](https://nhn.github.io/tui.pagination/latest/Pagination).
## 🌏 Browser Support
| 
Chrome | 
Internet Explorer | 
Edge | 
Safari | 
Firefox |
| :---------: | :---------: | :---------: | :---------: | :---------: |
| Yes | 8+ | Yes | Yes | Yes |
## 🔧 Pull Request Steps
TOAST UI products are open source, so you can create a pull request(PR) after you fix issues.
Run npm scripts and develop yourself with the following process.
### Setup
Fork `develop` branch into your personal repository.
Clone it to local computer. Install node modules.
Before starting development, you should check if there are any errors.
``` sh
$ git clone https://github.com/{your-personal-repo}/tui.pagination.git
$ cd tui.pagination
$ npm install
$ npm run test
```
### Develop
Let's start development!
You can see your code reflected as soon as you save the code by running a server.
Don't miss adding test cases and then make green rights.
#### Running dev server
``` sh
$ npm run serve
$ npm run serve:ie8 # Run on Internet Explorer 8
```
#### Running test
``` sh
$ npm run test
```
### Pull Request
Before uploading your PR, run test one last time to check if there are any errors.
If it has no errors, commit and then push it!
For more information on PR's steps, please see links in the Contributing section.
## 💬 Contributing
* [Code of Conduct](https://github.com/nhn/tui.pagination/blob/production/CODE_OF_CONDUCT.md)
* [Contributing guideline](https://github.com/nhn/tui.pagination/blob/production/CONTRIBUTING.md)
* [Issue guideline](https://github.com/nhn/tui.pagination/blob/production/docs/ISSUE_TEMPLATE.md)
* [Commit convention](https://github.com/nhn/tui.pagination/blob/production/docs/COMMIT_MESSAGE_CONVENTION.md)
## 🍞 TOAST UI Family
* [TOAST UI Editor](https://github.com/nhn/tui.editor)
* [TOAST UI Calendar](https://github.com/nhn/tui.calendar)
* [TOAST UI Chart](https://github.com/nhn/tui.chart)
* [TOAST UI Image-Editor](https://github.com/nhn/tui.image-editor)
* [TOAST UI Grid](https://github.com/nhn/tui.grid)
* [TOAST UI Components](https://github.com/nhn)
## 📜 License
This software is licensed under the [MIT](https://github.com/nhn/tui.pagination/blob/production/LICENSE) © [NHN Cloud](https://github.com/nhn).