Interface: CursorRenderOptions

@roomful/core

---

@roomful/core / CursorRenderOptions

Interface: CursorRenderOptions

Defined in: packages/core/src/types.ts:837

Configures DOM cursor rendering.

Properties

container?

optional container: string | HTMLElement

Defined in: packages/core/src/types.ts:841

Selects the container element or selector for rendered cursors.

---

idleTimeout?

optional idleTimeout: number

Defined in: packages/core/src/types.ts:862

Overrides the idle timeout used by the renderer.

---

onMount()?

optional onMount: (element) => void

Defined in: packages/core/src/types.ts:873

Called with each peer cursor element when it is first created, allowing custom decoration of the rendered node.

Parameters

element

HTMLElement

Returns

void

---

showIdle?

optional showIdle: boolean

Defined in: packages/core/src/types.ts:857

Keeps idle cursors visible when true.

---

showName?

optional showName: boolean

Defined in: packages/core/src/types.ts:852

Shows peer labels when true.

---

style?

optional style: string & object | "default" | "arrow" | "dot" | "pointer" | "none"

Defined in: packages/core/src/types.ts:847

Chooses the cursor marker style. Use 'none' to disable the built-in renderer while keeping cursor tracking active.

---

zIndex?

optional zIndex: number

Defined in: packages/core/src/types.ts:867

Sets the z-index applied to rendered cursor elements.