Merge pull request #10 from FallingCeilingS/v0.1.x/expose-apis

Expose apis

Author: jchen042

.npmignore

@@ -4,5 +4,9 @@ examples
 .editorconfig
 babel.config.js
 .eslintrc.js
+babel.config.js
+tsconfig.json
+vue.config.js
 *.gif
-*.log
+*.log
+*.lock

README.md

@@ -6,7 +6,7 @@
 
 > Vue components developed by [Vue.js 3.0](https://v3.vuejs.org/) for efficiently rendering large scrollable lists and hierarchical data. `vue-virtualised` is able to render and update 1 million nodes within a few seconds in front-end.
 
-![Demo](/src/assets/demo-20200415.gif)
+![Demo](/src/assets/demo-20200419.gif)
 
 ## Getting started
 
@@ -191,7 +191,7 @@ scrollToHeight(height: number, behaviour: ScrollBehavior): void
 #### `createNode()`
 
 ```ts
-createNode(nodes: Array<Node | NodeModel>, node: NodeModel, path: Array<number>): void
+createNode(nodes: Array<Node | NodeModel>, node: NodeModel, path: Array<number>): Promise<void>
 ```
 
 This method creates a single node (node allows contain children) as well as its descendants, and it can be bound to the `cell` slot. Valid parameters are:
@@ -264,6 +264,14 @@ This method removes a single node as well as its descendants, and it can be boun
 - `nodes`: `nodes` prop.
 - `path`: The path of the node in the tree structure.
 
+#### `forceUpdate()`
+
+```ts
+forceUpdate(): void
+```
+
+Forces refresh rendered content.
+
 ## Contributing
 
 Pull requests and issues are welcome!

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-virtualised",
-  "version": "0.1.0-4",
+  "version": "0.1.0",
   "private": false,
   "description": "Vue components developed by Vue.js 3.0 for efficiently rendering large scrollable lists and hierarchical data. vue-virtualised is able to render and update 1 million nodes within a few seconds in front-end.",
   "author": {

src/assets/demo-20200331-60fps.gif

@@ -26,7 +26,12 @@
 import { defineComponent, PropType, ref, onMounted } from "vue";
 import VirtualisedBaseScroller from "./Base/VirtualisedBaseScroller.vue";
 
-import { GetNodeHeight, GetNodeKey, CellRenderer } from "../types/types";
+import {
+  GetNodeHeight,
+  GetNodeKey,
+  CellRenderer,
+  ConditionCallback,
+} from "../types/types";
 
 export default defineComponent({
   name: "VirtualisedList",
@@ -73,11 +78,20 @@ export default defineComponent({
   emits: ["onScroll", "onStartReached", "onEndReached"],
   setup(props, { emit }) {
     const scroller = ref<typeof VirtualisedBaseScroller | null>(null);
-    const scrollToStart = ref(null);
-    const scrollToEnd = ref(null);
-    const scrollToIndex = ref(null);
-    const scrollToNode = ref(null);
-    const refreshView = ref(null);
+    const getScrollTop = ref<(() => number) | null>(null);
+    const scrollToStart = ref<(() => void) | null>(null);
+    const scrollToEnd = ref<(() => void) | null>(null);
+    const scrollToHeight = ref<
+      // eslint-disable-next-line no-unused-vars, no-undef
+      ((height: number, behaviour?: ScrollBehavior) => void) | null
+    >(null);
+    // eslint-disable-next-line no-unused-vars
+    const scrollToIndex = ref<((index: number) => void) | null>(null);
+    const scrollToNode = ref<
+      // eslint-disable-next-line no-unused-vars
+      ((conditionCallback: ConditionCallback) => void) | null
+    >(null);
+    const refreshView = ref<(() => void) | null>(null);
 
     const handleScroll = (scrollTop: number): void => {
       emit("onScroll", scrollTop);
@@ -92,17 +106,21 @@ export default defineComponent({
     };
 
     onMounted(() => {
+      getScrollTop.value = scroller.value?.getScrollTop;
       scrollToStart.value = scroller.value?.scrollToStart;
       scrollToEnd.value = scroller.value?.scrollToEnd;
+      scrollToHeight.value = scroller.value?.scrollToHeight;
       scrollToIndex.value = scroller.value?.scrollToIndex;
       scrollToNode.value = scroller.value?.scrollToNode;
       refreshView.value = scroller.value?.refreshView;
     });
 
     return {
       scroller,
+      getScrollTop,
       scrollToStart,
       scrollToEnd,
+      scrollToHeight,
       scrollToIndex,
       scrollToNode,
       handleScroll,