OnBoarding

About

This module help the user to create his first product and discover main functionnalities to create his shop.

How to customize the OnBoarding

Every steps are stored on the config/steps.yml file.

On this file you will have groups containing the steps. Just follow this micro documentation to create / modify the steps:

groups:                            # Only needed once

 - title: { loc: group1.title }    # The title of the group, shown on the footer.
   steps:                          # The steps list of this group.

     # Basic configuration for each step:
     - type: popup                 # The type of the step, can be 'popup' or 'tooltip'.
       title: { loc:group1.title } # The title of the step, shown on the footer.
       text:  { loc:group1.title } # The content of the step, displayed on the popup or the tooltip
       page:  'product/new'        # The page where the step is placed
       # OR : An array of pages, when the Onboarding automaticaly move to the page, the first one
       # will be selected :
       page:  ['product/new', 'product/form'] 

       # Configuration only for type = 'tooltip':
       selector: '#description' # The jQuery selector where the toolip will be located
       position: top            # The position of the tooltip around the object, can be :
                                # 'left', 'right', 'top' or 'bottom'
                                
       # Optionnal parameters:
       action:                 # Instead of just move to the next step, an action can be performed:
         selector: '#myButton' # jQuery selector where the action will be performed
         action:   'click'     # Action to perform
       options: [savepoint]    # A list of options for this step, the options can be :
                               #  - 'savepoint': If the user resume after paused, the first save
                               #      will be the last savepoint
                               #  - 'hideFooter': Hide the footer for the current step

Just a word for the localization:

The localized entries are on the config/localization folder. Each entries have a key. To use one of this entry, just use { loc: key.subkey } instead of a string. (For the titles and contents).

If you want complex content, just create a TWIG template on the views/contents and use { content: templateName } instead of a string.

Reporting issues

You can report issues with this module in the main PrestaShop repository. Click here to report an issue.

Contributing

PrestaShop modules are open source extensions to the PrestaShop e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements.

Requirements

Contributors must follow the following rules:

Make your Pull Request on the "dev" branch, NOT the "master" branch.
Do not update the module's version number.
Follow the coding standards.

Process in details

Contributors wishing to edit a module's files should follow the following process:

Create your GitHub account, if you do not have one already.
Fork this project to your GitHub account.
Clone your fork to your local machine in the /modules directory of your PrestaShop installation.
Create a branch in your local clone of the module for your changes.
Change the files in your branch. Be sure to follow the coding standards!
Push your changed branch to your fork in your GitHub account.
Create a pull request for your changes on the 'dev' branch of the module's project. Be sure to follow the contribution guidelines in your pull request. If you need help to make a pull request, read the GitHub help page about creating pull requests.
Wait for one of the core developers either to include your change in the codebase, or to comment on possible improvements you should make to your code.

That's it: you have contributed to this open source project! Congratulations!

License

This module is released under the Academic Free License 3.0

4.3 KiB Raw Permalink Blame History