Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation is such a Shame … #509

Closed
Aeneon opened this issue Mar 8, 2023 · 2 comments
Closed

Documentation is such a Shame … #509

Aeneon opened this issue Mar 8, 2023 · 2 comments

Comments

@Aeneon
Copy link

Aeneon commented Mar 8, 2023

Hi,

please improve the Documentation. OS is the only "Plugin" I have on my WordPress Site, which uses this stupid Microsoft Scrap of TypeScript. I don't want to learn a new Language only for a few Lines of Code. How can I add the SizeObserverPlugin in jQuery ? I'm trying it for Hours now and it's frustrating …

Cheers,
Aeneon

@KingSora
Copy link
Owner

KingSora commented Mar 8, 2023

Good day @Aeneon :)

You can add it like:

var SizeObserverPlugin = OverlayScrollbarsGlobal.SizeObserverPlugin;
var OverlayScrollbars = OverlayScrollbarsGlobal.OverlayScrollbars;

OverlayScrollbars.plugin(SizeObserverPlugin);

@KingSora
Copy link
Owner

KingSora commented Mar 8, 2023

I've improved the documentation in that regard:

The Manual download & embedding section is not an expander anymore. At the bottom of the section I've clarified that you can use the OverlayScrollbarsGlobal object in the global browser environment and the import syntax in nodejs / modules. Both are equivalent though and the documentation will use the import syntax in all examples.

Do you think that change is enough?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants