@peergrade/ckeditor5-fileupload ·

This package was created by the ckeditor5-package-generator package.

Table of contents

• Config options
• Developing the package
• Available scripts
  • start
  • test
  • lint
  • stylelint
  • dll:build
  • dll:serve
  • translations:collect
  • translations:download
  • translations:upload
• License

Config options

ckeditor5-fileupload supports the following optional variables:

onPasteFileUpload(fileUpload: CKEdiorViewElement, evt: EventInfo, data: object, fileUploads: CKEdiorViewElement[], editor: Editor) -> null, optional

This is useful for cases where pasting a file needs interaction on the part of the server.

import { v4 as uuidv4 } from 'uuid';

fileUpload: {
	onPasteFileUpload: ( fileUpload, evt, data, fileUploads, editor ) => {
		// eslint-disable-next-line no-undef
		console.log( 'onPasteFileUpload, optional callback', fileUpload, evt, data, fileUploads, editor );
        fileUpload.item._attrs.set( 'data-file-element-id', uuidv4() );
	}
}

downloadLinkRewriter(href: string, el: CKEdiorViewElement, context: object) -> string, optional

Rewrite URLs of download links via editingDowncast. It only changes what the user sees in the editor, not the output HTML / markdown / etc.

This is useful for cases where additional GET params or wholesale rewriting of download links is necessary.

fileUpload: {
	onPasteFileUpload: ( href, el, context ) => {

	},
	downloadLinkRewriter: ( href, el, context ) => {
		// eslint-disable-next-line no-undef
		console.log( 'downloadLinkRewriter, optional callback', href, el, context );
		return `${ href }?addedViaDownloadLinkRewriter`;
	}
}

In addition to the anchor Element, the context contains fileReferenceId, which is pegged against data-file-element-id.

fileEditingDowncast( modelElement: Element, writer: DowncastWriter, editor: Editor, toWidget: ( element: ViewElement, writer: DowncastWriter ) => ViewElement ), optional

This allows overriding the render of the in-editor widget itself, making it possible to render it in react.

import * as React from 'react';
import * as ReactDOM from 'react-dom';

import type { Editor } from '@ckeditor/ckeditor5-core';
import type { DowncastWriter, Element, ViewElement } from '@ckeditor/ckeditor5-engine';

In the configuration:

fileUpload: {
	fileEditingDowncast: (
		modelElement: Element,
		writer: DowncastWriter,
		editor: Editor,
		toWidget: ( element: ViewElement, writer: DowncastWriter ) => ViewElement
	) => {
		// eslint-disable-next-line no-undef
		console.log( 'fileEditingDowncast, optional callback', modelElement, editor, writer, toWidget );
		const container = writer.createContainerElement( 'div', { class: 'ck-file' } );

		const reactWidget = writer.createUIElement(
			'div',
			{
				class: 'ck-file-custom-buttons'
			},
			function( domDocument: globalThis.Document ) {
				const el = this.toDomElement( domDocument );

				setTimeout( () => {
					ReactDOM.render(
						React.createElement(
							Hello,
							{
								toWhat: `world ${ modelElement.getAttribute( 'fileIsOpen' ) }`,
								onClick: () => editor.execute( 'setIsOpen', {} )
							},
							null
						),
						el
					);
				}, 0 );

				return el;
			}
		);

		writer.insert( writer.createPositionAt( container, 0 ), reactWidget );

		// toWidget: Add handle / border on selection
		return toWidget( container, writer );
	}
}

Developing the package

To read about the CKEditor 5 framework, visit the CKEditor5 documentation.

Available scripts

Npm scripts are a convenient way to provide commands in a project. They are defined in the package.json file and shared with other people contributing to the project. It ensures that developers use the same command with the same options (flags).

All the scripts can be executed by running yarn run <script>. Pre and post commands with matching names will be run for those as well.

The following scripts are available in the package.

start

Starts a HTTP server with the live-reload mechanism that allows previewing and testing plugins available in the package.

When the server has been started, the default browser will open the developer sample. This can be disabled by passing the --no-open option to that command.

You can also define the language that will translate the created editor by specifying the --language [LANG] option. It defaults to 'en'.

Examples:

# Starts the server and open the browser.
yarn run start

# Disable auto-opening the browser.
yarn run start --no-open

# Create the editor with the interface in German.
yarn run start --language=de

test

Allows executing unit tests for the package, specified in the tests/ directory. The command accepts the following modifiers:

• --coverage – to create the code coverage report,
• --watch – to observe the source files (the command does not end after executing tests),
• --source-map – to generate source maps of sources,
• --verbose – to print additional webpack logs.

Examples:

# Execute tests.
yarn run test

# Generate code coverage report after each change in the sources.
yarn run test --coverage --test

lint

Runs ESLint, which analyzes the code (all *.js files) to quickly find problems.

Examples:

# Execute eslint.
yarn run lint

stylelint

Similar to the lint task, stylelint analyzes the CSS code (*.css files in the theme/ directory) in the package.

Examples:

# Execute stylelint.
yarn run stylelint

dll:build

Creates a DLL-compatible package build which can be loaded into an editor using DLL builds.

Examples:

# Build the DLL file that is ready to publish.
yarn run dll:build

# Build the DLL file and listen to changes in its sources.
yarn run dll:build --watch

dll:serve

Creates a simple HTTP server (without the live-reload mechanism) that allows verifying whether the DLL build of the package is compatible with the CKEditor 5 DLL builds.

Examples:

# Starts the HTTP server and opens the browser.
yarn run dll:serve

translations:collect

Collects translation messages (arguments of the t() function) and context files, then validates whether the provided values do not interfere with the values specified in the @ckeditor/ckeditor5-core package.

The task may end with an error if one of the following conditions is met:

• Found the Unused context error – entries specified in the lang/contexts.json file are not used in source files. They should be removed.
• Found the Context is duplicated for the id error – some of the entries are duplicated. Consider removing them from the lang/contexts.json file, or rewrite them.
• Found the Context for the message id is missing error – entries specified in source files are not described in the lang/contexts.json file. They should be added.

Examples:

yarn run translations:collect

translations:download

Download translations from the Transifex server. Depending on users' activity in the project, it creates translations files used for building the editor.

The task requires passing the URL to Transifex API. Usually, it matches the following format: https://www.transifex.com/api/2/project/[PROJECT_SLUG].

To avoid passing the --transifex option every time when calls the command, you can store it in package.json, next to the ckeditor5-package-tools translations:download command.

Examples:

yarn run translations:download --transifex [API URL]

translations:upload

Uploads translation messages onto the Transifex server. It allows for the creation of translations into other languages by users using the Transifex platform.

The task requires passing the URL to the Transifex API. Usually, it matches the following format: https://www.transifex.com/api/2/project/[PROJECT_SLUG].

To avoid passing the --transifex option every time when you call the command, you can store it in package.json, next to the ckeditor5-package-tools translations:upload command.

Examples:

yarn run translations:upload --transifex [API URL]

License

The @peergrade/ckeditor5-uploadfile package is available under MIT license.

However, it is the default license of packages created by the ckeditor5-package-generator package and it can be changed.