Distinguish autocomplete results with "Unpublished" state

A more customizable alternative, and one that is more accessible since it doesn't indicate state purely by color, would be to use Linkit's configurable metadata information to indicate the node status ("Published/Not published") in the results.

The one roadblock to this is that Drupal core does not (yet) provide a token for node status. See ✨ Add a token for publication status Fixed .

Once that lands, this can be done easily in Linkit.

In the meantime, folks can implement the publication status token in custom code:

/**
 * Implements hook_token_info().
 */
function mymodule_token_info() {
  $type = [
    'name' => t('Nodes'),
    'description' => t('Tokens related to individual content items, or "nodes".'),
    'needs-data' => 'node',
  ];
  $node['mymodule_publication_state'] = [
    'name' => t("Publication state"),
    'type' => 'node',
  ];
  return [
    'types' => ['node' => $type],
    'tokens' => ['node' => $node],
  ];
}

/**
 * Implements hook_tokens().
 */
function mymodule_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
  $replacements = [];
  if ($type == 'node' && !empty($data['node'])) {
    /** @var \Drupal\node\NodeInterface $node */
    $node = $data['node'];
    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'mymodule_publication_state':
          $replacements[$original] = $node->isPublished() ? 'Published' : 'Not published';
          break;
      }
    }
  }
  return $replacements;
}

I really like the result in #2 and I think the correct approach would be to add a class for the published state on each result. By default an unpublished state should then have a light red background as in #2 from the module's CSS.

Assigning myself for review...

Would be nice if it also takes workflow states in account (draft, archived)?

The patch from #3 added logic for the field widget display, but not for the CKEditor plugin. The attached patch adds logic for the latter, and slightly changes the implementation:

Before:

+     var $wrapper = $('<div>').addClass('linkit-result-line-wrapper ' + item.status);

After:

+     var $wrapper = $('<div>').addClass('linkit-result-line-wrapper');
+    $wrapper.addClass(item.status);

Before:

+     return $entity->status->getString() ? 'published' : 'unpublished';

After:

+         return $entity->isPublished() ? 'published' : 'unpublished';

The last submitted patch, 10: 3094710-entity-status-10.6.0.x.patch, failed testing. View results →
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

Looks like the test failures are valid, since they're looking for a specific CSS string:

Drupal\Tests\linkit\FunctionalJavascript\LinkFieldTest::testLinkFieldWidgetAndFormatter
Behat\Mink\Exception\ElementNotFoundException: Element matching css "ul.linkit-ui-autocomplete li.linkit-result-line span.linkit-result-line--title" not found

Okay, not all entity types have a "status" value, so we need to add a conditional!

    if ($entity->getEntityType()->hasKey('status')) {
      $entity = \Drupal::entityTypeManager()->getStorage($entity_type)->load($entity->id());
      return $entity->isPublished() ? 'published' : 'unpublished';
    }

Would be nice if it also takes workflow states in account (draft, archived)?

I think this would need to be handled by way of configuring matcher metadata, similar to what is described in https://www.drupal.org/project/linkit/issues/3094710#comment-14984839 ✨ Distinguish autocomplete results with "Unpublished" state Fixed

Automatically closed - issue fixed for 2 weeks with no activity.