-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.ts
55 lines (51 loc) · 1.7 KB
/
index.ts
1
2
3
4
5
6
7
8
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
/* Kullna Editor - A small but feature-rich code editor for the web
Copyright (C) 2022-2023 The Kullna Programming Language Project
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. */
/**
* @packageDocumentation # Highlights
*
* Highlights are lines that are highlighted across the entire editor.
*
* They are useful for showing things like;
*
* - Current point of execution
* - Lines with errors
* - Lines with warnings
* - Lines with breakpoints
* - Lines with bookmarks
* - Lines with TODOs
*
* ## Creating a highlight
*
* Create a reactive highlight object with {@link KullnaEditor.createHighlight}:
*
* ```js
* const highlight = editor.createHighlight();
* highlight.cssClass = 'highlight';
* highlight.lineNumber = 1;
* highlight.visible = true;
* ```
*
* Changing the properties of the highlight will automatically update the editor.
*
* ## Deleting a highlight
*
* When you no longer want a highlight, and changing its visibility is not enough,
* you can delete it entirely:
*
* ```js
* highlight.delete();
* ```
*
* See the {@link Highlight} interface for more information.
*/
export {Highlight} from './highlight';