@riebeckite/plugin-text-fragment 0.0.14 → 0.0.15

package/README.md

@@ -10,10 +10,10 @@ you select in an article.
 Client-only plugin. On page load it installs one selection popover with two
 actions:
 
-- **リンクをコピー** — builds a URL with a
+- **Copy link** — 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.
+- **Copy quote** — builds a Markdown block quote with a link back to the page.
 
 ## Usage
 
@@ -28,7 +28,8 @@ export default defineConfig({
 ```
 
 `textFragmentPlugin()` registers `style.css` and the `initTextFragmentShare`
-client entry, which the app calls during page initialization.
+client entry, which the app calls during page initialization. Pass
+`textFragmentPlugin({ labels })` to override individual UI labels.
 
 ## Behavior
 
@@ -56,15 +57,19 @@ The fragment follows `#:~:text=[prefix-,]start[,end][,-suffix]`:
 
 ## API
 
-- `textFragmentPlugin()` — plugin factory
-- `initTextFragmentShare()` — client initializer (also via
+- `textFragmentPlugin(options?)` — plugin factory; `options.labels` overrides
+  the UI labels
+- `initTextFragmentShare(labels?)` — 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`
+- `DEFAULT_TEXT_FRAGMENT_LABELS` — the default English UI labels
+- Types: `TextFragmentOptions`, `TextFragmentLabels`,
+  `TextFragmentPluginOptions`
 
 ## See also
 
-- [Plugin guide](../../../docs/en/reference/plugin-api.md)
+- [Plugin guide](../../../docs/en/docs/reference/plugin-api.md)
+

package/README_ja.md

@@ -8,8 +8,8 @@
 
 クライアント専用のプラグインです。ページ表示時に、選択範囲のそばへ小さなポップオーバーを出し、次の二つをコピーできます。
 
-- **リンクをコピー**: 選択したテキストをハイライトする [Text Fragment](https://wicg.github.io/scroll-to-text-fragment/) 付き URL を作ります。
-- **引用をコピー**: ページへのリンク付きで Markdown の引用ブロックを作ります。
+- **Copy link**: 選択したテキストをハイライトする [Text Fragment](https://wicg.github.io/scroll-to-text-fragment/) 付き URL を作ります。
+- **Copy quote**: ページへのリンク付きで Markdown の引用ブロックを作ります。
 
 ## 設定する
 
@@ -23,7 +23,7 @@ export default defineConfig({
 });
 ```
 
-`textFragmentPlugin()` はスタイルと `initTextFragmentShare` を登録します。初期化処理はアプリのページ初期化時に呼ばれます。
+`textFragmentPlugin()` はスタイルと `initTextFragmentShare` を登録します。初期化処理はアプリのページ初期化時に呼ばれます。`textFragmentPlugin({ labels })` で UI ラベルだけを差し替えられます。
 
 ## 挙動
 
@@ -45,13 +45,15 @@ export default defineConfig({
 
 ## 公開 API
 
-- `textFragmentPlugin()` — プラグインファクトリ
-- `initTextFragmentShare()` — ブラウザ初期化関数（`@riebeckite/plugin-text-fragment/client` からも読み込める）
+- `textFragmentPlugin(options?)` — プラグインファクトリ。`options.labels` で UI ラベルを上書きする
+- `initTextFragmentShare(labels?)` — ブラウザ初期化関数（`@riebeckite/plugin-text-fragment/client` からも読み込める）
 - `encodeTextFragment(text)` — テキスト片をパーセントエンコードする
 - `buildTextFragmentUrl(pageUrl, selection, options?)` — ディープリンクを作る。`options` は `{ prefix?, suffix? }`
 - `buildQuoteMarkdown({ url, title, selection })` — 引用ブロックを作る
-- `TextFragmentOptions` — オプションの型
+- `DEFAULT_TEXT_FRAGMENT_LABELS` — 既定の英語 UI ラベル
+- `TextFragmentOptions`、`TextFragmentLabels`、`TextFragmentPluginOptions` — 型
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/ja/reference/plugin-api.md)
+- [プラグインシステム](../../../docs/ja/docs/reference/plugin-api.md)
+

package/dist/client.d.ts

@@ -1 +1 @@
-export { initTextFragmentShare } from "./src/text-fragment.client.js";
+export { DEFAULT_TEXT_FRAGMENT_LABELS, initTextFragmentShare, type TextFragmentLabels, } from "./src/text-fragment.client.js";

package/dist/client.js

@@ -53,20 +53,29 @@ function stripUrlFragment(url) {
 var ARTICLE_SELECTOR = "[data-slot='article-body'], .rb-article-body, .prose, article";
 var EXCLUDED_SELECTOR = "pre, code, a[href], [data-no-share]";
 var POPOVER_GAP = 8;
+var DEFAULT_TEXT_FRAGMENT_LABELS = {
+  regionLabel: "Share selected text",
+  copyLinkLabel: "Copy link",
+  copyQuoteLabel: "Copy quote",
+  linkCopiedLabel: "Link copied",
+  quoteCopiedLabel: "Quote copied",
+  copyFailedLabel: "Could not copy. Select the text again."
+};
 var initialized = false;
-function initTextFragmentShare() {
+function initTextFragmentShare(labels = {}) {
   if (typeof document === "undefined") return;
   if (initialized) return;
   initialized = true;
+  const resolved = { ...DEFAULT_TEXT_FRAGMENT_LABELS, ...labels };
   const popover = document.createElement("div");
   popover.className = "rr-text-fragment";
   popover.hidden = true;
   popover.setAttribute("role", "group");
-  popover.setAttribute("aria-label", "選択したテキストを共有");
+  popover.setAttribute("aria-label", resolved.regionLabel);
   const actions = document.createElement("div");
   actions.className = "rr-text-fragment__actions";
-  const linkButton = createButton("リンクをコピー");
-  const quoteButton = createButton("引用をコピー");
+  const linkButton = createButton(resolved.copyLinkLabel);
+  const quoteButton = createButton(resolved.copyQuoteLabel);
   const status = document.createElement("p");
   status.className = "rr-text-fragment__status";
   status.setAttribute("role", "status");
@@ -104,7 +113,7 @@ function initTextFragmentShare() {
     isCopying = true;
     try {
       const copied = await copyToClipboard(buildValue(selection.text));
-      status.textContent = copied ? successMessage : "コピーできませんでした。テキストを選び直してください。";
+      status.textContent = copied ? successMessage : resolved.copyFailedLabel;
       active = selection;
       popover.hidden = false;
       positionPopover(popover, selection.rect);
@@ -117,7 +126,7 @@ function initTextFragmentShare() {
   linkButton.addEventListener("click", () => {
     void copy(
       (selection) => buildTextFragmentUrl(resolvePageUrl(), selection),
-      "リンクをコピーしました"
+      resolved.linkCopiedLabel
     );
   });
   quoteButton.addEventListener("click", () => {
@@ -127,7 +136,7 @@ function initTextFragmentShare() {
         title: document.title,
         selection
       }),
-      "引用をコピーしました"
+      resolved.quoteCopiedLabel
     );
   });
   popover.addEventListener("mousedown", (event) => event.preventDefault());
@@ -232,5 +241,6 @@ function copyWithExecCommand(value) {
   return copied;
 }
 export {
+  DEFAULT_TEXT_FRAGMENT_LABELS,
   initTextFragmentShare
 };

package/dist/index.d.ts

@@ -1,8 +1,12 @@
 import { type RiebeckitePlugin } from "@riebeckite/core";
-export { initTextFragmentShare } from "./src/text-fragment.client.js";
+import { type TextFragmentLabels } from "./src/text-fragment.client.js";
+export { DEFAULT_TEXT_FRAGMENT_LABELS, initTextFragmentShare, type TextFragmentLabels, } from "./src/text-fragment.client.js";
 export { buildQuoteMarkdown, buildTextFragmentUrl, encodeTextFragment, type TextFragmentOptions, } from "./src/text-fragment.js";
+export type TextFragmentPluginOptions = {
+    labels?: Partial<TextFragmentLabels>;
+};
 /**
  * Registers the client-only text fragment share plugin: a selection popover
  * that copies a `#:~:text=` deep link or a Markdown quote.
  */
-export declare function textFragmentPlugin(): RiebeckitePlugin;
+export declare function textFragmentPlugin(options?: TextFragmentPluginOptions): RiebeckitePlugin;

package/dist/index.js

@@ -60,20 +60,29 @@ function stripUrlFragment(url) {
 var ARTICLE_SELECTOR = "[data-slot='article-body'], .rb-article-body, .prose, article";
 var EXCLUDED_SELECTOR = "pre, code, a[href], [data-no-share]";
 var POPOVER_GAP = 8;
+var DEFAULT_TEXT_FRAGMENT_LABELS = {
+  regionLabel: "Share selected text",
+  copyLinkLabel: "Copy link",
+  copyQuoteLabel: "Copy quote",
+  linkCopiedLabel: "Link copied",
+  quoteCopiedLabel: "Quote copied",
+  copyFailedLabel: "Could not copy. Select the text again."
+};
 var initialized = false;
-function initTextFragmentShare() {
+function initTextFragmentShare(labels = {}) {
   if (typeof document === "undefined") return;
   if (initialized) return;
   initialized = true;
+  const resolved = { ...DEFAULT_TEXT_FRAGMENT_LABELS, ...labels };
   const popover = document.createElement("div");
   popover.className = "rr-text-fragment";
   popover.hidden = true;
   popover.setAttribute("role", "group");
-  popover.setAttribute("aria-label", "選択したテキストを共有");
+  popover.setAttribute("aria-label", resolved.regionLabel);
   const actions = document.createElement("div");
   actions.className = "rr-text-fragment__actions";
-  const linkButton = createButton("リンクをコピー");
-  const quoteButton = createButton("引用をコピー");
+  const linkButton = createButton(resolved.copyLinkLabel);
+  const quoteButton = createButton(resolved.copyQuoteLabel);
   const status = document.createElement("p");
   status.className = "rr-text-fragment__status";
   status.setAttribute("role", "status");
@@ -111,7 +120,7 @@ function initTextFragmentShare() {
     isCopying = true;
     try {
       const copied = await copyToClipboard(buildValue(selection.text));
-      status.textContent = copied ? successMessage : "コピーできませんでした。テキストを選び直してください。";
+      status.textContent = copied ? successMessage : resolved.copyFailedLabel;
       active = selection;
       popover.hidden = false;
       positionPopover(popover, selection.rect);
@@ -124,7 +133,7 @@ function initTextFragmentShare() {
   linkButton.addEventListener("click", () => {
     void copy(
       (selection) => buildTextFragmentUrl(resolvePageUrl(), selection),
-      "リンクをコピーしました"
+      resolved.linkCopiedLabel
     );
   });
   quoteButton.addEventListener("click", () => {
@@ -134,7 +143,7 @@ function initTextFragmentShare() {
         title: document.title,
         selection
       }),
-      "引用をコピーしました"
+      resolved.quoteCopiedLabel
     );
   });
   popover.addEventListener("mousedown", (event) => event.preventDefault());
@@ -240,16 +249,20 @@ function copyWithExecCommand(value) {
 }
 
 // index.ts
-function textFragmentPlugin() {
+function textFragmentPlugin(options = {}) {
   return definePlugin({
     name: "text-fragment",
     assets: [createStyleAsset("text-fragment")],
     clientEntries: [
-      createClientEntry("text-fragment", "initTextFragmentShare")
+      createClientEntry("text-fragment", "initTextFragmentShare", {
+        ...DEFAULT_TEXT_FRAGMENT_LABELS,
+        ...options.labels
+      })
     ]
   });
 }
 export {
+  DEFAULT_TEXT_FRAGMENT_LABELS,
   buildQuoteMarkdown,
   buildTextFragmentUrl,
   encodeTextFragment,

package/dist/src/text-fragment.client.d.ts

@@ -1,8 +1,17 @@
+export type TextFragmentLabels = {
+    regionLabel: string;
+    copyLinkLabel: string;
+    copyQuoteLabel: string;
+    linkCopiedLabel: string;
+    quoteCopiedLabel: string;
+    copyFailedLabel: string;
+};
+export declare const DEFAULT_TEXT_FRAGMENT_LABELS: TextFragmentLabels;
 /**
- * Enables a popover with "リンクをコピー" (text fragment deep link) and
- * "引用をコピー" (Markdown quote) actions for the current text selection.
+ * Enables a popover with copy-link (Text Fragment deep link) and copy-quote
+ * (Markdown quote) actions for the current text selection.
  *
  * Client-only: returns immediately when there is no `document`, and only wires
  * its listeners once per page.
  */
-export declare function initTextFragmentShare(): void;
+export declare function initTextFragmentShare(labels?: Partial<TextFragmentLabels>): void;

package/package.json

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