Link it support for pages created using views

Unfortunately this is not possible at the moment.

You can create a new feature request issue, or convert this into on if you like.

++!

++!

Having a look at this.

linkit.autocomplete.js only allows us to set (as I understand it) three data attributes for a suggestion: data-entity-type, data-entity-uuid, data-entity-substitution.

Views are entities, so we can build a Matcher that passes the entity type "view" and the view uuid to the autocomplete if criteria (e.g. view name) are matched. So far so good.

We then need a custom substitution plugin "view" to handle the entity type. (We set data-entity-substitution="view" and the LinkitFilter will load it.) The substitution plugin can load the ViewExecutable and can generate a URL using it. However, there is no way to pass in a display id as a data attribute, so currently I'm just linking to page_1 as a default.

If linkit.autocomplete.js would allow an extra field, e.g. data-entity-meta, the LinkitFilter could pass the meta data to the substitution plugin which could use it to generate the url.

(Ignoring the title attribute for now.)

Solved this using a different approach, using a custom configuration entity to store Drupal route information:

Create a custom config entity "Linkit custom link" that stores the route data (name, parameters, query string, etc.).

Create a custom Matcher to match custom links using the label (e.g. "Events list" is mapped to view.events.page_1.)

Create a custom Substitution class for custom links. The getUrl() method receives the custom entity we created from Linkit. We can now use the stored route information to build and return the URL. All of the required meta data is in the custom entity.

Site builders can define any number of custom links as long as they use a Drupal route, so Linkit can then provide editors with links to custom controllers, views.

The custom link entity could also accept external URLs, so that external links (e.g. "service portal") could be provided and updated centrally.

Patch attached and issue summary updated

This patch is functionnally OK, but I did not update any tests for now. I would like first an approval on the direction by module maintainer before further work.

I did some testing on my sites, and one issue I ran into is that it's trying to process views that require arguments in their paths. This causes the Url::fromRoute call to throw an exception. I don't think there's a use case to support views like that, since we'd have no way to know what the argument is, so I'm just filtering them out of the result set for now.

Fixing the linting issue with the previous patch

I still add the error after upgrading to #10.
Symfony\Component\Routing\Exception\RouteNotFoundException : Route "view.portfolio." does not exist.
Notice the extra point "." at the end of the route. It comes from
"view.{$entity->id()}.$extra"
where $extra is always empty.

The reason is an uproper key in my patch #8 which leads to no substitution-extra added to the WYSIWYG.
Fixing that in attached patch.

damn... I forgot to include the new files in patch #11.

Thanks for this great patch.

I have made some improvements:
- There was a small issue with the "Include disabled views" setting. It didn't get saved when submitting the config form. This is now fixed.
- The view storage is now a class variable, set by the __construct.
- Made an extra setting to make it possible to only allow a selection of the views to be used by LinkIt.

Hope you like it :)

I have made a new patch with some more improvements to be more in line with the other matchers.

For a client, we have now implemented the patch of comment #14. But after a bit of testing, our client requests the possibility to search by display title instead of only the view label or display path.

I added the option. Here is a newer version of the patch.

Sorry, something went wrong while creating te previous patch.
Here is te correct one.

From a sitebuilding perspective, this is working great. This is a very helpful feature to have. Thank you to everyone who has worked on this. I'm going to leave it as Needs Review for someone else to do a code review.

Here is a new version of the patch. After some time running the patch from #16, we noticed some errors in the logs about non-existing routes:

Symfony\Component\Routing\Exception\RouteNotFoundException: Route "view.news_overview." does not exist. in Drupal\Core\Routing\RouteProvider->getRouteByName() (regel 206 van /app/web/core/lib/Drupal/Core/Routing/RouteProvider.php).

This was caused by a text-format with the html-filter enabled. The data-entity-substitution-extra attribute was not in the allowed attributes for the <a> tag, so the html-filter deleted it.

The old patch did not check if the display_id (which should be stored in the data-entity-substitution-extra attribute) was present, so I did some improvements:

• There is now a check if the data-entity-substitution-extra contains a view display ID.
• There is now a check if the given display ID exists on the view and the display is a page display.
• If one of the checks above fails, a warning is saved in the watchdog log instead of a nasty Exception

Another important note:
The patch (old+new) has a change in the SubstitutionInterface. Any other (custom) modules that uses this interface will break if this patch is applied, because of the new $extra parameter that was added to the getUrl method. So that is something to remember to put in the changelogs!

Oops, I accidentally re-uploaded the old patch instead of the new one. Here is the new version.

Another iteration of the patch. The matcher now also matches the view displays by matching path aliases. So for example, the path of the view display page is /news, but there is a translated path alias /nieuws, the view display will now also be found when searching for /nieuws.

Does anybody know if there is something like this available for 6.x or can we use this patch as a base to create a patch for the 6.x version?

I did a quick update of the patch for 6.0.0-rc1, haven't tested it much, but it seems to work.

My experience with the patch is that it works well with one main caveat... the "data-entity-substitution-extra" attribute is not automatically added to the <a> when choosing the view.

If I add it manually in source, save, and then go to add another link to a view, the second link will have it added automatically.

Seems very odd and have been banging my head against the wall trying to figure out why.

Like the idea of this patch and it's a shame the functionality isn't already there (pretty much every other entity type can be matched). Doesn't apply to 6.0 branch.

Did another quick tweak of the patch for 6.0.2 support.
Haven't tested it more than to see that linking views still work locally.

Noticed an issue with the patch at #25 so i made an update for it (This is for 6.0.0-rc1)