README.zh-CN.md

v-keep-scroll

English README

在线示例

v-keep-scroll 可以在 activated 和 deactivated 之间保持 keep-alive 组件下的元素的滚动位置。

安装

pnpm add v-keep-scroll

全局引入 （ESM）

import { createApp } from "vue";
import plugin from "v-keep-scroll";
import App from "./App.vue";

const app = createApp(App);
app.use(plugin);
app.mount("#app");

（可选）如果您使用 TypeScript，请在 jsconfig.json 或 tsconfig.json 中添加类型声明以获得类型提示。

{
  "compilerOptions": {
    "types": [
      "v-keep-scroll/types"
    ]
  }
}

全局引入 (CDN)

<script src="https://unpkg.com/vue"></script>
<script src="https://unpkg.com/@vueuse/shared"></script>
<script src="https://unpkg.com/@vueuse/core"></script>
<script src="https://unpkg.com/v-keep-scroll"></script>
<script>
  const app = Vue.createApp(App);
  app.use(vKeepScroll.default);
  app.mount("#app");
</script>

手动引入

import { KeepScroll, vKeepScroll } from "v-keep-scroll";

export default {
  components: { KeepScroll },
  directives: { keepScroll: vKeepScroll },
}

使用方法

无论是针对指令还是组件，它们都应该作用于特定的单个元素，而不是 template 或 teleport 等虚拟元素，并且它们必须设置一个特定的高度并且可滚动。

.scrollable {
  /* 高度应为具体值或有效的百分比 */
  height: 100px; 
  overflow: auto;
}

<!-- CompA -->
<!-- 应用于当前元素 -->
<div class="scrollable" v-keep-scroll>
  <div id="child"></div>
</div>

<!-- CompB -->
<!-- 应用于单个子元素，通过字符串选择器 -->
<div class="scrollable" v-keep-scroll="#child">
  <div id="child"></div>
</div>

<!-- CompC -->
<!-- 应用于多个子元素，通过字符串选择器数组 -->
<div v-keep-scroll="['#child', '.content']">
  <div class="scrollable" id="child"></div>
  <div class="scrollable" id="content"></div>
</div>

<!-- CompD -->
<!-- 通过包装元素应用指令，标签默认为 "div" -->
<keep-scroll tag="div" class="scrollable">
  <div id="child"></div>
</keep-scroll>

<keep-alive>
  <comp-a v-if></comp-a>
  <comp-b v-else-if></comp-b>
  <comp-c v-else-if></comp-c>
  <comp-d v-else></comp-d>
</keep-alive>