UI kit reference

code/editor/useRevealLine

import { … } from 'zidane-ui/code/editor'ui/src/code/editor/useRevealLine.ts

Functions#

`useRevealLine`Function#

Scrolls a CodeEditor to reveal, selects its line and, when caret, places the caret there; see the module comment.

TypeScript

function useRevealLine(
  editor: RefObject<CodeEditorHandle | null>,
  reveal: RevealTarget | null | undefined,
  select: (line: number) => void,
  caret: boolean,
): void

Parameters

Parameters
Name	Type	Description
editor	`RefObject<CodeEditorHandle \| null>`	The editor's handle.
reveal	`RevealTarget \| null \| undefined`	Where to go, once per nonce.
select	`(line: number) => void`	Selects the line (the owner's selection state).
caret	`boolean`	Whether to place the caret (an editable view).

ui/src/code/editor/useRevealLine.ts:36

Interfaces#

`RevealTarget`Interface#

A 1-based position to reveal; a new nonce reveals the same one again.

TypeScript

interface RevealTarget

Properties

RevealTarget properties
Name	Type	Description
column	`number`	1-based column where the caret lands.
line	`number`	1-based line to select and centre.
nonce	`number`	Bump it to reveal the same position again.

ui/src/code/editor/useRevealLine.ts:16