Requires the deprecated Tour module

Created on 11 July 2024, 4 months ago
Updated 15 July 2024, 4 months ago

Problem/Motivation

On installation , this module requires the core Tour module which is deprecated although that fact is not specified in the sitetour.info.yml, is that a good idea planning for the future?

Might it not be a better idea to join forces with the proposed new contrib' Tour module and get v2.x out instead of reinventing?

It also appears to require the Paragraphs module (explicitly specified in the sitetour.info.yml) which can't be right; it might well usefully support the use of Paragraphs but it should not require it surely?

💬 Support request
Status

Active

Version

3.0

Component

Miscellaneous

Created by

🇬🇧United Kingdom SirClickALot Somerset

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

Comments & Activities

  • Issue created by @SirClickALot
  • 🇬🇧United Kingdom SirClickALot Somerset
  • 🇬🇧United Kingdom SirClickALot Somerset
  • 🇮🇳India Elavarasan R

    @SirClickalot, This module does not depends on core Tour module. So core Tour module is not required to install.

    Paragraphs module dependencies:

    This module support two ways to implement 'Site Tour' popup.

    1) Block Configuration with Paragraphs module
    2) Render Element(API)

    If we are using Block Configuration, then not required to write any code. This module created one block type called "Site Tour".
    We can create one custom block with this block type to show the different set of content in different places as popup.
    To add the different set of content, it means collection of fields(Paragraphs) has been included as reference field in this block.

    Render Element, In this way developer can generate their own array format as below based on their requirements to show the site tour popup.

          $tour = [];
          $build['sitetour']['#data']['tour'] = [];
          $build['sitetour']['#type'] = 'sitetour';
    
          // First tour element
    
          $tour['id'] = 'sitetour';
          $tour['steps'][0]['target'] = '#slide-show'; // Dom element id
          $tour['steps'][0]['title'] = 'Slide show';
          $tour['steps'][0]['content'] = 'It includes five images. Please click the next button to view the next slide image.';
          $tour['steps'][0]['placement'] = 'bottom';
          $tour['steps'][0]['arrowOffset'] = 60;
    
           // Second tour element
    
          $tour['steps'][1]['target'] = '.search'; // Dom element class
          $tour['steps'][1]['title'] = 'Search Box';
          $tour['steps'][1]['content'] = 'Please enter the text in the search box and click enter button to search.';
          $tour['steps'][1]['placement'] = 'bottom';
          $tour['steps'][1]['arrowOffset'] = 60;
          $build['sitetour']['#data']['tour'] = $tour;
       
  • 🇬🇧United Kingdom SirClickALot Somerset

    You're absolutely right, I could have sworn it told me in the UI that it needed to enable the core Tour module but I was clearly deluded as I've tried again today and it didn't.

    Might be worth adding paragraphs as a dependency into the module's composer.jsonn though so that when installing via composer it automatically attempts to install it?

  • 🇮🇳India Elavarasan R

    @SirClickalot, Good idea! Sure, It will be available on next release.

Production build 0.71.5 2024