@ckbox/core 2.8.2 → 2.9.0-rc.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/LICENSE.md +1 -1
- package/README.md +4 -4
- package/dist/index.d.ts +35 -2
- package/dist/index.js +1 -1
- package/dist/translations/en.js +1 -1
- package/package.json +3 -3
package/LICENSE.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
**CKBox** (https://ckeditor.com/ckbox/)
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2003-
|
|
3
|
+
Copyright (c) 2003-2025, [CKSource Holding sp. z o.o.](https://cksource.com/) All rights reserved.
|
|
4
4
|
**CKBox** is licensed under a commercial license and is protected by copyright law. For more details about available licensing options please contact us at [sales@cksource.com](mailto:sales@cksource.com).
|
|
5
5
|
|
|
6
6
|
Trademarks
|
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ Using a build served from the CDN is the simplest and fastest way of embedding C
|
|
|
13
13
|
To start using CKBox on your website, embed the following `script` element in the HTML code of the page:
|
|
14
14
|
|
|
15
15
|
```html
|
|
16
|
-
<script src="https://cdn.ckbox.io/ckbox/2.
|
|
16
|
+
<script src="https://cdn.ckbox.io/ckbox/2.9.0-rc.0/ckbox.js"></script>
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
Quick implementation example:
|
|
@@ -23,7 +23,7 @@ Quick implementation example:
|
|
|
23
23
|
<html>
|
|
24
24
|
<head>
|
|
25
25
|
<meta charset="UTF-8" />
|
|
26
|
-
<script src="https://cdn.ckbox.io/ckbox/2.
|
|
26
|
+
<script src="https://cdn.ckbox.io/ckbox/2.9.0-rc.0/ckbox.js"></script>
|
|
27
27
|
</head>
|
|
28
28
|
<body>
|
|
29
29
|
<div id="ckbox"></div>
|
|
@@ -48,10 +48,10 @@ The code snippet below presents the simplest scenario for integration of CKEdito
|
|
|
48
48
|
<html>
|
|
49
49
|
<head>
|
|
50
50
|
<meta charset="UTF-8" />
|
|
51
|
-
<script src="https://cdn.ckbox.io/ckbox/2.
|
|
51
|
+
<script src="https://cdn.ckbox.io/ckbox/2.9.0-rc.0/ckbox.js"></script>
|
|
52
52
|
<link
|
|
53
53
|
rel="stylesheet"
|
|
54
|
-
href="https://cdn.ckbox.io/ckbox/2.
|
|
54
|
+
href="https://cdn.ckbox.io/ckbox/2.9.0-rc.0/styles/themes/lark.css"
|
|
55
55
|
/>
|
|
56
56
|
<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5/42.0.0/ckeditor5.css" />
|
|
57
57
|
</head>
|
package/dist/index.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ import { IconRenderProp } from '@ckbox/components';
|
|
|
5
5
|
import * as React from 'react';
|
|
6
6
|
|
|
7
7
|
type ApiAssetImageProcessingStatus = 'queued' | 'success' | 'error';
|
|
8
|
+
type ApiAssetImageAnalysisProcessingStatus = 'queued' | 'success' | 'error' | 'skipped';
|
|
8
9
|
|
|
9
10
|
type TokenCallback = () => Promise<string>;
|
|
10
11
|
type TokenUrl = string | TokenCallback;
|
|
@@ -40,6 +41,10 @@ interface ParsedAssetMetadata extends Record<string, unknown> {
|
|
|
40
41
|
* Processing status of an image (if asset is an image).
|
|
41
42
|
*/
|
|
42
43
|
metadataProcessingStatus?: ApiAssetImageProcessingStatus;
|
|
44
|
+
/**
|
|
45
|
+
* AI Analysis processing status of an image (if asset is an image).
|
|
46
|
+
*/
|
|
47
|
+
analysisProcessingStatus?: ApiAssetImageAnalysisProcessingStatus;
|
|
43
48
|
/**
|
|
44
49
|
* Asset width in px.
|
|
45
50
|
*/
|
|
@@ -405,9 +410,37 @@ type CoreImageEditorFromUrlProps = {
|
|
|
405
410
|
} & CoreImageEditorBaseProps;
|
|
406
411
|
type ImageEditorProps = CoreImageEditorProps & CoreBaseProps;
|
|
407
412
|
type ImageEditorFromUrlProps = CoreImageEditorFromUrlProps & CoreBaseProps;
|
|
413
|
+
type UploaderWidgetProps = {
|
|
414
|
+
/**
|
|
415
|
+
* Callback invoked upon successfully uploading an asset.
|
|
416
|
+
*
|
|
417
|
+
* @param asset uploaded asset
|
|
418
|
+
*/
|
|
419
|
+
onUpload?: (asset: ParsedAsset) => void;
|
|
420
|
+
/**
|
|
421
|
+
* Callback invoked upon successfully deleting an asset.
|
|
422
|
+
*
|
|
423
|
+
* @param asset uploaded asset
|
|
424
|
+
*/
|
|
425
|
+
onDelete?: (asset: ParsedAsset) => void;
|
|
426
|
+
/**
|
|
427
|
+
* ID of a category to which assets will be uploaded.
|
|
428
|
+
*/
|
|
429
|
+
uploadCategoryId?: string;
|
|
430
|
+
/**
|
|
431
|
+
* ID of a folder to which assets will be uploaded.
|
|
432
|
+
*/
|
|
433
|
+
uploadFolderId?: string;
|
|
434
|
+
/**
|
|
435
|
+
* ID of a workspace to which assets will be uploaded.
|
|
436
|
+
*/
|
|
437
|
+
workspaceId: string;
|
|
438
|
+
} & CoreBaseProps;
|
|
408
439
|
|
|
409
440
|
declare const CoreImageEditor: React.FC<ImageEditorProps | ImageEditorFromUrlProps>;
|
|
410
441
|
|
|
442
|
+
declare const CoreUploaderWidget: React.FC<UploaderWidgetProps>;
|
|
443
|
+
|
|
411
444
|
/**
|
|
412
445
|
* `CoreApp` is meant to hold all providers that are workspace-agnostic.
|
|
413
446
|
* These providers should be mounted once in CKBox instance's lifetime.
|
|
@@ -419,5 +452,5 @@ declare const CoreApp: React.FC<Props>;
|
|
|
419
452
|
*/
|
|
420
453
|
declare const CKBOX_VERSION: string | undefined;
|
|
421
454
|
|
|
422
|
-
export { CoreApp as CKBox, CoreImageEditor as CKBoxImageEditor, CKBOX_VERSION as version };
|
|
423
|
-
export type { Asset, ImageEditorFromUrlProps, ImageEditorProps, Props };
|
|
455
|
+
export { CoreApp as CKBox, CoreImageEditor as CKBoxImageEditor, CoreUploaderWidget as CKBoxWidget, CKBOX_VERSION as version };
|
|
456
|
+
export type { Asset, ImageEditorFromUrlProps, ImageEditorProps, Props, UploaderWidgetProps };
|