Skip to content

Commit

Permalink
Merge pull request #16 from JackBailey/patch-1
Browse files Browse the repository at this point in the history
Provide clarification on how to use Global options and update link
  • Loading branch information
mercs600 authored Oct 17, 2022
2 parents 1d11b14 + bfa2c32 commit 3bcd40a
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@ This plugin will generate a container with ".ps" class name, you need to customi

Install method takes additional parameters:

```js
app.use(PerfectScrollbar, {
watchOptions: true,
options: {
suppressScrollX: true
}
})
```

#### `name {String}`
Name of your global component.

Expand All @@ -77,7 +86,7 @@ Set true if you want to update perfect-scrollbar on options change

**Default**: `false`

#### `options {Object}`: [Options](https://github.com/utatti/perfect-scrollbar#options)
#### `options {Object}`: [Options](https://perfectscrollbar.com/#section-options)
perfect-scrollbar options.

**Default**: `{}`
Expand Down

0 comments on commit 3bcd40a

Please sign in to comment.