@riebeckite/plugin-text-fragment 0.0.32 → 0.0.33

package/README.md

@@ -7,6 +7,10 @@ you select in an article.
 
 [日本語](./README_ja.md)
 
+## Live example
+
+Select any sentence on this page. The plugin adds a copy action that produces a URL containing a `#:~:text=` fragment for the selected text.
+
 ## Overview
 
 Client-only plugin. On page load it installs one selection popover with two
@@ -21,17 +25,17 @@ actions:
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { textFragmentPlugin } from "@riebeckite/plugin-text-fragment";
+import { textFragment } from "@riebeckite/plugin-text-fragment";
 
 export default defineConfig({
   // ...
-  plugins: [textFragmentPlugin()],
+  plugins: [textFragment()],
 });
 ```
 
-`textFragmentPlugin()` registers `style.css` and the `initTextFragmentShare`
+`textFragment()` registers `style.css` and the `initTextFragmentShare`
 client entry, which the app calls during page initialization. Pass
-`textFragmentPlugin({ labels })` to override individual UI labels.
+`textFragment({ labels })` to override individual UI labels.
 
 ## Behavior
 
@@ -59,7 +63,7 @@ The fragment follows `#:~:text=[prefix-,]start[,end][,-suffix]`:
 
 ## API
 
-- `textFragmentPlugin(options?)` — plugin factory; `options.labels` overrides
+- `textFragment(options?)` — plugin factory; `options.labels` overrides
   the UI labels
 - `initTextFragmentShare(labels?)` — client initializer (also via
   `@riebeckite/plugin-text-fragment/client`)

package/README_ja.md

@@ -6,6 +6,10 @@
 
 [English](./README.md)
 
+## 実行例
+
+このページの任意の文を選択してください。選択したテキストへの `#:~:text=` フラグメントを含む URL をコピーする操作が追加されます。
+
 ## できること
 
 クライアント専用のプラグインです。ページ表示時に、選択範囲のそばへ小さなポップオーバーを出し、次の二つをコピーできます。
@@ -17,15 +21,15 @@
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { textFragmentPlugin } from "@riebeckite/plugin-text-fragment";
+import { textFragment } from "@riebeckite/plugin-text-fragment";
 
 export default defineConfig({
   // ...
-  plugins: [textFragmentPlugin()],
+  plugins: [textFragment()],
 });
 ```
 
-`textFragmentPlugin()` はスタイルと `initTextFragmentShare` を登録します。初期化処理はアプリのページ初期化時に呼ばれます。`textFragmentPlugin({ labels })` で UI ラベルだけを差し替えられます。
+`textFragment()` はスタイルと `initTextFragmentShare` を登録します。初期化処理はアプリのページ初期化時に呼ばれます。`textFragment({ labels })` で UI ラベルだけを差し替えられます。
 
 ## 挙動
 
@@ -42,12 +46,12 @@ export default defineConfig({
 - `,`、`-`、`&` はパーセントエンコードします（`%2C`、`%2D`、`%26`）。
 - それ以外は UTF-8 単位でエンコードします（改行は `%0A`）。
 - ページ URL に既存のハッシュがあるときは、それを外してからディレクティブを付けます。
-- 200 文字前後より長い選択、または改行を含む選択は、先頭と末尾のトークンによる `start,end` に短縮します。
+- 約 200 文字を超える選択、または改行を含む選択は、先頭と末尾のトークンによる `start,end` に短縮します。
 - 空または空白だけの選択は `""` を返します。
 
 ## 公開 API
 
-- `textFragmentPlugin(options?)`：プラグインファクトリ。`options.labels` で UI ラベルを上書きする
+- `textFragment(options?)`：プラグインファクトリ。`options.labels` で UI ラベルを上書きする
 - `initTextFragmentShare(labels?)`：ブラウザ初期化関数（`@riebeckite/plugin-text-fragment/client` からも読み込める）
 - `encodeTextFragment(text)`：テキスト片をパーセントエンコードする
 - `buildTextFragmentUrl(pageUrl, selection, options?)`：ディープリンクを作る。`options` は `{ prefix?, suffix? }`

package/dist/index.d.ts

@@ -9,4 +9,4 @@ export type TextFragmentPluginOptions = {
  * 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(options?: TextFragmentPluginOptions): RiebeckitePlugin;
+export declare function textFragment(options?: TextFragmentPluginOptions): RiebeckitePlugin;

package/dist/index.js

@@ -272,7 +272,7 @@ function copyWithExecCommand(value) {
 }
 
 // index.ts
-function textFragmentPlugin(options = {}) {
+function textFragment(options = {}) {
   return definePlugin({
     name: "text-fragment",
     assets: [
@@ -300,5 +300,5 @@ export {
   buildTextFragmentUrl,
   encodeTextFragment,
   initTextFragmentShare,
-  textFragmentPlugin
+  textFragment
 };

package/package.json

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