search

KingSora / OverlayScrollbars

A javascript scrollbar plugin that hides the native scrollbars, provides custom styleable overlay scrollbars, and preserves the native functionality and feel.
https://kingsora.github.io/OverlayScrollbars
MIT License
3.78k stars 214 forks source link

Examples in documentation #544

Closed ricardo-reis-1970 closed 1 year ago

ricardo-reis-1970 commented 1 year ago

As far as I could detect, there are examples for all 5 SPA frameworks / libraries supported. These examples look like fully develop independent projects.

Why are these examples not in the documentation page?

Why must I clone the repo, build each of these examples and open its index.html in order to see it? It does not make much sense that such a visual proposition should not have one of those things thyat are worth a thousand words: a picture.

KingSora commented 1 year ago

Good day @ricardo-reis-1970

Thanks for that suggestion! In the past I was thinking about this as well, but came to the conclusion that pictures aren't really sufficient, because in the end you just see some kind of content with scrollbars attached to it. (Technically you see the same thing on the on the website.)

So I was thinking that developers would be more interested in real examples - thus the examples folder with all of its content. I even set up github codespaces so there isn't a need to clone the repo anymore.

Do you think the examples would become more accessable if I would setup a codesandbox or a stackblitz example?

ricardo-reis-1970 commented 1 year ago

Greetings, King!

I agree that devs would be more interested in real examples, and that's why I (a developer) cloned the repo and had the React one running, although I might have struggled a bit with dependencies and ended up editing package.json into this:

  "dependencies": {
    "overlayscrollbars": "2.2.0",
    "overlayscrollbars-react": "0.5.1",
    "react": "^18.2.0",
    "react-dom": "^18.2.0"
  },

What I meant originally was to have the examples directly in the repository web page https://kingsora.github.io/OverlayScrollbars/. FrontEnd is also inhabited by UI designers whom, in some cases, are non dev-technical and could feel a bit daunted by the task of cloning a repo and making it work.

This way, they could experience the scrolllbars directly. In its current state, the website has no scrollbars in display whatsoever.

And why is this all worth it

Let me just transcribe the reaction of my designer when I told him about your scrollbars last Friday:

I LOVE THE OverlayScrollbars !!!!!
Beautiful !!!

(Please excuse the space before the exclamation marks. He is French.)

KingSora commented 1 year ago

@ricardo-reis-1970 I've finished porting all those examples to SackBlitz so they can be viewed and edited without the need to checkout the repo. I'll need some more time to update the READMEs and the website (I now plan to deploy all the exmaples to it.)

I really appreciate your feedback and fully agree. - I'm also happy your designer likes it :)

KingSora commented 1 year ago

@ricardo-reis-1970 I've created the new Examples Page which lists now all available examples. This page is linked in every README in each package and on the documentation website.

I hope this is sufficient - In case you have any feedback I would be happy to hear it! :)