@types/ckeditor__ckeditor5-image
- Version 33.0.0
- Published
- 47.5 kB
- 10 dependencies
- MIT license
Install
npm i @types/ckeditor__ckeditor5-image
yarn add @types/ckeditor__ckeditor5-image
pnpm add @types/ckeditor__ckeditor5-image
Overview
TypeScript definitions for @ckeditor/ckeditor5-image
Index
Classes
Classes
class AutoImage
class AutoImage extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUtils, any, any, any];
method init
init: () => void;
class Image
class Image extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageBlock, typeof ImageInline];
class ImageCaption
class ImageCaption extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageCaptionEditing, typeof ImageCaptionUI];
class ImageCaptionEditing
class ImageCaptionEditing extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUtils, typeof ImageCaptionUtils];
method init
init: () => void;
class ImageCaptionUtils
class ImageCaptionUtils extends Plugin {}
The image caption utilities plugin.
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUtils];
method getCaptionFromImageModelElement
getCaptionFromImageModelElement: (imageModelElement: Element) => Element | null;
Returns the caption model element from a given image element. Returns
null
if no caption is found.
method getCaptionFromModelSelection
getCaptionFromModelSelection: (selection: Selection) => Element | null;
Returns the caption model element for a model selection. Returns
null
if the selection has no caption element ancestor.
method matchImageCaptionViewElement
matchImageCaptionViewElement: (element: ViewElement) => { name: true } | null;
pattern. Checks if a given element is a
<figcaption>
element that is placed inside the image<figure>
element.
class ImageEditing
class ImageEditing extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUtils];
method init
init: () => void;
class ImageInsert
class ImageInsert extends Plugin {}
The image insert plugin.
For a detailed overview, check the and documentation.
This plugin does not do anything directly, but it loads a set of specific plugins to enable image uploading or inserting via implemented integrations:
* * ,
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUpload, typeof ImageInsertUI];
class ImageInsertUI
class ImageInsertUI extends Plugin {}
property pluginName
static readonly pluginName: string;
method init
init: () => void;
class ImageResize
class ImageResize extends Plugin {}
The image resize plugin.
It adds a possibility to resize each image using handles.
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [ typeof ImageResizeEditing, typeof ImageResizeHandles, typeof ImageResizeButtons];
class ImageResizeButtons
class ImageResizeButtons extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageResizeEditing];
method init
init: () => void;
class ImageResizeEditing
class ImageResizeEditing extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUtils];
method init
init: () => void;
class ImageResizeHandles
class ImageResizeHandles extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [any];
method init
init: () => void;
class ImageStyle
class ImageStyle extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageStyleEditing, typeof ImageStyleUI];
class ImageStyleEditing
class ImageStyleEditing extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUtils];
method init
init: () => void;
class ImageStyleUI
class ImageStyleUI extends Plugin {}
property localizedDefaultStylesTitles
readonly localizedDefaultStylesTitles: { 'Full size image': string; 'Side image': string; 'Left aligned image': string; 'Centered image': string; 'Right aligned image': string; 'Wrap text': string; 'Break text': string; 'In line': string;};
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageStyleEditing];
method init
init: () => void;
class ImageTextAlternative
class ImageTextAlternative extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [ typeof ImageTextAlternativeEditing, typeof ImageTextAlternativeUI];
class ImageTextAlternativeEditing
class ImageTextAlternativeEditing extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUtils];
method init
init: () => void;
class ImageTextAlternativeUI
class ImageTextAlternativeUI extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [any];
method destroy
destroy: () => void;
method init
init: () => void;
class ImageToolbar
class ImageToolbar extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [typeof ImageUtils, any];
method afterInit
afterInit: () => void;
class ImageUpload
class ImageUpload extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [ typeof ImageUploadEditing, typeof ImageUploadUI, typeof ImageUploadProgress];
class ImageUploadEditing
class ImageUploadEditing extends Plugin {}
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: [any, any, any, typeof ImageUtils];
method afterInit
afterInit: () => void;
method init
init: () => void;
class ImageUploadProgress
class ImageUploadProgress extends Plugin {}
property placeholder
readonly placeholder: string;
The image placeholder that is displayed before real image data can be accessed.
property pluginName
static readonly pluginName: string;
method init
init: () => void;
method uploadStatusChange
uploadStatusChange: ( evt: EventInfo, data: Record<string, unknown>, conversionApi: DowncastConversionApi) => void;
This method is called each time the image
uploadStatus
attribute is changed.
class ImageUploadUI
class ImageUploadUI extends Plugin {}
property pluginName
static readonly pluginName: string;
method init
init: () => void;
Package Files (24)
- index.d.ts
- src/autoimage.d.ts
- src/image.d.ts
- src/image/imageediting.d.ts
- src/imagecaption.d.ts
- src/imagecaption/imagecaptionediting.d.ts
- src/imagecaption/imagecaptionutils.d.ts
- src/imageinsert.d.ts
- src/imageinsert/imageinsertui.d.ts
- src/imageresize.d.ts
- src/imageresize/imageresizebuttons.d.ts
- src/imageresize/imageresizeediting.d.ts
- src/imageresize/imageresizehandles.d.ts
- src/imagestyle.d.ts
- src/imagestyle/imagestyleediting.d.ts
- src/imagestyle/imagestyleui.d.ts
- src/imagetextalternative.d.ts
- src/imagetextalternative/imagetextalternativeediting.d.ts
- src/imagetextalternative/imagetextalternativeui.d.ts
- src/imagetoolbar.d.ts
- src/imageupload.d.ts
- src/imageupload/imageuploadediting.d.ts
- src/imageupload/imageuploadprogress.d.ts
- src/imageupload/imageuploadui.d.ts
Dependencies (10)
- @types/ckeditor__ckeditor5-clipboard
- @types/ckeditor__ckeditor5-core
- @types/ckeditor__ckeditor5-engine
- @types/ckeditor__ckeditor5-image
- @types/ckeditor__ckeditor5-typing
- @types/ckeditor__ckeditor5-ui
- @types/ckeditor__ckeditor5-undo
- @types/ckeditor__ckeditor5-upload
- @types/ckeditor__ckeditor5-utils
- @types/ckeditor__ckeditor5-widget
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/ckeditor__ckeditor5-image
.
- Markdown[](https://www.jsdocs.io/package/@types/ckeditor__ckeditor5-image)
- HTML<a href="https://www.jsdocs.io/package/@types/ckeditor__ckeditor5-image"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3535 ms. - Missing or incorrect documentation? Open an issue for this package.