@riebeckite/plugin-text-fragment 0.0.12 → 0.0.14

package/README.md

@@ -1,70 +1,70 @@
-# @riebeckite/plugin-text-fragment
-
-Copy a Text Fragment deep link (`#:~:text=`) or a Markdown quote for the text
-you select in an article.
-
-[日本語](./README_ja.md)
-
-## Overview
-
-Client-only plugin. On page load it installs one selection popover with two
-actions:
-
-- **リンクをコピー** — builds a URL with a
-  [Text Fragment directive](https://wicg.github.io/scroll-to-text-fragment/)
-  that highlights the selected text.
-- **引用をコピー** — builds a Markdown block quote with a link back to the page.
-
-## Usage
-
-```ts
-import { defineConfig } from "@riebeckite/core";
-import { textFragmentPlugin } from "@riebeckite/plugin-text-fragment";
-
-export default defineConfig({
-  // ...
-  plugins: [textFragmentPlugin()],
-});
-```
-
-`textFragmentPlugin()` registers `style.css` and the `initTextFragmentShare`
-client entry, which the app calls during page initialization.
-
-## Behavior
-
-- A non-empty selection inside the article body shows the popover near the
-  selection. Selections inside `pre`, `code`, `a[href]`, or `[data-no-share]`
-  are ignored.
-- Both actions write to the clipboard through `navigator.clipboard.writeText`
-  and fall back to a hidden textarea with `document.execCommand("copy")`.
-- Failures are announced in a visible `aria-live="polite"` status region.
-- `Escape` or a click outside closes the popover. The buttons are real
-  `<button>` elements, so they are reachable with the keyboard.
-- The popover is installed once per page and does nothing when there is no
-  `document` (SSR-safe).
-
-### URL rules
-
-The fragment follows `#:~:text=[prefix-,]start[,end][,-suffix]`:
-
-- `,`, `-` and `&` are percent-encoded (`%2C`, `%2D`, `%26`).
-- Other characters are encoded per UTF-8 (newlines become `%0A`).
-- An existing hash on the page URL is dropped before the directive is appended.
-- Selections longer than ~200 characters or containing a newline are reduced to
-  a `start,end` range built from the first and last token.
-- An empty or whitespace-only selection produces `""`.
-
-## API
-
-- `textFragmentPlugin()` — plugin factory
-- `initTextFragmentShare()` — client initializer (also via
-  `@riebeckite/plugin-text-fragment/client`)
-- `encodeTextFragment(text)` — percent-encodes one text fragment term
-- `buildTextFragmentUrl(pageUrl, selection, options?)` — builds the deep link;
-  `options` is `{ prefix?, suffix? }`
-- `buildQuoteMarkdown({ url, title, selection })` — builds the Markdown quote
-- Type: `TextFragmentOptions`
-
-## See also
-
-- [Plugin guide](../../../docs/en/plugin-system.md)
+# @riebeckite/plugin-text-fragment
+
+Copy a Text Fragment deep link (`#:~:text=`) or a Markdown quote for the text
+you select in an article.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+Client-only plugin. On page load it installs one selection popover with two
+actions:
+
+- **リンクをコピー** — builds a URL with a
+  [Text Fragment directive](https://wicg.github.io/scroll-to-text-fragment/)
+  that highlights the selected text.
+- **引用をコピー** — builds a Markdown block quote with a link back to the page.
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { textFragmentPlugin } from "@riebeckite/plugin-text-fragment";
+
+export default defineConfig({
+  // ...
+  plugins: [textFragmentPlugin()],
+});
+```
+
+`textFragmentPlugin()` registers `style.css` and the `initTextFragmentShare`
+client entry, which the app calls during page initialization.
+
+## Behavior
+
+- A non-empty selection inside the article body shows the popover near the
+  selection. Selections inside `pre`, `code`, `a[href]`, or `[data-no-share]`
+  are ignored.
+- Both actions write to the clipboard through `navigator.clipboard.writeText`
+  and fall back to a hidden textarea with `document.execCommand("copy")`.
+- Failures are announced in a visible `aria-live="polite"` status region.
+- `Escape` or a click outside closes the popover. The buttons are real
+  `<button>` elements, so they are reachable with the keyboard.
+- The popover is installed once per page and does nothing when there is no
+  `document` (SSR-safe).
+
+### URL rules
+
+The fragment follows `#:~:text=[prefix-,]start[,end][,-suffix]`:
+
+- `,`, `-` and `&` are percent-encoded (`%2C`, `%2D`, `%26`).
+- Other characters are encoded per UTF-8 (newlines become `%0A`).
+- An existing hash on the page URL is dropped before the directive is appended.
+- Selections longer than ~200 characters or containing a newline are reduced to
+  a `start,end` range built from the first and last token.
+- An empty or whitespace-only selection produces `""`.
+
+## API
+
+- `textFragmentPlugin()` — plugin factory
+- `initTextFragmentShare()` — client initializer (also via
+  `@riebeckite/plugin-text-fragment/client`)
+- `encodeTextFragment(text)` — percent-encodes one text fragment term
+- `buildTextFragmentUrl(pageUrl, selection, options?)` — builds the deep link;
+  `options` is `{ prefix?, suffix? }`
+- `buildQuoteMarkdown({ url, title, selection })` — builds the Markdown quote
+- Type: `TextFragmentOptions`
+
+## See also
+
+- [Plugin guide](../../../docs/en/reference/plugin-api.md)

package/README_ja.md

@@ -1,57 +1,57 @@
-# @riebeckite/plugin-text-fragment
-
-記事内で選択したテキストから、Text Fragment のディープリンク（`#:~:text=`）と Markdown の引用を作るプラグインです。
-
-[English](./README.md)
-
-## できること
-
-クライアント専用のプラグインです。ページ表示時に、選択範囲のそばへ小さなポップオーバーを出し、次の二つをコピーできます。
-
-- **リンクをコピー**: 選択したテキストをハイライトする [Text Fragment](https://wicg.github.io/scroll-to-text-fragment/) 付き URL を作ります。
-- **引用をコピー**: ページへのリンク付きで Markdown の引用ブロックを作ります。
-
-## 設定する
-
-```ts
-import { defineConfig } from "@riebeckite/core";
-import { textFragmentPlugin } from "@riebeckite/plugin-text-fragment";
-
-export default defineConfig({
-  // ...
-  plugins: [textFragmentPlugin()],
-});
-```
-
-`textFragmentPlugin()` はスタイルと `initTextFragmentShare` を登録します。初期化処理はアプリのページ初期化時に呼ばれます。
-
-## 挙動
-
-- 記事本文内でテキストを選択すると、そのそばにポップオーバーが出ます。`pre`、`code`、`a[href]`、`[data-no-share]` の中の選択は対象外です。
-- コピーは `navigator.clipboard.writeText` を使い、失敗時は隠し textarea と `document.execCommand("copy")` に切り替えます。
-- コピーに失敗したときは `aria-live="polite"` の領域にメッセージを表示します。
-- `Escape` またはポップオーバーの外側をクリックすると閉じます。ボタンは実体の `<button>` なのでキーボードでも操作できます。
-- 初期化はページごとに一度だけで、`document` が無い環境では何もしません。
-
-### URL の規則
-
-フラグメントは `#:~:text=[prefix-,]start[,end][,-suffix]` に従います。
-
-- `,`、`-`、`&` はパーセントエンコードします（`%2C`、`%2D`、`%26`）。
-- それ以外は UTF-8 単位でエンコードします（改行は `%0A`）。
-- ページ URL に既存のハッシュがあるときは、それを外してからディレクティブを付けます。
-- 200 文字前後より長い選択、または改行を含む選択は、先頭と末尾のトークンによる `start,end` に短縮します。
-- 空または空白だけの選択は `""` を返します。
-
-## 公開 API
-
-- `textFragmentPlugin()` — プラグインファクトリ
-- `initTextFragmentShare()` — ブラウザ初期化関数（`@riebeckite/plugin-text-fragment/client` からも読み込める）
-- `encodeTextFragment(text)` — テキスト片をパーセントエンコードする
-- `buildTextFragmentUrl(pageUrl, selection, options?)` — ディープリンクを作る。`options` は `{ prefix?, suffix? }`
-- `buildQuoteMarkdown({ url, title, selection })` — 引用ブロックを作る
-- `TextFragmentOptions` — オプションの型
-
-## 関連資料
-
-- [プラグインシステム](../../../docs/ja/plugin-system.md)
+# @riebeckite/plugin-text-fragment
+
+記事内で選択したテキストから、Text Fragment のディープリンク（`#:~:text=`）と Markdown の引用を作るプラグインです。
+
+[English](./README.md)
+
+## できること
+
+クライアント専用のプラグインです。ページ表示時に、選択範囲のそばへ小さなポップオーバーを出し、次の二つをコピーできます。
+
+- **リンクをコピー**: 選択したテキストをハイライトする [Text Fragment](https://wicg.github.io/scroll-to-text-fragment/) 付き URL を作ります。
+- **引用をコピー**: ページへのリンク付きで Markdown の引用ブロックを作ります。
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { textFragmentPlugin } from "@riebeckite/plugin-text-fragment";
+
+export default defineConfig({
+  // ...
+  plugins: [textFragmentPlugin()],
+});
+```
+
+`textFragmentPlugin()` はスタイルと `initTextFragmentShare` を登録します。初期化処理はアプリのページ初期化時に呼ばれます。
+
+## 挙動
+
+- 記事本文内でテキストを選択すると、そのそばにポップオーバーが出ます。`pre`、`code`、`a[href]`、`[data-no-share]` の中の選択は対象外です。
+- コピーは `navigator.clipboard.writeText` を使い、失敗時は隠し textarea と `document.execCommand("copy")` に切り替えます。
+- コピーに失敗したときは `aria-live="polite"` の領域にメッセージを表示します。
+- `Escape` またはポップオーバーの外側をクリックすると閉じます。ボタンは実体の `<button>` なのでキーボードでも操作できます。
+- 初期化はページごとに一度だけで、`document` が無い環境では何もしません。
+
+### URL の規則
+
+フラグメントは `#:~:text=[prefix-,]start[,end][,-suffix]` に従います。
+
+- `,`、`-`、`&` はパーセントエンコードします（`%2C`、`%2D`、`%26`）。
+- それ以外は UTF-8 単位でエンコードします（改行は `%0A`）。
+- ページ URL に既存のハッシュがあるときは、それを外してからディレクティブを付けます。
+- 200 文字前後より長い選択、または改行を含む選択は、先頭と末尾のトークンによる `start,end` に短縮します。
+- 空または空白だけの選択は `""` を返します。
+
+## 公開 API
+
+- `textFragmentPlugin()` — プラグインファクトリ
+- `initTextFragmentShare()` — ブラウザ初期化関数（`@riebeckite/plugin-text-fragment/client` からも読み込める）
+- `encodeTextFragment(text)` — テキスト片をパーセントエンコードする
+- `buildTextFragmentUrl(pageUrl, selection, options?)` — ディープリンクを作る。`options` は `{ prefix?, suffix? }`
+- `buildQuoteMarkdown({ url, title, selection })` — 引用ブロックを作る
+- `TextFragmentOptions` — オプションの型
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/reference/plugin-api.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-text-fragment",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,7 +21,7 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.12"
+    "@riebeckite/core": "0.0.14"
   },
   "devDependencies": {
     "tsx": "^4.22.4"