nuxt-codemirror 0.0.3 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/module.json +1 -1
- package/dist/runtime/types/nuxt-codemirror.d.ts +114 -110
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ Codemirror as a Nuxt module. Demo preview: Coming soon
|
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
- [✨ Release Notes](/CHANGELOG.md)
|
|
14
|
-
|
|
14
|
+
- [🏀 Online playground](https://stackblitz.com/edit/nuxt-starter-ev2hgm?file=app.vue)
|
|
15
15
|
<!-- - [📖 Documentation](https://example.com) -->
|
|
16
16
|
|
|
17
17
|
## Features
|
package/dist/module.json
CHANGED
|
@@ -3,121 +3,125 @@ import type { EditorView, ViewUpdate } from '@codemirror/view'
|
|
|
3
3
|
import type { BasicSetupOptions } from '@uiw/codemirror-extensions-basic-setup'
|
|
4
4
|
import type { Ref } from '#imports'
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
declare module 'nuxt-codemirror' {
|
|
7
|
+
export interface NuxtCodeMirrorProps
|
|
8
|
+
extends Omit<EditorStateConfig, 'doc' | 'extensions'> {
|
|
8
9
|
/** value of the auto created model in the editor. */
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
10
|
+
modelValue?: string
|
|
11
|
+
height?: string
|
|
12
|
+
minHeight?: string
|
|
13
|
+
maxHeight?: string
|
|
14
|
+
width?: string
|
|
15
|
+
minWidth?: string
|
|
16
|
+
maxWidth?: string
|
|
17
|
+
/** focus on the editor. */
|
|
18
|
+
autoFocus?: boolean
|
|
19
|
+
/** Enables a placeholder—a piece of example content to show when the editor is empty. */
|
|
20
|
+
placeholder?: string | HTMLElement
|
|
21
|
+
/**
|
|
22
|
+
* `light` / `dark` / `Extension` Defaults to `light`.
|
|
23
|
+
* @default light
|
|
24
|
+
*/
|
|
25
|
+
theme?: 'light' | 'dark' | 'none' | Extension
|
|
26
|
+
/**
|
|
27
|
+
* Whether to optional basicSetup by default
|
|
28
|
+
* @default true
|
|
29
|
+
*/
|
|
30
|
+
basicSetup?: boolean | BasicSetupOptions
|
|
31
|
+
/**
|
|
32
|
+
* This disables editing of the editor content by the user.
|
|
33
|
+
* @default true
|
|
34
|
+
*/
|
|
35
|
+
editable?: boolean
|
|
36
|
+
/**
|
|
37
|
+
* This disables editing of the editor content by the user.
|
|
38
|
+
* @default false
|
|
39
|
+
*/
|
|
40
|
+
readOnly?: boolean
|
|
41
|
+
/**
|
|
42
|
+
* Controls whether pressing the `Tab` key inserts a tab character and indents the text (`true`)
|
|
43
|
+
* or behaves according to the browser's default behavior (`false`).
|
|
44
|
+
* @default true
|
|
45
|
+
*/
|
|
46
|
+
indentWithTab?: boolean
|
|
47
|
+
/** Fired whenever a change occurs to the document. */
|
|
48
|
+
onChange?(value: string, viewUpdate: ViewUpdate): void
|
|
49
|
+
/** Some data on the statistics editor. */
|
|
50
|
+
onStatistics?(data: Statistics): void
|
|
51
|
+
/** Fired whenever any state change occurs within the editor, including non-document changes like lint results. */
|
|
52
|
+
onUpdate?(viewUpdate: ViewUpdate): void
|
|
53
|
+
/** The first time the editor executes the event. */
|
|
54
|
+
onCreateEditor?(view: EditorView, state: EditorState): void
|
|
55
|
+
/** Fired whenever the editor is focused. */
|
|
56
|
+
onFocus?(view: ViewUpdate): void
|
|
57
|
+
/** Fired whenever the editor is blurred. */
|
|
58
|
+
onBlur?(view: ViewUpdate): void
|
|
59
|
+
/**
|
|
60
|
+
* Extension values can be [provided](https://codemirror.net/6/docs/ref/#state.EditorStateConfig.extensions) when creating a state to attach various kinds of configuration and behavior information.
|
|
61
|
+
* They can either be built-in extension-providing objects,
|
|
62
|
+
* such as [state fields](https://codemirror.net/6/docs/ref/#state.StateField) or [facet providers](https://codemirror.net/6/docs/ref/#state.Facet.of),
|
|
63
|
+
* or objects with an extension in its `extension` property. Extensions can be nested in arrays arbitrarily deep—they will be flattened when processed.
|
|
64
|
+
*/
|
|
65
|
+
extensions?: Extension[]
|
|
66
|
+
/**
|
|
67
|
+
* If the view is going to be mounted in a shadow root or document other than the one held by the global variable document (the default), you should pass it here.
|
|
68
|
+
* Originally from the [config of EditorView](https://codemirror.net/6/docs/ref/#view.EditorView.constructor%5Econfig.root)
|
|
69
|
+
*/
|
|
70
|
+
root?: ShadowRoot | Document
|
|
71
|
+
/**
|
|
72
|
+
* Create a state from its JSON representation serialized with [toJSON](https://codemirror.net/docs/ref/#state.EditorState.toJSON) function
|
|
73
|
+
*/
|
|
74
|
+
initialState?: {
|
|
74
75
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
76
|
+
json: any
|
|
77
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
78
|
+
fields?: Record<string, StateField<any>>
|
|
79
|
+
}
|
|
78
80
|
}
|
|
79
|
-
}
|
|
80
81
|
|
|
81
|
-
export interface UseCodeMirrorProps extends NuxtCodeMirrorProps {
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
}
|
|
82
|
+
export interface UseCodeMirrorProps extends NuxtCodeMirrorProps {
|
|
83
|
+
container?: HTMLDivElement | null
|
|
84
|
+
viewRef: Ref<EditorView | undefined>
|
|
85
|
+
stateRef: Ref<EditorState | undefined>
|
|
86
|
+
containerRef: Ref<HTMLDivElement | null>
|
|
87
|
+
}
|
|
87
88
|
|
|
88
|
-
export interface Statistics {
|
|
89
|
+
export interface Statistics {
|
|
89
90
|
/** total length of the document */
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
}
|
|
91
|
+
length: number
|
|
92
|
+
/** Get the number of lines in the editor. */
|
|
93
|
+
lineCount: number
|
|
94
|
+
/** Get the currently line description around the given position. */
|
|
95
|
+
line: Line
|
|
96
|
+
/** Get the proper [line-break](https://codemirror.net/docs/ref/#state.EditorState^lineSeparator) string for this state. */
|
|
97
|
+
lineBreak: string
|
|
98
|
+
/** Returns true when the editor is [configured](https://codemirror.net/6/docs/ref/#state.EditorState^readOnly) to be read-only. */
|
|
99
|
+
readOnly: boolean
|
|
100
|
+
/** The size (in columns) of a tab in the document, determined by the [`tabSize`](https://codemirror.net/6/docs/ref/#state.EditorState^tabSize) facet. */
|
|
101
|
+
tabSize: number
|
|
102
|
+
/** Cursor Position */
|
|
103
|
+
selection: EditorSelection
|
|
104
|
+
/** Make sure the selection only has one range. */
|
|
105
|
+
selectionAsSingle: SelectionRange
|
|
106
|
+
/** Retrieves a list of all current selections. */
|
|
107
|
+
ranges: readonly SelectionRange[]
|
|
108
|
+
/** Get the currently selected code. */
|
|
109
|
+
selectionCode: string
|
|
110
|
+
/**
|
|
111
|
+
* The length of the given array should be the same as the number of active selections.
|
|
112
|
+
* Replaces the content of the selections with the strings in the array.
|
|
113
|
+
*/
|
|
114
|
+
selections: string[]
|
|
115
|
+
/** Return true if any text is selected. */
|
|
116
|
+
selectedText: boolean
|
|
117
|
+
}
|
|
117
118
|
|
|
118
|
-
export interface CodeMirrorRef {
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
119
|
+
export interface CodeMirrorRef {
|
|
120
|
+
container: HTMLDivElement | null
|
|
121
|
+
view: EditorView | undefined
|
|
122
|
+
state: EditorState | undefined
|
|
123
|
+
editor: HTMLDivElement | null
|
|
124
|
+
}
|
|
123
125
|
}
|
|
126
|
+
|
|
127
|
+
export type { Statistics, CodeMirrorRef, UseCodeMirrorProps, NuxtCodeMirrorProps } from 'nuxt-codemirror'
|