Contrib.social

Exposed filter doesn't display Distance units for Select list input

Open on Drupal.org →
Created on 16 September 2022, over 2 years ago
Updated 7 August 2023, over 1 year ago

Problem/Motivation

I'm unable to change the Distance units from km to miles if I use a Select list in the Location plugin in an exposed filter. The Distance units form field only displays if I use the textfield.

Is there a reason why I can't change the radius when using a select list? I know I could just modify it in the yml config, but is there some solr-related reason why I shouldn't change from km to miles in this case? Some deeper context that I'm not aware of?

It's also worth noting this potential bug that's due to the Distance units field not always being visible.

  • Select Type of distance input: Textfield
  • Select Distance units: Miles
  • Change Type of distance input back to Select
  • Save and export config
  • The config is now set to miles.

If I can no longer see and modify the field, I would expect that it wouldn't save that value. That sounds like a bug.

Unless I find out otherwise, I'm going to assume that I can safely use a Select list and miles, and I'm going to post a patch to remove the visibility state. If the Distance unit field is always visible, then the potential bug would be moot.

This snippet is where the visibility state is set: /search_api_location/src/LocationInput/LocationInputPluginBase.php

$form['radius_units'] = [
  '#type' => 'select',
  '#title' => $this->t('Distance units'),
  '#description' => $this->t('Choose the units for the distance.'),
  '#default_value' => $this->configuration['radius_units'],
  '#options' => array_column(search_api_location_get_units(), 'label', 'id'),
  '#states' => [
    'visible' => [
      'select[name="options[plugin-' . $this->pluginId . '][radius_type]"]' => ['value' => 'textfield'],
    ],
  ],
];

Steps to reproduce

There's some search api, geofield, and views setup involved to get to this point, but here's the short version based on my site's configuration.

  • Create a search index view
  • Add a filter for a lat/long field
  • Input method: Geocode input
  • Type of distance input: Select (which is the default)
  • Note you have that you get a Distance options field, but the Distance unit field is not visible.
  • Change Type of distance input to Text field
  • Note the Distance units field is now visible and the Distance options field is removed.
  • Apply changes and Save the view
  • Edit the settings for the filter
  • Change Type of distance input to Select
  • Note the Distance units field is no longer visible.
  • Apply changes and Save the view
  • Export configuration
  • View generated yml file and note that Radius units is still miles radius_units: mi but you'd have no way to change it back to km via the UI if you wanted to use a Select list.

Proposed resolution

Remove the conditional visible state from the radius_unit form field.

User interface changes

The Distance units field will always be visible, without regard to the Distance type of input.

💬 Support request
Status

Needs review

Version

1.0

Component

Code

Created by

🇺🇸United States capysara

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

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024