@riebeckite/plugin-share 0.0.31 → 0.0.33

package/README.md

@@ -10,6 +10,10 @@ copy-link action is a progressive enhancement.
 
 [日本語](./README_ja.md)
 
+## Live example
+
+The share row at the bottom of this page is the rendered control: social-share links plus the copy-link button that appears after JavaScript loads.
+
 ## Overview
 
 `share()` resolves each note's `permalink` to an absolute URL, composes the
@@ -94,7 +98,7 @@ the optional `className` is added to the root without replacing them.
 ## Exports
 
 - `share(options?)` — plugin factory
-- `sharePlugin` — alias of `share`
+- `share` — alias of `share`
 - `resolveShareOptions(options?)` — apply option defaults
 - `validateShareOptions(options?)` — validate runtime options
 - `buildAbsoluteUrl(config, permalink)` — resolve a note URL to absolute

package/README_ja.md

@@ -2,22 +2,17 @@
 
 <!-- Generated from docs/docs/plugins/share.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-記事ごとの共有ボタンをビルド時に生成するプラグインです。公開対象の各エントリ
-について、設定したサービス向けの共有 URL を組み立て、Share controls のデータ
-を提供します。Site が `<ShareControls links={...} />` を描画する位置をlayout で
-決定します。共有リンクは通常の `<a>` なので JavaScript なしでも動作し、コピー
-操作だけをプログレッシブ・エンハンスメントとして追加します。
+記事ごとの共有ボタンをビルド時に生成するプラグインです。公開対象の各エントリについて、設定したサービス向けの共有 URL を組み立て、共有コントロールのデータを提供します。サイトが `<ShareControls links={...} />` を描画する位置をレイアウトで決めます。共有リンクは通常の `<a>` なので JavaScript なしでも動作し、コピー操作だけをプログレッシブ・エンハンスメントとして追加します。
 
 [English](./README.md)
 
+## 実行例
+
+このページの末尾にある共有リンクの行が、実際に描画されたコントロールです。ソーシャル共有のリンクに加え、JavaScript の読み込み後にコピー用ボタンが表示されます。
+
 ## 仕組み
 
-`share()` は各ノートの `permalink` を絶対 URL に解決し、ノートのタイトルと URL
-からサービスごとの共有 URL を組み立て、Share control data を組み立てます。
-データは `getShareLinks({ entry, site, options? })` で利用可能で、Site が
-`<ShareControls links={...} />` で描画します。共有リンクは通常の `<a>` なので
-JavaScript なしでも動作し、コピー操作だけをプログレッシブ・エンハンスメント
-として追加します。
+`share()` は各ノートの `permalink` を絶対 URL に解決し、タイトルと URL からサービスごとの共有 URL を組み立てて、共有コントロール用のデータにまとめます。データは `getShareLinks({ entry, site, options? })` で取得でき、サイトが `<ShareControls links={...} />` で描画します。共有リンクは通常の `<a>` なので JavaScript なしでも動作し、コピー操作だけをプログレッシブ・エンハンスメントとして追加します。
 
 対応サービスは次のとおりです。
 
@@ -31,8 +26,7 @@ JavaScript なしでも動作し、コピー操作だけをプログレッシブ
 | `hatena` | `https://b.hatena.ne.jp/add?mode=confirm&url=…&title=…` |
 | `copy` | ノートの URL をコピーするボタン（リンクは JS 不要） |
 
-Mastodon はオプトインです。`services` に `"mastodon"` を追加し、
-`mastodonInstance` を設定してください。
+Mastodon はオプトインです。`services` に `"mastodon"` を追加し、`mastodonInstance` を設定してください。
 
 ## 使い方
 
