mirror of https://github.com/yui540/comimi.git synced 2026-07-25 09:16:55 +03:00

Mirror of github.com/yui540/comimi https://yui540.com/comimi

TypeScript 100%

Find a file

yui540 1f3a8a2fa4 バージョンを0.18.0に更新		2026-07-07 11:10:39 +09:00
assets	READMEとドキュメントを追加	2026-05-24 14:16:40 +09:00
docs	URLクエリパラメータから開始ページを指定できるinitialPageQueryParamオプションを追加	2026-07-07 11:10:27 +09:00
examples/preview	URLクエリパラメータから開始ページを指定できるinitialPageQueryParamオプションを追加	2026-07-07 11:10:27 +09:00
locales	色をCSSカスタムプロパティに集約しダークテーマを実装（設定パネルにテーマ選択を追加、背景色UIを削除）	2026-06-12 12:34:37 +09:00
src	URLクエリパラメータから開始ページを指定できるinitialPageQueryParamオプションを追加	2026-07-07 11:10:27 +09:00
.gitignore	プロジェクト雛形を追加	2026-05-24 14:14:35 +09:00
LICENSE	MITライセンスを追加	2026-05-24 22:35:30 +09:00
package-lock.json	バージョンを0.18.0に更新	2026-07-07 11:10:39 +09:00
package.json	バージョンを0.18.0に更新	2026-07-07 11:10:39 +09:00
README.md	READMEの更新	2026-05-25 09:24:32 +09:00
tsconfig.build.json	プロジェクト雛形を追加	2026-05-24 14:14:35 +09:00
tsconfig.json	プロジェクト雛形を追加	2026-05-24 14:14:35 +09:00
vite.config.ts	プロジェクト雛形を追加	2026-05-24 14:14:35 +09:00

README.md

comimi

comimiは、Webサイトに漫画ビューワーを組み込むことができるTypeScript/JavaScriptライブラリです。

ReactなどのUIライブラリに依存していないため、単体で動作します。

https://github.com/user-attachments/assets/3e37b9fb-6381-4f43-9b27-7ae8056a1905

yui540.com/comimi

インストール

npm install @yui540/comimi

クイックスタート

import { createMangaViewer } from "@yui540/comimi";

createMangaViewer(document.querySelector("#viewer")!, {
  manga: {
    id: "sample",
    title: "サンプル漫画",
    author: "yui540",
    pages: [
      { id: "p0", type: "image", src: "/pages/0.webp" },
      { id: "p1", type: "image", src: "/pages/1.webp" },
      { id: "p2", type: "image", src: "/pages/2.webp" },
    ],
  },
});

これが最小構成です。ビューワーは #viewer にマウントされ、DOMを自動的に管理します。戻り値のインスタンスを通じて、ページ送りや設定・イベント操作も行えます。

ドキュメント

APIの詳細、オプション、設定、キーボードショートカット、永続化、i18n については docs/USAGE.md に記載しています。

ライセンス

MIT