search

electerious / basicScroll

Standalone parallax scrolling for mobile and desktop with CSS variables.
https://basicscroll.electerious.com
MIT License
3.63k stars 148 forks source link

Add typescript #36

Closed jantimon closed 5 years ago

jantimon commented 5 years ago

This library is amazing :)

Would you be up to add typescript for better code quality and easier usage?

That way it would also be possible to ship an additional smaller version of this library which would not validate the parameters during runtime.

electerious commented 5 years ago

Glad you like basicScroll! :)

TypeScript is not planned as I'm not a TypeScript user and therefore not willed to maintain it.

jantimon commented 5 years ago

Okay that’s something I can understand - if you would add some more jsdoc comments that would already be enough for typescript to understand your library.. I could prepare a pull request if that would be interesting for you

electerious commented 5 years ago

That would be cool. Better jsdoc comments are always welcome!

jantimon commented 5 years ago

Cool in that case i’ll look into it and will let you know once I have a pull request to show

jantimon commented 5 years ago

Hey @electerious I added a pull request which will go very in detail and explain the details behind all those object arguments:

https://github.com/electerious/basicScroll/pull/37