CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

ImportWordConfig (import-word)

@ckeditor/ckeditor5-import-word/src/importword

interface

The configuration of the import from Word feature.

The configuration for the import from Word feature requires providing the config.importWord.tokenUrl:

ClassicEditor
	.create( editorElement, {
		importWord: {
			tokenUrl: 'https://example.com/cs-token-endpoint'
		}
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • converterUrl : string | undefined

    A URL to the Docx converter.

    const importWordConfig = {
	converterUrl: 'https://myconverter.com/v1/'
}

    Note: The plugin uses the default Word to HTML converter delivered by CKEditor Cloud Services. You can provide a URL to an on-premises converter instead.

    Defaults to 'https://docx-converter.cke-cs.com/v2/convert/docx-html'

  • formatting : FormattingOptions

  • tokenUrl : TokenUrl | undefined

    A token URL or a token request function. This field is optional and should be used only when a different tokenUrl is required for the Import from Word feature.

    Note: The token can be disabled with the false value provided.

    See: tokenUrl