overlayscrollbars-vue v0.5.1

packages/overlayscrollbars-vue/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.1
+
+The TypeScript interfaces `OverlayScrollbarsProps` and `OverlayScrollbarsRef` are exported from the package.
+
 ## 0.5.0
 
 ### Features

packages/overlayscrollbars-vue/README.md

@@ -133,6 +133,7 @@ const Component = {
      * 
      * const options = ref();
      * const events = ref();
+     * const defer = ref();
      * const [initialize, instance] = useOverlayScrollbars({
      *   options,
      *   events,

packages/overlayscrollbars-vue/package.json

@@ -1,7 +1,7 @@
 {
   "name": "overlayscrollbars-vue",
   "private": true,
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "OverlayScrollbars for Vue.",
   "author": "Rene Haas | KingSora",
   "license": "MIT",

packages/overlayscrollbars-vue/src/OverlayScrollbarsComponent.types.ts

@@ -1,9 +1,13 @@
 import type { OverlayScrollbars, PartialOptions, EventListeners } from 'overlayscrollbars';
 
 export interface OverlayScrollbarsComponentProps {
+  /** Tag of the root element. */
   element?: string;
+  /** OverlayScrollbars options. */
   options?: PartialOptions | false | null;
+  /** OverlayScrollbars events. */
   events?: EventListeners | false | null;
+  /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */
   defer?: boolean | IdleRequestOptions;
 }
 

packages/overlayscrollbars-vue/src/overlayscrollbars-vue.ts

@@ -1,2 +1,3 @@
 export { default as OverlayScrollbarsComponent } from './OverlayScrollbarsComponent.vue';
+export * from './OverlayScrollbarsComponent.types';
 export * from './useOverlayScrollbars';