Contrib.social

Allow recipes to expose additional follow-up tasks to Project Browser

Open on Drupal.org →
Created on 7 February 2025, about 2 months ago

This is a pretty big feature request and probably won't get done in a single issue. But, gotta document the plan somewhere.

The request is for Project Browser to allow recipes to expose follow-up tasks once they have been applied. A follow-up task can simply be thought of as a simple link to some other page, where you can take further action. I visualize this as a drop button that extends from the "Installed" badge that you see when a recipe has been applied in Project Browser.

What sort of things could you do with follow-up tasks?

  • Link the user to relevant settings/configuration pages.
  • Link to the form to uninstall a particular module (most useful for recipes that provide a third-party integration).
  • Link to documentation.
  • Link to routes that maybe do further setup (e.g., confirmation forms that trigger batch jobs).

I can see the usefulness.

This necessitates a small addition to the core recipe system, so that the recipe has a place to define information that Project Browser can use. That was added in ✨ Allow recipes to contain an "extra" field with arbitrary information for specific modules to use Active , which was backported to 11.1.x and will therefore be available in Drupal 11.1.3 and up.

I picture recipes using the extra property to integrate with Project Browser like so:

extra:
    project_browser:
        tasks:
            - text: Uninstall
              route_name: project_browser.uninstall_modules
              route_paramters: google_tag,ai_openai
            - text: Documentation
              route_name: help.page
              route_parameters: google_tag
              options:
                query:
                    from_pb: true

Those are simply dehydrated \Drupal\Core\Link objects. In Project Browser, they'd be displayed as items in a drop-button.

To implement this, we'd need at least two phases.

  • 1A. The activators need to be able to return project-specific tasks. I think this calls for some reorganizing in the activator system, which means this will probably necessitate a breaking change. But hey, we're still in alpha, so...full steam ahead, I guess.
  • 1B. The tasks need to be sent to the frontend as simple JSON objects that look like: {"text": "Link Text", "url": "/full/url/path?and=query+parameters"}
  • 2. The frontend needs to render these things as drop buttons that are accessible via the keyboard, properly styled in light and dark mode, etc. Fun times!
✨ Feature request
Status

Active

Version

2.0

Component

User experience

Created by

🇺🇸United States phenaproxima Massachusetts

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024