@@ -58,25 +52,15 @@ export default defineConfig({
 | `copiedLabel` | `string` | `"Copied"` | コピー成功時に通知する文言 |
 | `copyFailedLabel` | `string` | `"Copy failed"` | コピー失敗時に通知する文言 |
 
-`services` に `"mastodon"` を含めたのに `mastodonInstance` が未設定の場合、
-`riebeckite check` の時点で設定エラーになります。
+`services` に `"mastodon"` を含めたのに `mastodonInstance` が未設定の場合、`riebeckite check` の時点で設定エラーになります。
 
-## 表示
+## 共有コントロールの表示位置
 
-共有コントロールは、Site が layout で `<ShareControls links={...} />` を
-描画する位置に実際に描画されます。このサイトでは、プログレッシブ・エンハンス
-メントされたリンクコピー操作を含むコントロールとして表示します。Site は
-コントロールを記事のトップやボトム、またはその他の位置に描画するかどうかを
-決定します。
+共有コントロールは、サイトがレイアウトで `<ShareControls links={...} />` を描画する位置に表示されます。このサイトでは、プログレッシブ・エンハンスメントされたリンクコピー操作を含むコントロールとして表示します。サイトはコントロールを記事の上や下、その他の位置のどこに描画するかを決めます。
 
 ## プログレッシブ・エンハンスメント
 
-共有リンクは通常の `<a>` なので、JavaScript を無効にしても動作します。コピー
-ボタンは `hidden` の状態で出力され、アプリのページ初期化時に呼ばれる
-`initShare()` が表示に切り替えます。JavaScript がない読者に、動かない操作を
-見せることはありません。コピーには `navigator.clipboard.writeText` を使い、
-失敗時は非表示の textarea と `document.execCommand("copy")` にフォールバック
-します。結果は `aria-live="polite"` のステータス領域で通知します。
+共有リンクは通常の `<a>` なので、JavaScript を無効にしても動作します。コピーボタンは `hidden` の状態で出力され、アプリのページ初期化時に呼ばれる `initShare()` が表示に切り替えます。JavaScript がない読者に、動かない操作を見せることはありません。コピーには `navigator.clipboard.writeText` を使い、失敗時は非表示の textarea と `document.execCommand("copy")` にフォールバックします。結果は `aria-live="polite"` のステータス領域で通知します。
 
 ## スタイル
 
@@ -86,16 +70,12 @@ export default defineConfig({
 import "@riebeckite/plugin-share/style.css";
 ```
 
-安定したクラスは `rr-share`（ルート）、`rr-share__list`、`rr-share__item`、
-`rr-share__link`、`rr-share__link--{service}`、`rr-share__button`、
-`rr-share__copy`、`rr-share__status` です。Theme はこれらのフックを対象に
-できます。任意の `className` はルートに追加され、これらのフックを置き換え
-ません。
+安定したクラスは `rr-share`（ルート）、`rr-share__list`、`rr-share__item`、`rr-share__link`、`rr-share__link--{service}`、`rr-share__button`、`rr-share__copy`、`rr-share__status` です。テーマはこれらのフックを対象にできます。任意の `className` はルートに追加され、これらのフックを置き換えません。
 
 ## エクスポート
 
 - `share(options?)`：プラグインファクトリ
-- `sharePlugin`：`share` のエイリアス
+- `share`：`share` のエイリアス
 - `resolveShareOptions(options?)`：オプションの既定値を適用する
 - `validateShareOptions(options?)`：実行時オプションを検証する
 - `buildAbsoluteUrl(config, permalink)`：ノート URL を絶対 URL に解決する

package/dist/index.d.ts

@@ -18,5 +18,3 @@ export declare const SHARE_PLUGIN_NAME = "share";
  * JavaScript; only the copy-link action is enhanced at runtime.
  */
 export declare function share(options?: ShareOptions): import("@riebeckite/core").RiebeckitePlugin<ShareOptions>;
-/** Alias matching the `*Plugin` suffix used by other plugin factories. */
-export declare const sharePlugin: typeof share;

package/dist/index.js

@@ -389,7 +389,6 @@ function share(options = {}) {
     ]
   });
 }
-var sharePlugin = share;
 export {
   DEFAULT_SHARE_ARIA_LABEL,
   DEFAULT_SHARE_COPIED_LABEL,
@@ -410,6 +409,5 @@ export {
   renderShareControls,
   resolveShareOptions,
   share,
-  sharePlugin,
   validateShareOptions
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-share",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -27,9 +27,9 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "hono": "^4.12.25",
-    "@riebeckite/core": "0.0.31",
-    "@riebeckite/ui": "0.0.31"
+    "@riebeckite/core": "0.0.33",
+    "@riebeckite/ui": "0.0.33",
+    "hono": "^4.12.25"
   },
   "devDependencies": {
     "tsx": "^4.22.4"