1.0.11 • Published 6 months ago
@types/react-codemirror v1.0.11
Installation
npm install --save @types/react-codemirror
Summary
This package contains type definitions for React Codemirror (https://github.com/JedWatson/react-codemirror).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-codemirror.
index.d.ts
// Type definitions for React Codemirror v1.0.0
// Project: https://github.com/JedWatson/react-codemirror
// Definitions by: Vicky Lai <https://github.com/velveret>
// Rudi Chen <https://github.com/rudi-c>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.8
/// <reference types="react"/>
/// <reference types="codemirror"/>
declare namespace ReactCodeMirror {
interface ReactCodeMirrorProps {
children?: React.ReactNode;
/** Automatically focuses the editor when it is mounted (default false) */
autoFocus?: boolean | undefined;
/** Automatically persist changes to underlying textarea (default false) */
autoSave?: boolean | undefined;
/** Adds a custom CSS class to the editor */
className?: string | undefined;
/** Provides a specific CodeMirror instance (defaults to `require('codemirror')`) */
codeMirrorInstance?: ((host: any, options?: CodeMirror.EditorConfiguration) => CodeMirror.Editor) | undefined;
/** Provides the default (not changed tracked) value to the editor */
defaultValue?: string | undefined;
/** Set the name of the editor input field */
name?: string | undefined;
/** Called when a change is made */
onChange?: ((newValue: string, change: CodeMirror.EditorChange) => any) | undefined;
/** Called when the cursor is moved */
onCursorActivity?: ((codemirror: CodeMirror.Editor) => any) | undefined;
/** Called when the editor is focused or loses focus */
onFocusChange?: ((focused: boolean) => any) | undefined;
/** Called when the editor is scrolled */
onScroll?: ((scrollInfo: CodeMirror.ScrollInfo) => any) | undefined;
/** Options passed to the CodeMirror instance */
options?: CodeMirror.EditorConfiguration | undefined;
/** (DEPRECATED), use `name` */
path?: string | undefined;
/** Preserve previous scroll position after updating value */
preserveScrollPosition?: boolean | undefined
/** The editor value */
value?: string | undefined;
}
}
declare module "react-codemirror" {
class RCM extends React.Component<ReactCodeMirror.ReactCodeMirrorProps> {
/** Focuses the CodeMirror instance. */
focus(): void;
/** Returns the CodeMirror instance, if available. */
getCodeMirror(): CodeMirror.Editor;
}
export = RCM;
}
Additional Details
- Last updated: Sat, 12 Mar 2022 13:01:43 GMT
- Dependencies: @types/react, @types/codemirror
- Global values: none
Credits
1.0.9
7 months ago
1.0.11
6 months ago
1.0.10
7 months ago
1.0.8
1 year ago
1.0.7
2 years ago
1.0.6
3 years ago
1.0.5
3 years ago
1.0.4
3 years ago
1.0.3
4 years ago
1.0.2
6 years ago
1.0.1
6 years ago
1.0.0
7 years ago
0.2.7
7 years ago
0.2.6
7 years ago
0.2.5
7 years ago
0.2.4
8 years ago
0.2.3
8 years ago
0.2.2
8 years ago
0.2.1
8 years ago