メインコンテンツまでスキップ
バージョン: v2 Next 🚧

インターフェイス: PaginateOptions

定義: plugins/utils/src/paginate.ts:49

拡張

プロパティ

anyone?

optional anyone?: boolean;

定義: plugins/utils/src/paginate.ts:59

誰でも押せるようにする。

Default

false

buttons?

optional buttons?: PaginationButtons;

定義: plugins/utils/src/paginate.ts:38

ボタンの見た目。

Default

テーマの pagination

継承元

PaginationLook.buttons


counter?

optional counter?: (current, total) => string;

定義: plugins/utils/src/paginate.ts:40

中央の現在位置表示。

パラメータ

current

number

total

number

戻り値

string

Default

テーマの pagination.counter

継承元

PaginationLook.counter


counterStyle?

optional counterStyle?: ButtonStyle;

定義: plugins/utils/src/paginate.ts:42

中央の現在位置ボタンの色。

Default

テーマの pagination.counterStyle

継承元

PaginationLook.counterStyle


ephemeral?

optional ephemeral?: boolean;

定義: plugins/utils/src/paginate.ts:61

本人にだけ見える返信にする(インタラクションのみ)。

Default

false

pages

pages: readonly Page[];

定義: plugins/utils/src/paginate.ts:51

表示するページ。chunk() と組み合わせると配列から簡単に作れます。


showCounter?

optional showCounter?: boolean;

定義: plugins/utils/src/paginate.ts:44

現在位置ボタンを出す。

Default

テーマの pagination.showCounter(true)

継承元

PaginationLook.showCounter


startPage?

optional startPage?: number;

定義: plugins/utils/src/paginate.ts:55

最初に表示するページ(1 始まり)。

Default

1

theme?

optional theme?: object;

定義: plugins/utils/src/paginate.ts:46

この呼び出しだけテーマを上書きする。

colors?

optional colors?: object;
colors.error?
optional error?: number;
colors.info?
optional info?: number;
colors.success?
optional success?: number;
colors.warning?
optional warning?: number;

confirm?

optional confirm?: object;
confirm.no?
optional no?: object;
confirm.no.emoji?
optional emoji?: string;
confirm.no.label?
optional label?: string;
confirm.no.style?
optional style?: ButtonStyle;
confirm.timeout?
optional timeout?: DurationInput;

応答を待つ時間。

confirm.yes?
optional yes?: object;
confirm.yes.emoji?
optional emoji?: string;
confirm.yes.label?
optional label?: string;
confirm.yes.style?
optional style?: ButtonStyle;

duration?

optional duration?: object;
duration.clock?
optional clock?: object;

formatDuration の時計表記(区切り・ゼロ埋め)。

duration.clock.alwaysHours?
optional alwaysHours?: boolean;

1時間未満でも時を出す。

Default

defaultTheme.duration.clock.alwaysHours(false)

duration.clock.pad?
optional pad?: string;

分・秒を2桁に揃える文字。

Default

defaultTheme.duration.clock.pad("0")

duration.clock.separator?
optional separator?: string;

時・分・秒の区切り。

Default

defaultTheme.duration.clock.separator(":")

duration.max?
optional max?: number;

既定で出す単位の数。

duration.separator?
optional separator?: string;

単位のあいだに挟む文字列。

duration.units?
optional units?: object;

humanizeDuration が使う単位。日本語にするならここ。

duration.units.d?
optional d?: string;
duration.units.h?
optional h?: string;
duration.units.m?
optional m?: string;
duration.units.ms?
optional ms?: string;
duration.units.s?
optional s?: string;

pagination?

optional pagination?: object;
pagination.counter?
optional counter?: (current, total) => string;

中央に出す現在位置の文字列。

パラメータ
current

number

total

number

戻り値

string

pagination.counterStyle?
optional counterStyle?: ButtonStyle;
pagination.first?
optional first?: object;
pagination.first.emoji?
optional emoji?: string;
pagination.first.label?
optional label?: string;
pagination.first.style?
optional style?: ButtonStyle;
pagination.last?
optional last?: object;
pagination.last.emoji?
optional emoji?: string;
pagination.last.label?
optional label?: string;
pagination.last.style?
optional style?: ButtonStyle;
pagination.next?
optional next?: object;
pagination.next.emoji?
optional emoji?: string;
pagination.next.label?
optional label?: string;
pagination.next.style?
optional style?: ButtonStyle;
pagination.prev?
optional prev?: object;
pagination.prev.emoji?
optional emoji?: string;
pagination.prev.label?
optional label?: string;
pagination.prev.style?
optional style?: ButtonStyle;
pagination.showCounter?
optional showCounter?: boolean;

現在位置のボタンを出すか。

pagination.timeout?
optional timeout?: DurationInput;

無操作でボタンを無効化するまでの時間。

progress?

optional progress?: object;
progress.empty?
optional empty?: string;
progress.filled?
optional filled?: string;
progress.width?
optional width?: number;

text?

optional text?: object;
text.ellipsis?
optional ellipsis?: string;

truncate が末尾に付ける文字列。

継承元

PaginationLook.theme


timeout?

optional timeout?: DurationInput;

定義: plugins/utils/src/paginate.ts:53

無操作でこの時間が過ぎるとボタンを無効化します。

Default

テーマの pagination.timeout("2m")


userId?

optional userId?: string;

定義: plugins/utils/src/paginate.ts:57

押せるユーザー。

Default

呼び出したユーザー