CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Typedef

LinksProvider (link)

@ckeditor/ckeditor5-link/src/linkui

typedefobject
See source

Interface for a provider that provides a list of links to be displayed in the link form view.

Filtering

Properties

  • emptyListPlaceholder : string | undefined

    Message to be displayed when there are no items in the list. It's optional and if not provided, a default message will be displayed.

  • getItem : null | LinksProviderDetailedItem

    Optional callback for retrieving an item by its URL. If not provided the item from the list will be used.

  • getListItems : Array<LinksProviderListItem>

    Callback for retrieving an static array of items which is being called every time the list is displayed. It's not required to provide all links at once, it's possible to pass only slice of links.

  • label : string

    Label that serves two purposes:

    * As a text for the button that opens this link list from within link form view.
* As a text for the header when the list of links from this provider is displayed.

  • navigate : boolean

    Callback called when user clicked the link in the list.

  • order : number | undefined

    Weight used for ordering providers in the list. Higher weight means the provider will be displayed lower in the list.