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.

Sign up for GitHub

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

Jump to bottom

fix: update documentation for ref #37

Merged
merged 1 commit into from
Jul 30, 2022
Merged

fix: update documentation for ref #37

merged 1 commit into from
Jul 30, 2022

Conversation

roerohan
Copy link
Owner

Description

Create a ref using useRef in the README sample.

Resolved issues

#35

Before submitting the PR, please take the following into consideration

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. If you don't have an issue, please create one.
  • Prefix your PR title with feat: , fix: , chore: , docs:, or refactor:.
  • The description should clearly illustrate what problems it solves.
  • Ensure that the commit messages follow our guidelines.
  • Resolve merge conflicts (if any).
  • Make sure that the current branch is upto date with the main branch.

@roerohan roerohan self-assigned this Jul 30, 2022
@roerohan roerohan merged commit 3bbe643 into main Jul 30, 2022
@roerohan roerohan deleted the fix-deps branch July 30, 2022 11:05
@roerohan roerohan added the documentation Improvements or additions to documentation label Jul 30, 2022
github-actions bot pushed a commit that referenced this pull request Jul 30, 2022
@semantic-release-bot
chore(release): 0.5.2 [skip ci]
d814843 
## [0.5.2](v0.5.1...v0.5.2) (2022-07-30)

### Bug Fixes

