Umbraco 15.4.1 Contentment 6.0.0-alpha007 Custom Data Source

[chrisgeorge-i-finity]

Hello,

New to using contentment I'm trying to create a custom DataPickerSource as I need to generate a list of items that I have generated and cached on my project. I have the code below which I got from the examples updated to using the new return types but I can't work out how to get the option to appear in the backend as an data source. The documentation says about creating a custom display mode but not sure if that's mandatory or not or if there's another step to do. Any help would be appreciated.

public class FilmDataSource : IDataPickerSource
{
    private readonly IDataAccessService _dataAccessService;

    public FilmDataSource(IDataAccessService dataAccessService)
    {
        _dataAccessService = dataAccessService;
    }

    public string Name => "Films Data Source";
    public string Description => "List of all films";
    public string Icon => "icon-movie-alt";
    public Dictionary<string, object>? DefaultValues => default;
    public IEnumerable<ContentmentConfigurationField> Fields => default;
    public string Group => "Custom";
    public OverlaySize OverlaySize => OverlaySize.Small;

    public async Task<IEnumerable<DataListItem>> GetItemsAsync(Dictionary<string, object> config, IEnumerable<string> values)
    {
        var results = await _dataAccessService.Films();

        var items = new List<DataListItem>();

        foreach (var result in results)
        {
            items.Add(new DataListItem
            {
                Name = result.Title,
                Value = result.ID
            });
        }

        return items.OrderBy(x => x.Name);
    }

    public async Task<PagedViewModel<DataListItem>> SearchAsync(Dictionary<string, object> config, int pageNumber = 1, int pageSize = 12, string query = "")
    {
        var results = await _dataAccessService.Films();

        var items = new List<DataListItem>();

        foreach (var result in results)
        {
            items.Add(new DataListItem
            {
                Name = result.Title,
                Value = result.ID
            });
        }

        var offset = (pageNumber - 1) * pageSize;

        return new PagedViewModel<DataListItem>()
        {
            Total = pageSize > 0 ? (long)Math.Ceiling(items.Count() / (decimal)pageSize) : 1,
            Items = items.Skip(offset).Take(pageSize)
        };
    }
}

[leekelleher]

@chrisgeorge-i-finity Apologies for the delay in replying.

The C# code looks correct, (I assume it compiles fine for you?). There's no need for a custom display mode (unless you want one?).

If the C# compiles fine, then a quick way to check if it is loaded into the backoffice is by going to "Settings > Extension Insights" and searching to see if the custom data-source has been registered. If not, then let me know some more about your set-up, environment, etc.

[chrisgeorge-i-finity]

Hi, thanks for getting back to me.

Yeah the code compiles fine. I've checked the Extension Insights and it's not appearing in the list.

I'm not sure what info you want exactly but the project is .net 9.0 with Umbraco 15.4.1 running locally off a SQL DB for Umbraco. If there's anything more specific you need just ask.

[leekelleher]

Thanks for the info. Hmmm, because it's not showing up in the Extension Insights, it sounds like a bug in Contentment.

Could you try something for me, (please)? 🙏

In your custom data-source, try implementing the IContentmentDataSource interface; it doesn't matter what the GetItems method returns, I just want to rule out something.

public class FilmDataSource : IDataPickerSource, IContentmentDataSource
{
    // <snip>

    IEnumerable<DataListItem> GetItems(Dictionary<string, object> config) => [];

    // <snip>
}

[chrisgeorge-i-finity]

Added that method in and now the DataSource is appearing in the Extension Insights

[leekelleher]

Following up on this, I've patched this up in commit 9215f2a, so that IDataPickerSource works without requiring the additional IContentmentDataSource. This hasn't been released in a v6.x alpha version yet. My aim is to do some more refactoring to the interfaces so simplify them between Data List and Data Picker editors, (before the final release).

[chrisgeorge-i-finity]

Hi @leekelleher, sorry to come back to this. I've upgraded Contentment to the latest Alpha with Umbraco 16 and with it can get it to pull the data source through now but it seems to be auto setting every item onto the property automatically without the user selecting anything. Do I need to change something else or is this another bug?

For example a completely new page but the item already has over 4000 films set against it