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

Update docs to more clearly indicate usage #52

Open
MaximumMaxxx opened this issue Jul 5, 2023 · 2 comments
Open

Update docs to more clearly indicate usage #52

MaximumMaxxx opened this issue Jul 5, 2023 · 2 comments

Comments

@MaximumMaxxx
Copy link

MaximumMaxxx commented Jul 5, 2023

Hello,

If you only rely on the documentation from NPM or the project's website, you might encounter a problem where the component appears broken because the container size isn't big enough. It would be a good idea to update the docs to include styling instructions, so that if someone copies the code, the project won't look broken.

Current docs:
image

Proposed change:
Screenshot 2023-07-05

@MaximumMaxxx
Copy link
Author

Alternatively instead of inline styles you could add a section about styling and include the css like in the demo

<style>
	.scrolly-video-container {
		height: 300vh;
	}
</style>

@tarsisexistence
Copy link
Contributor

@MaximumMaxxx isn't the proposed solution wrong in terms of applying height on the video (or canvas) element instead of the container?

We can probably highlight this for every usage in README by wrapping the scrolly video element with a container of 300vh.

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

No branches or pull requests

2 participants