Package Exports

@mr-scroll/vue
@mr-scroll/vue/dist/mr-scroll.common.js
@mr-scroll/vue/dist/mr-scroll.umd.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mr-scroll/vue) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@mr-scroll/vue

The best custom scroll for the web.

This is the vue wrapper. Check here (root of this repo) for an overview on mr-scroll.

Install

npm i @mr-scroll/core @mr-scroll/vue

Note: If you're using css-theming, check the css-theming support package.

Usage

import { createApp } from 'vue';
import Scroll from '@mr-scroll/vue';

const app = createApp(..options);
app.use(Scroll);

import Scroll from '@mr-scroll/vue';

export default {
  name: 'MyComponent',
  components: {
    'mr-scroll': Scroll,
  },
};

Import the global CSS styles (for example in your App.vue):

<style src='@mr-scroll/core/dist/styles.css'></style>

Use mr-scroll component:

<mr-scroll>
  Content
</mr-scroll>

For more general usage info check the README in the root of this repo.