Sign up (with export icon)

LinksProvider

Api-typedef icon typedef

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

Properties

  • Chevron-right icon

    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.

  • Chevron-right icon

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

  • Chevron-right icon

    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.

  • Chevron-right icon

    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.
    
    Copy code
  • Chevron-right icon

    navigate : boolean

    Callback called when user clicked the link in the list.

  • Chevron-right icon

    order : number | undefined

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