@riebeckite/plugin-ux 0.0.32 → 0.0.33

package/README.md

@@ -8,6 +8,10 @@ and table-of-contents scroll-spy at runtime.
 
 [日本語](./README_ja.md)
 
+## Live example
+
+A reading-progress bar runs along the top of this page, and a back-to-top button appears once you scroll. The **Contents** rail also follows the current section.
+
 ## Features
 
 - **Reading progress bar** — a thin fixed bar (`.rb-ux__progress`) that follows
@@ -25,12 +29,12 @@ idempotent.
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { uxPlugin } from "@riebeckite/plugin-ux";
+import { ux } from "@riebeckite/plugin-ux";
 
 export default defineConfig({
   // ...
   plugins: [
-    uxPlugin({
+    ux({
       progress: true,
       backToTop: true,
       tocScrollSpy: true,
@@ -96,7 +100,7 @@ Styles ship as `@riebeckite/plugin-ux/style.css` and use the theme's
 
 ## Exports
 
-- `uxPlugin(options?)` / `ux(options?)` — plugin factory
+- `ux(options?)` / `ux(options?)` — plugin factory
 - `initUx` — browser initializer
 - Types: `UxOptions`, `UxResolvedConfig`
 

package/README_ja.md

@@ -6,10 +6,14 @@
 
 [English](./README.md)
 
+## 実行例
+
+このページの上部には読書プログレスバーが表示され、スクロールするとトップへ戻るボタンが現れます。**Contents** の目次も現在のセクションに追従します。
+
 ## できること
 
 - **読み進捗バー**: 画面上部に固定した細いバー（`.rb-ux__progress`）が記事のスクロール量に追従します。
-- **トップへ戻るボタン**: 一定量スクロールすると表示される button 要素（`.rb-ux__back-to-top`）。`aria-label` を持ち、スムーズスクロールで先頭へ戻ります。
+- **トップへ戻るボタン**: 一定量スクロールすると表示される `button` 要素（`.rb-ux__back-to-top`）。`aria-label` を持ち、スムーズスクロールで先頭へ戻ります。
 - **目次のスクロール連動**: 記事の目次コンテナ内の `a[href^="#"]` を `IntersectionObserver` で監視し、現在位置の見出しリンクに `.rb-ux__toc-active` を付けます。
 
 いずれも対応する DOM が無いページでは何もしません。`initUx()` は何度呼んでも二重に初期化しません。
@@ -18,12 +22,12 @@
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { uxPlugin } from "@riebeckite/plugin-ux";
+import { ux } from "@riebeckite/plugin-ux";
 
 export default defineConfig({
   // ...
   plugins: [
-    uxPlugin({
+    ux({
       progress: true,
       backToTop: true,
       tocScrollSpy: true,
@@ -33,7 +37,7 @@ export default defineConfig({
 });
 ```
 
-`uxPlugin` は `ux` という別名でもエクスポートしています。
+`ux` は `ux` という別名でもエクスポートしています。
 
 ## オプション
 
@@ -48,7 +52,7 @@ export default defineConfig({
 
 クライアント側の初期化コードは静的にバンドルされ、プラグインのオプションを直接受け取れません。そのためこのプラグインは、ビルド時に各記事 HTML の先頭へ不活性な JSON 設定要素を挿入します。これは実装用のデータであり、記事本文には表示しません。
 
-`initUx()` はこの要素を読み取って設定を復元します。要素が無い場合は全機能が有効な既定値で動作します。挿入は `onPostProcessed` で行い、`onManifestCreated` でも未挿入の記事エントリへ反映します。挿入はページごとに一度だけで、`data-rb-ux-config` を目印に重複挿入を防ぎます。
+`initUx()` はこの要素を読み取って設定を復元します。要素が無い場合は全機能が有効な既定値で動作します。挿入は `onPostProcessed` で行い、`onManifestCreated` でも未挿入の記事エントリへ反映します。挿入はページごとに 1 回だけで、`data-rb-ux-config` を目印に重複挿入を防ぎます。
 
 ## 出力される HTML / CSS フック
 
@@ -56,7 +60,7 @@ export default defineConfig({
 | --- | --- |
 | `rb-ux__progress` | 進捗バーのトラック（`role="progressbar"`） |
 | `rb-ux__progress-bar` | 進捗に応じて `scaleX` されるバー |
-| `rb-ux__back-to-top` | トップへ戻る button |
+| `rb-ux__back-to-top` | トップへ戻るボタン |
 | `rb-ux__back-to-top--visible` | 表示状態のとき付与 |
 | `rb-ux__toc-active` | 現在位置の目次リンク |
 
@@ -78,7 +82,7 @@ export default defineConfig({
 
 ## 主なエクスポート
 
-- `uxPlugin(options?)` / `ux(options?)`: プラグインを作成する
+- `ux(options?)` / `ux(options?)`: プラグインを作成する
 - `initUx`: クライアント側の初期化
 - 型: `UxOptions`、`UxResolvedConfig`
 

package/dist/index.d.ts

@@ -7,6 +7,4 @@ export type { UxOptions, UxResolvedConfig } from "./src/options.js";
  * None of the features change the rendered article markup, so the plugin
  * only injects a JSON config element and registers a browser initializer.
  */
-export declare function uxPlugin(options?: UxOptions): import("@riebeckite/core").RiebeckitePlugin<UxOptions>;
-/** Alias kept for naming symmetry with the other plugin factories. */
-export declare const ux: typeof uxPlugin;
+export declare function ux(options?: UxOptions): import("@riebeckite/core").RiebeckitePlugin<UxOptions>;

package/dist/index.js

@@ -43,7 +43,7 @@ function injectUxConfig(html, config) {
 }
 
 // index.ts
-function uxPlugin(options = {}) {
+function ux(options = {}) {
   const config = resolveUxConfig(options);
   return definePlugin({
     name: "ux",
@@ -69,7 +69,6 @@ function uxPlugin(options = {}) {
     }
   });
 }
-var ux = uxPlugin;
 function validateUxOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -87,6 +86,5 @@ function validateUxOptions(options) {
   return issues;
 }
 export {
-  ux,
-  uxPlugin
+  ux
 };

package/dist/src/inject.d.ts

@@ -1,13 +1,4 @@
 import { type UxResolvedConfig } from "./options.js";
-/**
- * Serializes the resolved options into an inert JSON script element.
- *
- * Client initializers are static and receive no plugin options, so the build
- * injects this element into the article HTML and reads it back at runtime.
- * `escapeScriptJson` neutralizes `<`, `>`, `&`, U+2028 and U+2029 so labels
- * can never terminate the script element.
- */
-export declare function renderUxConfigElement(config: UxResolvedConfig): string;
 /**
  * Prepends the configuration element exactly once.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-ux",
-  "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"
   },
   "publishConfig": {
     "access": "public"