Skip to content

Updates to docs, examples and tests. #166

New issue

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

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

Already on GitHub? # to your account

Merged
merged 2 commits into from
May 30, 2022
Merged

Updates to docs, examples and tests. #166

merged 2 commits into from
May 30, 2022

Conversation

jamesrweb
Copy link
Collaborator

Fixes #164.

Proposed Changes

  • Update README to show expected usage of the P5CanvasInstance over the P5Instance type since this will be deprecated in the next major version.
  • Update the code for the example to be more efficient and clean.
  • Add a class to the wrapper for users who wish to target the wrapper or child elements with css. This was of course possible but the change here will make it "easier".

Additional Notes (optional)

Fixes, if you can call it that, #164. I say "if you can call it that" since as I mentioned before, using css or js was previously possible for such use cases and this just makes it a little simpler with a class to specifically target other than P5s own one on the canvas proper.

@jamesrweb jamesrweb added enhancement documentation Pull requests that update project documentation labels May 29, 2022
@jamesrweb jamesrweb requested a review from yevdyko May 29, 2022 15:53
@jamesrweb jamesrweb self-assigned this May 29, 2022
@jamesrweb
Copy link
Collaborator Author

jamesrweb commented May 29, 2022

@yevdyko please ensure you test the documentation examples and the example app itself as part of the review. Thanks in advance 🚀!

@jamesrweb jamesrweb enabled auto-merge (squash) May 29, 2022 15:55
@yevdyko
Copy link
Collaborator

yevdyko commented May 29, 2022

@yevdyko please ensure you test the documentation examples and the example app itself as part of the review. Thanks in advance 🚀!

@jamesrweb the changes look correct in the diff, tomorrow I will check the code in the examples so that it works as expected. Thanks for the improvement and hopefully it will be easier to use the component in the future 💪

Copy link
Collaborator

@yevdyko yevdyko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jamesrweb I've tested the typescript examples from the README as well as the demo application. Everything works as expected, as far as I can see.

🚢 🚢

@jamesrweb jamesrweb merged commit bd61c52 into master May 30, 2022
@jamesrweb jamesrweb deleted the update-examples branch May 30, 2022 22:05
jamesrweb added a commit that referenced this pull request Aug 15, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Pull requests that update project documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Render children on top of canvas
2 participants