overlayscrollbars-ngx
v0.5.2
Published
OverlayScrollbars for Angular.
Downloads
18,022
Maintainers
Readme
OverlayScrollbars for Angular
This is the official OverlayScrollbars Angular wrapper.
Installation
npm install overlayscrollbars-ngx
Peer Dependencies
OverlayScrollbars for Angular has the following peer dependencies:
- The vanilla JavaScript library: overlayscrollbars
npm install overlayscrollbars
- The Angular framework: @angular/core & @angular/common
npm install @angular/core @angular/common
Usage
The first step is to import the CSS file into your app:
import 'overlayscrollbars/overlayscrollbars.css';
Note: If the path
'overlayscrollbars/overlayscrollbars.css'
is not working use'overlayscrollbars/styles/overlayscrollbars.css'
as the import path for the CSS file.
The module can be imported like:
import { NgModule } from "@angular/core";
import { OverlayscrollbarsModule } from "overlayscrollbars-ngx";
@NgModule({
imports: [OverlayscrollbarsModule],
})
export class AppModule {}
Component
The main entry point is the OverlayScrollbarsComponent
which can be used in your application as a component:
import { OverlayScrollbarsComponent } from "overlayscrollbars-ngx";
The component can be used with two different selectors:
<overlay-scrollbars [defer]="true">
The tag isn't important
</overlay-scrollbars>
<section overlay-scrollbars [defer]="true">
Choose the tag
</section>
Properties
The component accepts all properties of regular elements such as div
and span
.
Additionally it has custom optional properties:
options
: accepts anobject
which represents the OverlayScrollbars options.events
: accepts anobject
which represents the OverlayScrollbars events.defer
: accepts anboolean
orobject
. Defers the initialization to a point in time when the browser is idle.
Note: Its highly recommended to use the
defer
option whenever possible to defer the initialization to a browser's idle period.
<!-- example usage -->
<overlay-scrollbars
[options]="{ scrollbars: { autoHide: 'scroll' } }"
[events]="{ scroll: () => { /* ... */ } }"
[defer]="true"
></overlay-scrollbars>
Events
Additionally to the events
property the OverlayScrollbarsComponent
emits "native" Angular events. To prevent name collisions with DOM events the events have a os
prefix.
Note: It doesn't matter whether you use the
events
property or the Angular events or both.
<!-- example usage -->
<div
overlay-scrollbars
(osInitialized)="onInitialized"
(osUpdated)="onUpdated"
(osDestroyed)="onDestroyed"
(osScroll)="onScroll"
></div>
All events are typed, but you can use the EventListenerArgs
type as utility in case its needed:
import type { EventListenerArgs } from 'overlayscrollbars';
// example listener
const onUpdated = ([instance, onUpdatedArgs]: EventListenerArgs['updated']) => {}
Ref
The ref
of the OverlayScrollbarsComponent
will give you an object with which you can access the OverlayScrollbars instance
and the root element
of the component.
The ref object has two properties:
osInstance
: a function which returns the OverlayScrollbars instance.getElement
: a function which returns the root element.
Directive
In case the OverlayScrollbarsComponent
is not enough, you can also use the OverlayScrollbarsDirective
directive:
import { OverlayScrollbarsDirective } from "overlayscrollbars-ngx";
<!-- example usage -->
<div overlayScrollbars></div>
The directive is for advanced usage and lets you control the whole initialization process. This is useful if you want to integrate it with other plugins.
Note: The directive won't initialize OverlayScrollbars on its own. You have to call the
initialize
function.
Properties
Properties are optional and similar to the OverlayScrollbarsComponent
.
options
: accepts anobject
which represents the OverlayScrollbars options.events
: accepts anobject
which represents the OverlayScrollbars events.defer
: accepts anboolean
orobject
. Defers the initialization to a point in time when the browser is idle.
Instance
The OverlayScrollbarsDirective
exposes two functions:
osInitialize
takes one argument which is theInitializationTarget
.osInstance
returns the current OverlayScrollbars instance ornull
if not initialized.
License
MIT