@bygga.dev/editor 1.0.0 → 1.2.0
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 +2 -0
- package/{TextEditor-DGmHp-AF.js → TextEditor-DZmlpRNW.js} +401 -360
- package/bygga-editor.js +3527 -2787
- package/element.d.ts +32 -1
- package/package.json +1 -1
- package/{urls-C1-J3Og2.js → urls-Cw507ilt.js} +2915 -2653
package/element.d.ts
CHANGED
|
@@ -11,6 +11,36 @@ type Document = {
|
|
|
11
11
|
declare function parseDocument(json: unknown): Document;
|
|
12
12
|
declare function createEmptyDocument(): Document;
|
|
13
13
|
|
|
14
|
+
type BlockPluginSettingsContext<Data = unknown, Globals = unknown> = {
|
|
15
|
+
readonly data: Data;
|
|
16
|
+
update(data: Data): void;
|
|
17
|
+
readonly globals: Globals;
|
|
18
|
+
uploadImage(image: Blob): Promise<string>;
|
|
19
|
+
readonly locale: string;
|
|
20
|
+
};
|
|
21
|
+
type BlockPluginGlobalsContext<Globals = unknown> = {
|
|
22
|
+
readonly globals: Globals;
|
|
23
|
+
update(globals: Globals): void;
|
|
24
|
+
uploadImage(image: Blob): Promise<string>;
|
|
25
|
+
readonly locale: string;
|
|
26
|
+
};
|
|
27
|
+
type BlockPluginGlobalSettings<Globals = unknown> = {
|
|
28
|
+
create(): Globals;
|
|
29
|
+
parse(globals: unknown): Globals;
|
|
30
|
+
mount(node: HTMLElement, context: BlockPluginGlobalsContext<Globals>): (() => void) | undefined;
|
|
31
|
+
};
|
|
32
|
+
type BlockPlugin<Data = unknown, Globals = unknown> = {
|
|
33
|
+
name: string;
|
|
34
|
+
label: string;
|
|
35
|
+
icon?: string;
|
|
36
|
+
create(): Data;
|
|
37
|
+
parse(data: unknown): Data;
|
|
38
|
+
email(data: Data, globals: Globals): string;
|
|
39
|
+
preview?(node: HTMLElement, data: Data, globals: Globals): void;
|
|
40
|
+
settings(node: HTMLElement, context: BlockPluginSettingsContext<Data, Globals>): (() => void) | undefined;
|
|
41
|
+
globalSettings?: BlockPluginGlobalSettings<Globals>;
|
|
42
|
+
};
|
|
43
|
+
|
|
14
44
|
declare const brand: unique symbol;
|
|
15
45
|
type SavedBlockContent = {
|
|
16
46
|
readonly [brand]: 'SavedBlockContent';
|
|
@@ -28,6 +58,7 @@ type EditorConfig = {
|
|
|
28
58
|
onImageError?(error: unknown): void;
|
|
29
59
|
saveBlock?(saved: SavedBlock): Promise<void>;
|
|
30
60
|
deleteSavedBlock?(id: string): Promise<void>;
|
|
61
|
+
plugins?: readonly BlockPlugin[];
|
|
31
62
|
};
|
|
32
63
|
|
|
33
64
|
declare const SUPPORTED_LOCALES: readonly ["en", "sv"];
|
|
@@ -74,4 +105,4 @@ declare global {
|
|
|
74
105
|
}
|
|
75
106
|
|
|
76
107
|
export { ByggaEditor, DEFAULT_LOCALE, EDITOR_TAG, SUPPORTED_LOCALES, createEmptyDocument, parseDocument, parseSavedBlock };
|
|
77
|
-
export type { Brand, BrandFont, ByggaEditorElement, ByggaEditorEventMap, Document, EditorConfig, LicenseError, LicenseErrorReason, Locale, MergeTagLabels, MergeTags, SavedBlock, SavedBlockContent };
|
|
108
|
+
export type { BlockPlugin, BlockPluginGlobalSettings, BlockPluginGlobalsContext, BlockPluginSettingsContext, Brand, BrandFont, ByggaEditorElement, ByggaEditorEventMap, Document, EditorConfig, LicenseError, LicenseErrorReason, Locale, MergeTagLabels, MergeTags, SavedBlock, SavedBlockContent };
|