Riebeckite
Menu
Color mode

UX

読書中の進捗バー、トップへ戻るボタン、目次のスクロール連動、コードのコピーボタンを実行時に追加する Plugin です。

導入

bash
npm install @riebeckite/plugin-ux

Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は riebeckite.config.ts の plugins に登録して利用します。

使用例

ビルド済みの記事 HTML を変えずに読書体験を高めたい場合に利用します。対象の要素がないページでは、それぞれの機能は何もしません。

ts
ux({ progress: true, backToTop: true, tocScrollSpy: true, codeCopy: true });

使いどころ

この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。

実際の表示例が用意されている場合は、Plugin Showcase でも確認できます。

詳細仕様

設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは Plugin System、Plugin を作る場合は Writing a Plugin を参照してください。

History

1 changesCollapseExpand
1 + # UX
2 +
3 + 読書中の進捗バー、トップへ戻るボタン、目次のスクロール連動、コードのコピーボタンを実行時に追加する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-ux
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + ビルド済みの記事 HTML を変えずに読書体験を高めたい場合に利用します。対象の要素がないページでは、それぞれの機能は何もしません。
16 +
17 + ```ts
18 + ux({ progress: true, backToTop: true, tocScrollSpy: true, codeCopy: true });
19 + ```
20 +
21 + ## 使いどころ
22 +
23 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
24 +
25 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.ja.md) でも確認できます。
26 +
27 + ## 詳細仕様
28 +
29 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。
30 +