Skip to content

Commit

Permalink
👷 MRjs - Auto Generated Docs 👷
Browse files Browse the repository at this point in the history
Changes from `github.com/Volumetrics-io/mrjs` at 0ae2e38788d462bb49d0352b838f575bc110e3bb

-includes folder updates: `js-api`, `js-api-utils`, `js-api-extras`
  • Loading branch information
github-actions[bot] committed Apr 18, 2024
1 parent ae0d468 commit a75908b
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion source/js-api/034MRTextInputEntity.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Base text inpu entity represented in 3D space. `mr-text-input`
* [.updateTextDisplay()](#MRTextInputEntity+updateTextDisplay)
* [.connected()](#MRTextInputEntity+connected)
* [._createCursorObject()](#MRTextInputEntity+_createCursorObject)
* [._updateCursorSize(newHeight)](#MRTextInputEntity+_updateCursorSize)
* [.handleKeydown(event)](#MRTextInputEntity+handleKeydown)
* [.handleMouseClick(event)](#MRTextInputEntity+handleMouseClick)
* [._focus(isPureFocusEvent)](#MRTextInputEntity+_focus)
Expand Down Expand Up @@ -85,9 +86,24 @@ update the textObj visual based on the hiddenInput DOM element.

### mrTextInputEntity.\_createCursorObject()
Internal function used to setup the cursor object and associated variables
needed during runtime.
needed during runtime. Sets the cursor geometry based on dev updated cursorWidth and
cursorHeight MRTextInputEntity variables.

**Kind**: instance method of [<code>MRTextInputEntity</code>](#MRTextInputEntity)
<a name="MRTextInputEntity+_updateCursorSize"></a>

### mrTextInputEntity.\_updateCursorSize(newHeight)
Internal function used to setup the cursor object and associated variables
needed during runtime. User can pass in a new height directly or the function checks
whether cursor height should be updated based on fontSize compared to line height
and other aspects.

**Kind**: instance method of [<code>MRTextInputEntity</code>](#MRTextInputEntity)

| Param | Type | Description |
| --- | --- | --- |
| newHeight | <code>number</code> | an optional parameter to be used as the cursor's new height. |

<a name="MRTextInputEntity+handleKeydown"></a>

### mrTextInputEntity.handleKeydown(event)
Expand Down

0 comments on commit a75908b

Please sign in to comment.