Skip to content

Commit 6dd2c46

Browse files
Mati365Mati365
committed
Init email package.
1 parent e8957d5 commit 6dd2c46

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2509
-2
lines changed

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@
7979
"@ckeditor/ckeditor5-utils": "44.1.0",
8080
"@ckeditor/ckeditor5-watchdog": "44.1.0",
8181
"@ckeditor/ckeditor5-widget": "44.1.0",
82-
"@ckeditor/ckeditor5-word-count": "44.1.0"
82+
"@ckeditor/ckeditor5-word-count": "44.1.0",
83+
"@ckeditor/ckeditor5-email": "0.0.1"
8384
},
8485
"devDependencies": {
8586
"@babel/parser": "^7.23.3",

‎packages/ckeditor5-email/CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Changelog
2+
=========
3+
4+
All changes in the package are documented in https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md.

‎packages/ckeditor5-email/CONTRIBUTING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Contributing
2+
========================================
3+
4+
See the [official contributors' guide to CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/framework/contributing/contributing.html) to learn more.

‎packages/ckeditor5-email/LICENSE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Software License Agreement
2+
==========================
3+
4+
**CKEditor&nbsp;5 email feature** (https://github.com/ckeditor/ckeditor5)<br>
5+
Copyright (c) 2003–2025, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
6+
7+
Licensed under a dual-license model, this software is available under:
8+
9+
* the [GNU General Public License Version 2 or later](https://www.gnu.org/licenses/gpl.html),
10+
* or commercial license terms from CKSource Holding sp. z o.o.
11+
12+
For more information, see: [https://ckeditor.com/legal/ckeditor-licensing-options](https://ckeditor.com/legal/ckeditor-licensing-options).
13+
14+
Sources of Intellectual Property Included in CKEditor
15+
-----------------------------------------------------
16+
17+
Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
18+
19+
Trademarks
20+
----------
21+
22+
**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.

‎packages/ckeditor5-email/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
CKEditor&nbsp;5 email integration feature
2+
========================================
3+
4+
[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-email.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-email)
5+
[![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
6+
[![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5?branch=master)
7+
8+
This package implements email integration features for CKEditor&nbsp;5. It provides basic functionality for handling email content.
9+
10+
## Installation
11+
12+
```bash
13+
npm install @ckeditor/ckeditor5-email
14+
```
15+
16+
## Create free account
17+
18+
If you want to check full CKEditor&nbsp;5 capabilities, sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/checkout?plan=free).
19+
20+
## Demo
21+
22+
Check out the [demo in the font feature guide](https://ckeditor.com/docs/ckeditor5/latest/features/email.html#demo).
23+
24+
## Documentation
25+
26+
See the [`@ckeditor/ckeditor5-email` package](https://ckeditor.com/docs/ckeditor5/latest/api/email.html) page in [CKEditor&nbsp;5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
27+
28+
## License
29+
30+
Licensed under a dual-license model, this software is available under:
31+
32+
* the [GNU General Public License Version 2 or later](https://www.gnu.org/licenses/gpl.html),
33+
* or commercial license terms from CKSource Holding sp. z o.o.
34+
35+
For more information, see: [https://ckeditor.com/legal/ckeditor-licensing-options](https://ckeditor.com/legal/ckeditor-licensing-options).

‎packages/ckeditor5-email/docs/_snippets/features/build-email-source.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<script src="https://cdn.ckbox.io/ckbox/latest/ckbox.js"></script>

‎packages/ckeditor5-email/docs/_snippets/features/build-email-source.js‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
/**
2+
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
3+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4+
*/
5+
6+
/* globals window */
7+
8+
import { AutoLink, LinkImage } from '@ckeditor/ckeditor5-link';
9+
import { Bookmark } from '@ckeditor/ckeditor5-bookmark';
10+
import { CKBox, CKBoxImageEdit } from '@ckeditor/ckeditor5-ckbox';
11+
import { PictureEditing, ImageInsert, ImageResize, AutoImage } from '@ckeditor/ckeditor5-image';
12+
import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
13+
14+
// Umberto combines all `packages/*/docs` into the `docs/` directory. The import path must be valid after merging all directories.
15+
import ClassicEditor from '../build-classic.js';
16+
17+
window.CKEditorPlugins = { AutoLink, Bookmark, PictureEditing, ImageInsert, ImageResize, AutoImage, LinkImage, CKBox, CKBoxImageEdit };
18+
19+
window.ClassicEditor = ClassicEditor;
20+
window.CS_CONFIG = CS_CONFIG;

‎packages/ckeditor5-email/docs/_snippets/features/email.html‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<div class="ck ck-content" id="snippet-link">
2+
<h3>Valletta</h3>
3+
4+
<p>
5+
The capital city of <a href="https://en.wikipedia.org/wiki/Malta">Malta</a> is the top destination
6+
this summer. It’s home to cutting-edge contemporary architecture,
7+
<a href="https://en.wikipedia.org/wiki/Baroque">baroque</a>
8+
masterpieces, delicious local cuisine, and at least 8 months of sun.
9+
</p>
10+
<p>
11+
It’s also a top destination for filmmakers so that you can take a tour through locations familiar
12+
to you from <a href="https://en.wikipedia.org/wiki/Game_of_Thrones">Game
13+
of Thrones</a>, <a href="https://en.wikipedia.org/wiki/Gladiator_(2000_film)">Gladiator</a>,
14+
<a href="https://en.wikipedia.org/wiki/Troy_(film)">Troy</a>, and many more.
15+
</p>
16+
</div>

‎packages/ckeditor5-email/docs/_snippets/features/email.js‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/**
2+
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
3+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4+
*/
5+
6+
/* globals console, window, document, ClassicEditor, CKEditorPlugins, CS_CONFIG */
7+
8+
import { TOKEN_URL } from '@ckeditor/ckeditor5-ckbox/tests/_utils/ckbox-config.js';
9+
10+
ClassicEditor
11+
.create( document.querySelector( '#snippet-link' ), {
12+
extraPlugins: [ ...Object.values( CKEditorPlugins ) ],
13+
cloudServices: CS_CONFIG,
14+
toolbar: {
15+
items: [
16+
'undo', 'redo', '|', 'heading',
17+
'|', 'bold', 'italic',
18+
'|', 'link', 'bookmark', 'insertImage', 'insertTable', 'mediaEmbed',
19+
'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
20+
]
21+
},
22+
image: {
23+
toolbar: [
24+
'imageStyle:inline', 'imageStyle:block', 'imageStyle:wrapText', '|',
25+
'toggleImageCaption', 'imageTextAlternative', 'ckboxImageEdit'
26+
]
27+
},
28+
ui: {
29+
viewportOffset: {
30+
top: window.getViewportTopOffsetConfig()
31+
}
32+
},
33+
ckbox: {
34+
tokenUrl: TOKEN_URL,
35+
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ],
36+
forceDemoLabel: true
37+
},
38+
licenseKey: 'GPL'
39+
} )
40+
.then( editor => {
41+
window.editor = editor;
42+
43+
window.attachTourBalloon( {
44+
target: window.findToolbarItem( editor.ui.view.toolbar, item => item.label && item.label === 'Link' ),
45+
text: 'Click to create a link.',
46+
editor
47+
} );
48+
} )
49+
.catch( err => {
50+
console.error( err.stack );
51+
} );

‎packages/ckeditor5-email/docs/api/email.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
category: api-reference
3+
---
4+
5+
# CKEditor&nbsp;5 email feature
6+
7+
[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-link.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-link)
8+
9+
This package implements the email feature for CKEditor&nbsp;5. It allows for turning the edited content into emails.
10+
11+
## Demo
12+
13+
Check out the demo in the {@link features/email#demo email feature guide}.
14+
15+
## Documentation
16+
17+
See the {@link features/email email feature guide} and the {@link module:email/email~Email} plugin documentation.
18+
19+
## Installation
20+
21+
This package is part of our open-source aggregate package.
22+
23+
```bash
24+
npm install ckeditor5
25+
```
26+
27+
## Contribute
28+
29+
The source code of this package is available on GitHub in [https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-link](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-link).
30+
31+
## External links
32+
33+
* [`@ckeditor/ckeditor5-link` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-link)
34+
* [`ckeditor/ckeditor5-link` on GitHub](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-link)
35+
* [Issue tracker](https://github.com/ckeditor/ckeditor5/issues)
36+
* [Changelog](https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md)

0 commit comments

Comments
 (0)