Movatterモバイル変換

necordjs/paginationPublic

generated fromSocketSomeone/nestjs-open-source-template

NotificationsYou must be signed in to change notification settings
Fork2
Star16

📃 A lightweight Pagination module for Necord

necord.org/recipes/pagination

License

MIT license

16 stars 2 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 795 Commits
.github		.github
.husky		.husky
src		src
test		test
.commitlintrc.json		.commitlintrc.json
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.prettierrc		.prettierrc
.release-it.json		.release-it.json
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
eslint.config.mjs		eslint.config.mjs
jest.config.json		jest.config.json
package.json		package.json
tsconfig.build.json		tsconfig.build.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Repository files navigation

📜 A lightweight Pagination module forNecord

Documentation ✨ Source code 🪡 Examples 🛠️ Community 💬

About

Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured andmanageable way. When dealing with substantial volumes of data, such as search results, articles, or product listings, presenting it all atonce can overwhelm users and lead to a poor user experience. Pagination allows you to divide the information into smaller, organized chunks,enhancing user engagement and ease of navigation. This module allows you to create a pagination with a few lines of code.

Installation

Node.js 18.0.0 or newer is required.

$ npm i @necord/pagination necord discord.js$ yarn add @necord/pagination necord discord.js$ pnpm add @necord/pagination necord discord.js

Usage

Once the installation process is complete, we can import theNecordPaginationModule with yourNecordModule into the rootAppModule:

import{NecordModule}from'necord';import{Module}from'@nestjs/common';import{NecordPaginationModule}from'@necord/pagination';import{AppService}from'./app.service';@Module({imports:[NecordModule.forRoot({token:'DISCORD_BOT_TOKEN',intents:['Guilds','GuildMessages','DirectMessages']}),NecordPaginationModule.forRoot({// Change your buttons appearancebuttons:{},// Add buttons for skip to first and last pageallowSkip:true,// Add buttons for search pageallowTraversal:true,// Define the buttons position (start / end)buttonsPosition:'end'})],providers:[AppService]})exportclassAppModule{}

Then, we can inject thePaginationService into our service and register a pagination handler:

import{OnModuleInit,Injectable}from'@nestjs/common';import{NecordPaginationService,PageBuilder}from'@necord/pagination';import{Context,SlashCommand,SlashCommandContext}from'necord';@Injectable()exportclassAppServiceimplementsOnModuleInit{publicconstructor(privatereadonlypaginationService:NecordPaginationService){}publiconModuleInit():void{returnthis.paginationService.register(builder=>builder// Required, need for search your builder.setCustomId('test')// First way to set pages.setPages([newPageBuilder().setContent('Page 1'),newPageBuilder().setContent('Page 2'),newPageBuilder().setContent('Page 3'),newPageBuilder().setContent('Page 4'),newPageBuilder().setContent('Page 5')])// Second way, you can manually set pages using `setPages` method.setPagesFactory(page=>newPageBuilder().setContent(`Page${page}`))// Optional, only if you want to use pages factory.setMaxPages(5));}    @SlashCommand({name:'pagination',description:'Test pagination'})publicasynconPagination(@Context()[interaction]:SlashCommandContext){constpagination=this.paginationService.get('test');constpage=awaitpagination.build();returninteraction.reply(page);}}

Congratulations! You have successfully created your first pagination!Just usepagination command and you will see your pagination!

Registering Pagination Inside Command

You can also register pagination's dynamically inside your command handlers instead ofonModuleInit hook.

import{Injectable}from"@nestjs/common";import{NecordPaginationService,PageBuilder}from"@necord/pagination";import{Context,SlashCommand,SlashCommandContext}from"necord";@Injectable()exportclassAppService{publicconstructor(privatereadonlypaginationService:NecordPaginationService){}    @SlashCommand({name:"dynamic-pagination",description:"Register pagination inside command"})publicasynconDynamicPagination(@Context()[interaction]:SlashCommandContext){constpagination=this.paginationService.create(builder=>builder.setCustomId(`dynamic-${interaction.user.id}`).setFilter(i=>i.user.id===interaction.user.id).setPages([newPageBuilder().setContent("Dynamic Page 1"),newPageBuilder().setContent("Dynamic Page 2")]));constpage=awaitpagination.build();returninteraction.reply(page);}}