Ckeditor5 entity browser
This module adds buttons to the CKEditor 5 link interface that open the entity browser. This allows users to easily search for and insert existing content as links.
This module provides a Ckeditor5 plugin which integrates with the entity browser module. It will show buttons in the Ckeditor link user interface to open modal with entity browsers, enabling easy searching, filtering and inserting of existing content as a link.
Features
- Provide buttons in link UI which open entity browsers
- Insert selected entity in the link UI
- Configure desired entity browsers per text format
- Customize settings using a hook alter
- Works together with other link UI plugins like linkit.
Post-Installation
- Install and enable entity browser module
- Install and enable this module
- Configure at least one entity browser view
- Make sure the view has a bulk select form *
- Navigate to a text format which has ckeditor5 enabled
- Enable at least one entity browser
- Insert a link, notice the new button(s)
* Note: it is recommended to enable 'Use field cardinality' in the entity browser view. This will show radio buttons instead of checkboxes which makes sense, since you always
want to insert one link at a time.
Additional Requirements
This module depends on the entity browser module and of course core ckeditor 5.
Recommended modules/libraries
You can use this module together with modules like linkit, which also provide a ckeditor 5 plugin for the link UI.
Similar projects
There is linkit_entity_browser but it has no ckeditor 5 version yet and required linkit.
Notes
Currently, you can use the provided hook alter to change any
config you need. For example button weights and labels.
Limitations
Only canonical entities can be inserted at this time. See #3440351: Use relative url if bundle type is 'file'. if you want to work on that.