* update documentation for ref ([#37](#37)) ([3bbe643](3bbe643))

skip-checks: true
@github-actions
Copy link
Contributor

🎉 This PR is included in version 0.5.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions bot pushed a commit to isaiahbjork/allyson-react-vnc that referenced this pull request Jan 31, 2025
@semantic-release-bot
chore(release): 1.0.0 [skip ci]
e3b0af6 
# 1.0.0 (2025-01-31)

### Bug Fixes

* Add className prop ([6c45100](6c45100))
* add entries to npmignore and update submodule ([roerohan#8](https://github.com/isaiahbjork/allyson-react-vnc/issues/8)) ([4096c1a](4096c1a))
* add types to exports to avoid typescript error in import ([5147009](5147009))
* Add warning about ws:// URL ([3d1b024](3d1b024))
* added npm test action and fixed failing tests ([roerohan#14](https://github.com/isaiahbjork/allyson-react-vnc/issues/14)) ([990eb86](990eb86))
* **autoConnect:** auto connect timeout issues fixed ([8678abf](8678abf))
* Clone submodule before publish ([61a99c1](61a99c1))
* **config:** added configurable retry duration and logging ([roerohan#11](https://github.com/isaiahbjork/allyson-react-vnc/issues/11)) ([25c2e4e](25c2e4e)), closes [roerohan#3](https://github.com/isaiahbjork/allyson-react-vnc/issues/3)
* create release ([2422cad](2422cad))
* create release v1 ([72de428](72de428))
* **cron:** update cron job to 00:00 everyday ([roerohan#10](https://github.com/isaiahbjork/allyson-react-vnc/issues/10)) ([1fae558](1fae558))
* **forwardRef:** forward connect(), disconnect() and connected from VncScreen ([roerohan#20](https://github.com/isaiahbjork/allyson-react-vnc/issues/20)) ([9392ab3](9392ab3))
* **funding:** update funding.yml ([b4488f8](b4488f8))
* Linting issues in rollup.config.js ([eb748c8](eb748c8))
* Missing bracket ([44ee0d7](44ee0d7))
* name of step ([1191534](1191534))
* **onDesktopName:** made params optional ([a246aca](a246aca))
* **pr-template:** added PR template ([4a618fe](4a618fe))
* **pr-template:** added PR template ([11d358f](11d358f))
* **prepublish:** added module, and exports in prepublish script ([roerohan#21](https://github.com/isaiahbjork/allyson-react-vnc/issues/21)) ([611b86a](611b86a))
* publish script ([86912ed](86912ed))
* **publish:** allow publishing through repository dispatch ([5dbd528](5dbd528))
* react-scripts peer dep modified ([roerohan#1](https://github.com/isaiahbjork/allyson-react-vnc/issues/1)) ([b0af45c](b0af45c))
* **release:** do not publish tarball inside the dist folder ([roerohan#12](https://github.com/isaiahbjork/allyson-react-vnc/issues/12)) ([844affd](844affd))
* Remove duplicate key from prepublish.js ([2ca2755](2ca2755))
* **rfb:** expose rfb in VncScreen useImperativeHandle ([roerohan#26](https://github.com/isaiahbjork/allyson-react-vnc/issues/26)) ([53af884](53af884))
* **rfb:** use rfb as a ref so that it can be returned with onConnect ([4df7d49](4df7d49))
* Submodule URI ([8d13d10](8d13d10))
* **submodules:** submodules were updated ([e4ca572](e4ca572))
* **submodules:** submodules were updated ([bf50b94](bf50b94))
* **submodules:** submodules were updated ([8538b5d](8538b5d))
* **submodules:** submodules were updated ([09ab457](09ab457))
* **submodules:** submodules were updated ([9db9c05](9db9c05))
* **submodules:** submodules were updated ([d50c8c5](d50c8c5))
* **submodules:** submodules were updated ([8527c9f](8527c9f))
* **submodules:** submodules were updated ([2bf57ea](2bf57ea))
* **submodules:** submodules were updated ([33a7c86](33a7c86))
* **submodules:** submodules were updated ([0b26f86](0b26f86))
* **submodules:** submodules were updated ([9d33c98](9d33c98))
* **submodules:** submodules were updated ([74804c9](74804c9))
* **submodules:** submodules were updated ([e9020fd](e9020fd))
* **submodules:** submodules were updated ([ec90728](ec90728))
* **submodules:** submodules were updated ([808c76c](808c76c))
* **submodules:** submodules were updated ([e2fb418](e2fb418))
* **submodules:** submodules were updated ([c198283](c198283))
* **submodules:** submodules were updated ([4e6ddcf](4e6ddcf))
* **submodules:** submodules were updated ([225bd0b](225bd0b))
* **submodules:** submodules were updated ([7050d70](7050d70))
* **submodules:** submodules were updated ([25fbd61](25fbd61))
* **submodules:** submodules were updated ([70fc377](70fc377))
* **submodules:** submodules were updated ([86c63f2](86c63f2))
* **submodules:** submodules were updated ([7a4b8f5](7a4b8f5))
* **submodules:** submodules were updated ([a229dd2](a229dd2))
* **submodules:** submodules were updated ([7105728](7105728))
* **submodules:** submodules were updated ([32abf70](32abf70))
* **submodules:** submodules were updated ([15b955e](15b955e))
* **submodules:** submodules were updated ([6638b1f](6638b1f))
* **submodules:** submodules were updated ([d72ced2](d72ced2))
* **submodules:** submodules were updated ([7bd7dc5](7bd7dc5))
* **submodules:** submodules were updated ([cecb9d4](cecb9d4))
* **submodules:** submodules were updated ([da59e5a](da59e5a))
* **submodules:** submodules were updated ([2227ff6](2227ff6))
* **submodules:** submodules were updated ([2d60734](2d60734))
* **submodules:** submodules were updated ([f8eeee1](f8eeee1))
* **submodules:** submodules were updated ([7630851](7630851))
* **submodules:** submodules were updated ([324c8e6](324c8e6))
* **submodules:** submodules were updated ([edd6c5b](edd6c5b))
* **submodules:** submodules were updated ([62e3e79](62e3e79))
* **submodules:** submodules were updated ([63be97b](63be97b))
* **submodules:** submodules were updated ([29b3aeb](29b3aeb))
* **submodules:** submodules were updated ([6974204](6974204))
* **submodules:** submodules were updated ([f129746](f129746))
* **submodules:** submodules were updated ([775a7e3](775a7e3))
* **submodules:** submodules were updated ([1096aae](1096aae))
* **submodules:** submodules were updated ([5a84acf](5a84acf))
* **submodules:** submodules were updated ([13b710c](13b710c))
* **submodules:** submodules were updated ([1d03f66](1d03f66))
* **submodules:** submodules were updated ([dda58b1](dda58b1))
* **submodules:** submodules were updated ([baf8dcf](baf8dcf))
* **submodules:** submodules were updated ([207a519](207a519))
* **submodules:** submodules were updated ([36601ee](36601ee))
* **submodules:** submodules were updated ([f9b6e6b](f9b6e6b))
* **submodules:** submodules were updated ([9c39b07](9c39b07))
* **submodules:** submodules were updated ([3172623](3172623))
* **submodules:** submodules were updated ([ba32bb0](ba32bb0))
* **submodules:** submodules were updated ([582e268](582e268))
* **submodules:** submodules were updated ([d65c14f](d65c14f))
* **submodules:** submodules were updated ([743cab7](743cab7))
* **submodules:** submodules were updated ([a72e189](a72e189))
* **submodules:** submodules were updated ([1383a14](1383a14))
* **submodules:** submodules were updated ([9ebaf64](9ebaf64))
* **submodules:** submodules were updated ([fbca6be](fbca6be))
* **submodules:** submodules were updated ([1075542](1075542))
* **submodules:** submodules were updated ([fc3e61d](fc3e61d))
* **submodules:** submodules were updated ([1034880](1034880))
* **submodules:** submodules were updated ([28c8913](28c8913))
* **submodules:** submodules were updated ([95f10f5](95f10f5))
* **submodules:** submodules were updated ([4acdefd](4acdefd))
* **submodules:** submodules were updated ([7c974e5](7c974e5))
* **submodules:** submodules were updated ([20d876a](20d876a))
* **submodules:** submodules were updated ([a280eaf](a280eaf))
* **submodules:** submodules were updated ([9f2f324](9f2f324))
* **submodules:** submodules were updated ([c1224a3](c1224a3))
* **submodules:** submodules were updated ([e246f56](e246f56))
* **submodules:** submodules were updated ([6cae515](6cae515))
* **submodules:** submodules were updated ([b24dc21](b24dc21))
* **submodules:** submodules were updated ([279c166](279c166))
* **submodules:** submodules were updated ([60b01d7](60b01d7))
* **submodules:** submodules were updated ([32e527d](32e527d))
* **submodules:** submodules were updated ([52a9985](52a9985))
* **submodules:** submodules were updated ([01afe07](01afe07))
* **submodules:** submodules were updated ([b22808a](b22808a))
* **submodules:** submodules were updated ([476715e](476715e))
* **submodules:** submodules were updated ([5cfae44](5cfae44))
* **submodules:** submodules were updated ([6ddbf49](6ddbf49))
* **submodules:** submodules were updated ([4449674](4449674))
* **submodules:** submodules were updated ([850ab31](850ab31))
* **submodules:** submodules were updated ([ed34335](ed34335))
* **submodules:** submodules were updated ([ee24f5e](ee24f5e))
* **submodules:** submodules were updated ([574b631](574b631))
* **submodules:** submodules were updated ([0fc1ee5](0fc1ee5))
* **submodules:** submodules were updated ([ee59941](ee59941))
* update action version number ([946407d](946407d))
* update configuration files ([a255ed3](a255ed3))
* update documentation for ref ([roerohan#37](https://github.com/isaiahbjork/allyson-react-vnc/issues/37)) ([3bbe643](3bbe643))
* Update github deploy action ([a16de0c](a16de0c))
* update workflow versions in actions ([cf4b243](cf4b243))
* v0.1.2, introduce typings ([fdebf8a](fdebf8a))
* Working version, VNCScreen example ([6c3b2c4](6c3b2c4))
* wsProtocols should take string|string[] ([roerohan#47](https://github.com/isaiahbjork/allyson-react-vnc/issues/47)) ([4235cce](4235cce))

### Features

* (bump) v0.1.15 ([b53435a](b53435a))
* (bump) v0.1.16 ([aa4796e](aa4796e))
* (bump) version 0.1.13 ([252c79e](252c79e))
* (bump) version 0.1.14 ([c01bf36](c01bf36))
* Action to publish library ([e96f103](e96f103))
* Added 404.html for deployment ([9c12f89](9c12f89))
* Added base project ([0c8136d](0c8136d))
* Added lint script and bumped version ([065df75](065df75))
* Bump to v0.1.11 (new release) ([56c08a4](56c08a4))
* Demo image for VNC added ([3e3f8d6](3e3f8d6))
* **imperativeHandles:** implemented noVNC RFB methods ([roerohan#28](https://github.com/isaiahbjork/allyson-react-vnc/issues/28)) ([1c8c234](1c8c234))
* **listeners:** export onConnect, onDisconnect, etc ([15cc8f4](15cc8f4))
* **loading:** added custom component that can be displayed in place of default loading UI ([roerohan#23](https://github.com/isaiahbjork/allyson-react-vnc/issues/23)) ([8005dd2](8005dd2))
* Modified project to include NoVNC screen component ([3ea9de2](3ea9de2))
* modified publish script to change dependencies before publishing ([5474f6c](5474f6c))
* Release v0.1.3 ([85ea977](85ea977))
* release v0.1.9 ([325cc5c](325cc5c))
* **release:** setup semantic release, husky, and github actions ([roerohan#7](https://github.com/isaiahbjork/allyson-react-vnc/issues/7)) ([5380a75](5380a75))
* Set up rollup build script ([a777746](a777746))
* update all dependencies ([1539e24](1539e24))
* Update demo URL and screenshot ([2ea69a8](2ea69a8))
* Update git submodule to latest noVNC ([ad0033a](ad0033a))
* Update noVNC submodule ([roerohan#2](https://github.com/isaiahbjork/allyson-react-vnc/issues/2)) ([d66d8aa](d66d8aa))
* Update submodule ([09b97d0](09b97d0))
* Updated demo page ([7464d92](7464d92))
* v0.1.10, added repository and keywords ([ef996f7](ef996f7))
* v0.1.10, added repository and keywords ([c57374a](c57374a))
* v0.1.18 ([roerohan#4](https://github.com/isaiahbjork/allyson-react-vnc/issues/4)) ([7a58264](7a58264))
* v0.1.4, added prepack script ([8e176c6](8e176c6))
* Workflow to deploy to gh-pages ([83b9d45](83b9d45))

### BREAKING CHANGES

* This package will not work for older versions of node
* Updating all dependencies, added node v20 support
* releasing version 1, there are no breaking changes as
such. Using the phrase to trigger semantic release to bump the version
to v1.

skip-checks: true
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@roerohan roerohan

Labels
documentation Improvements or additions to documentation released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@roerohan