crabapples
/
noVNC
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation for the option showDotCursor 

This is not only a property, it's also a parameter to the constructor.
This commit is contained in:
Samuel Mannehed 2019-07-23 16:07:17 +02:00
parent c912230309
commit e14aa4d0fe
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/API.md
View File

@ -187,6 +187,11 @@ connection to a specified VNC server.
- A `DOMString` specifying the ID to provide to any VNC repeater - A `DOMString` specifying the ID to provide to any VNC repeater
encountered. encountered.
`showDotCursor`
- A `boolean` indicating whether a dot cursor should be shown
instead of a zero-sized or fully-transparent cursor if the
server sets such invisible cursor. Disabled by default.
`wsProtocols` `wsProtocols`
- An `Array` of `DOMString`s specifying the sub-protocols to use - An `Array` of `DOMString`s specifying the sub-protocols to use
in the WebSocket connection. Empty by default. in the WebSocket connection. Empty by default.