@rspress/plugin-medium-zoom 0.0.0-next-20230815052558

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rspress
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,26 @@
+<p align="center">
+  <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
+</p>
+
+<h1 align="center">Modern.js Doc</h1>
+
+<p align="center">
+ The Documentation Framework of Modern.js.
+</p>
+
+## Getting Started
+
+Please follow [Quick Start](https://modernjs.dev/doc-tools/guide/getting-started.html) to get started with Modern.js Doc.
+
+## Documentation
+
+- [English Documentation](https://modernjs.dev/doc-tools/)
+- [中文文档](https://modernjs.dev/doc-tools/zh/)
+
+## Contributing
+
+Please read the [Contributing Guide](https://github.com/web-infra-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/web-infra-dev/modern.js/blob/main/LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { RspressPlugin } from '@rspress/shared';
+
+/**
+ * The plugin is used to add medium-zoom to the doc site.
+ */
+declare function pluginMediumZoom(): RspressPlugin;
+
+export { pluginMediumZoom };

package/dist/index.js

@@ -0,0 +1,17 @@
+// src/index.ts
+import path from "path";
+import { fileURLToPath } from "url";
+function pluginMediumZoom() {
+  const __dirname = path.dirname(fileURLToPath(import.meta.url)).replace(/\\/g, "/");
+  return {
+    name: "@rspress/plugin-medium-zoom",
+    globalUIComponents: [
+      path.posix.join(__dirname, "../src/components/MediumZoom.tsx")
+    ]
+  };
+}
+export {
+  pluginMediumZoom
+};
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"mappings":";AAAA,OAAOA,UAAU;AACjB,SAASC,qBAAqB;AAMvB,SAASC;AACd,QAAMC,YAAYH,KACfI,QAAQH,cAAc,YAAYI,GAAG,GAErCC,QAAQ,OAAO;AAClB,SAAO;IACLC,MAAM;IACNC,oBAAoB;MAClBR,KAAKS,MAAMC,KAAKP,WAAW;;EAE/B;AACF;","names":["path","fileURLToPath","pluginMediumZoom","__dirname","dirname","url","replace","name","globalUIComponents","posix","join"],"sources":["../src/home/runner/work/rspress/rspress/packages/plugin-medium-zoom/src/index.ts"],"sourcesContent":["import path from 'path';\nimport { fileURLToPath } from 'url';\nimport type { RspressPlugin } from '@rspress/shared';\n\n/**\n * The plugin is used to add medium-zoom to the doc site.\n */\nexport function pluginMediumZoom(): RspressPlugin {\n  const __dirname = path\n    .dirname(fileURLToPath(import.meta.url))\n    // Fix: adapt windows\n    .replace(/\\\\/g, '/');\n  return {\n    name: '@rspress/plugin-medium-zoom',\n    globalUIComponents: [\n      path.posix.join(__dirname, '../src/components/MediumZoom.tsx'),\n    ],\n  };\n}\n"]}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@rspress/plugin-medium-zoom",
+  "version": "0.0.0-next-20230815052558",
+  "description": "A plugin for rspress to zoom images in docs.",
+  "bugs": "https://github.com/web-infra-dev/rspress/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rspress",
+    "directory": "packages/plugin-medium-zoom"
+  },
+  "license": "MIT",
+  "type": "module",
+  "jsnext:source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/node/index.js",
+  "engines": {
+    "node": ">=14.17.6"
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "dist/"
+  ],
+  "devDependencies": {
+    "@modern-js/tsconfig": "2.30.0",
+    "@types/node": "^18.11.17",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "typescript": "^5",
+    "vitest": "0.33.0",
+    "react": "^17",
+    "@rspress/shared": "0.0.0-next-20230815052558"
+  },
+  "peerDependencies": {
+    "rspress": "0.0.0-next-20230815052558"
+  },
+  "sideEffects": [
+    "*.css",
+    "*.less",
+    "*.sass",
+    "*.scss"
+  ],
+  "files": [
+    "dist",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "medium-zoom": "1.0.8"
+  },
+  "scripts": {
+    "dev": "modern dev",
+    "build": "modern build",
+    "reset": "rimraf ./**/node_modules",
+    "lint": "modern lint",
+    "change": "modern change",
+    "bump": "modern bump",
+    "pre": "modern pre",
+    "change-status": "modern change-status",
+    "gen-release-note": "modern gen-release-note",
+    "release": "modern release",
+    "new": "modern new",
+    "test": "vitest run --passWithNoTests",
+    "upgrade": "modern upgrade"
+  }
+}

package/src/.eslintrc.cjs

@@ -0,0 +1,10 @@
+// eslint-disable-next-line import/no-commonjs
+module.exports = {
+  root: true,
+  extends: ['@modern-js-app'],
+  ignorePatterns: ['components/MediumZoom.tsx'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['../tsconfig.json'],
+  },
+};

package/src/components/MediumZoom.css

@@ -0,0 +1,5 @@
+/* https://github.com/francoischalifour/medium-zoom#debugging */
+.medium-zoom-overlay,
+.medium-zoom-image--opened {
+  z-index: 999;
+}

package/src/components/MediumZoom.tsx

@@ -0,0 +1,19 @@
+import { useLocation } from 'rspress/runtime';
+import mediumZoom from 'medium-zoom';
+import { useEffect } from 'react';
+import './MediumZoom.css';
+
+interface Props {
+  selector?: string;
+}
+
+export default function MediumZoom(props: Props) {
+  const { pathname } = useLocation();
+  const { selector = '.modern-doc img' } = props;
+
+  useEffect(() => {
+    const images = document.querySelectorAll(selector);
+    mediumZoom(images);
+  }, [pathname]);
+  return null;
+}

package/src/index.ts

@@ -0,0 +1,19 @@
+import path from 'path';
+import { fileURLToPath } from 'url';
+import type { RspressPlugin } from '@rspress/shared';
+
+/**
+ * The plugin is used to add medium-zoom to the doc site.
+ */
+export function pluginMediumZoom(): RspressPlugin {
+  const __dirname = path
+    .dirname(fileURLToPath(import.meta.url))
+    // Fix: adapt windows
+    .replace(/\\/g, '/');
+  return {
+    name: '@rspress/plugin-medium-zoom',
+    globalUIComponents: [
+      path.posix.join(__dirname, '../src/components/MediumZoom.tsx'),
+    ],
+  };
+}

package/src/modern-app-env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types='@modern-js/module-tools/types' />
+/// <reference types='@modern-js/plugin-testing/types' />