design-comuni-plone-theme/src/helpers/getWidgetView.js

Volto Theme for Italia design guidelines

import config from '@plone/volto/registry';

/**
 * Get widget by field's `id` attribute
 * @method getWidgetByFieldId
 * @param {string} id Id
 * @returns {string} Widget component.
 */
const getWidgetByFieldId = (id) => config.widgets.views.id[id] || null;

/**
 * Get widget by field's `front end options` attribute
 * @method getWidgetFromTaggedValues
 * @param {object} widgetOptions widgetOptions
 * @returns {string} Widget component.
 */
const getWidgetFromTaggedValues = (widgetOptions) =>
  typeof widgetOptions?.frontendOptions?.widget === 'string'
    ? config.widgets.views.widget[widgetOptions.frontendOptions.widget]
    : null;

/**
 * Get widget by field's `widget` attribute
 * @method getWidgetByName
 * @param {string} widget Widget
 * @returns {string} Widget component.
 */
const getWidgetByName = (widget) =>
  typeof widget === 'string' ? config.widgets.views.widget[widget] : null;
/**
 * Get widget by field's `vocabulary` attribute
 * @method getWidgetByVocabulary
 * @param {string} vocabulary Widget
 * @returns {string} Widget component.
 */
const getWidgetByVocabulary = (vocabulary) =>
  vocabulary && vocabulary['@id']
    ? config.widgets.views.vocabulary[
        vocabulary['@id'].replace(
          `${config.settings.apiPath}/@vocabularies/`,
          '',
        )
      ]
    : null;

/**
 * Get widget by field's hints `vocabulary` attribute in widgetOptions
 * @method getWidgetByVocabularyFromHint
 * @param {string} props Widget props
 * @returns {string} Widget component.
 */
const getWidgetByVocabularyFromHint = (props) =>
  props.widgetOptions && props.widgetOptions.vocabulary
    ? config.widgets.views.vocabulary[
        props.widgetOptions.vocabulary['@id'].replace(
          `${config.settings.apiPath}/@vocabularies/`,
          '',
        )
      ]
    : null;

/**
 * Get widget by field's `choices` attribute
 * @method getWidgetByChoices
 * @param {string} choices Widget
 * @returns {string} Widget component.
 */
const getWidgetByChoices = (props) => {
  if (props.choices) {
    return config.widgets.views.choices;
  }

  if (props.vocabulary) {
    // If vocabulary exists, then it means it's a choice field in disguise with
    // no widget specified that probably contains a string then we force it
    // to be a select widget instead
    return config.widgets.views.choices;
  }

  return null;
};

/**
 * Get widget by field's `type` attribute
 * @method getWidgetByType
 * @param {string} type Type
 * @returns {string} Widget component.
 */
const getWidgetByType = (type) => config.widgets.views.type[type] || null;

/**
 * Get default widget
 * @method getWidgetDefault
 * @returns {string} Widget component.
 */
const getWidgetDefault = () => config.widgets.views.default;

/**
 * Get Widget View
 * @method getWidgetView
 * @param {dict} props Props
 * @returns {string} Widget component.
 */
export const getWidgetView = (props) =>
  getWidgetByFieldId(props.id) ||
  getWidgetFromTaggedValues(props.widgetOptions) ||
  getWidgetByName(props.widget) ||
  getWidgetByChoices(props) ||
  getWidgetByVocabulary(props.vocabulary) ||
  getWidgetByVocabularyFromHint(props) ||
  getWidgetByType(props.type) ||
  getWidgetDefault();