Skip to content

Latest commit

 

History

History
159 lines (89 loc) · 4.23 KB

API.md

File metadata and controls

159 lines (89 loc) · 4.23 KB

API

Table of contents

Functions

Interfaces

Type Aliases

Functions

RichTextarea

RichTextarea(props): ReactNode

Textarea component with some extra props. See RichTextareaProps and RichTextareaHandle.

Parameters

Name Type
props Omit<RichTextareaProps, "ref"> & RefAttributes<RichTextareaHandle>

Returns

ReactNode

Defined in

src/textarea.tsx:128


experimental_RichInput

experimental_RichInput(props): ReactNode

Input component with some extra props. See RichInputProps and RichInputHandle.

NOTE: This component is experimental one so it may have some bugs.

Parameters

Name Type
props Omit<RichInputProps, "ref"> & RefAttributes<RichInputHandle>

Returns

ReactNode

Defined in

src/input.tsx:138


createRegexRenderer

createRegexRenderer(matchers): Renderer

An utility to create renderer function with regex.

The priority is descending order.

Parameters

Name Type
matchers ([regex: RegExp, style: StyleOrRender] | [regex: RegExp, style: StyleOrRender, shouldRender?: Function])[]

Returns

Renderer

Defined in

src/renderers/regex/index.tsx:19


createCSSCustomHighlightRenderer

createCSSCustomHighlightRenderer(matchers): Renderer

createRegexRenderer but rendered with CSS Custom Highlight API.

Parameters

Name Type
matchers [regex: RegExp, style: string][]

Returns

Renderer

Defined in

src/renderers/regex/index.tsx:166

Type Aliases

StyleOrRender

Ƭ StyleOrRender: React.CSSProperties | (props: { children: React.ReactNode ; value: string ; key?: string }) => React.ReactNode

Defined in

src/renderers/regex/index.tsx:6


Renderer

Ƭ Renderer: (value: string) => React.ReactNode

Type declaration

▸ (value): React.ReactNode

Parameters
Name Type
value string
Returns

React.ReactNode

Defined in

src/types.ts:1


CaretPosition

Ƭ CaretPosition: { focused: false ; selectionStart: number ; selectionEnd: number } | { focused: true ; selectionStart: number ; selectionEnd: number ; top: number ; left: number ; height: number }

Defined in

src/types.ts:3