ics/userhelp-bundle

Bundle for manage user helps

0.0.5 2021-12-03 13:09 UTC

Requires

• doctrine/orm: ^2.8
• ics/navigation-bundle: ^0
• symfony/config: ^5
• symfony/dependency-injection: ^5
• symfony/form: ^5
• symfony/framework-bundle: ^5
• symfony/routing: ^5
• symfony/security-bundle: ^5
• twig/twig: ^3.3

MIT

README

Userhelp management for symfony

This bundle provide javascript help for symfony with :

• Tracelytics pageguide.js for inline help

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

composer require ics/userhelp-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require ics/userhelp-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    ICS\UserhelpBundle\UserhelpBundle::class => ['all' => true],
];

Configuration

Help Initialisation

Add this lines in base.html.twig. The code show help only if route is configured in userhelp.yaml

{# ... #}
{{  AddHelpCSS() }}
{% block stylesheets %}

{% endblock %}
{# ... #}
{{  AddHelpJS() }}
{% block javascripts %}

{% endblock %}
{# ... #}
{% block body %}

{% endblock %}
{{ AddHelpHtml() }}

Help configuraton

Create a new file userhelp.yaml

userhelp:
  helpColor: primary
  helpButtonIdentifier: helpButton
  helps:
    homepage: # route to add help
      elements:
        titlePage: # html element id
          position: bottom
          description: Title of the page # help for this element
        mainmenu:
          position: right
          description: Main menu
        homepagelink:
          position: right
          description: return to <i class="fa fa-home"></i> homepage # html is enabled in help element

helpcolor properties values are :

• primary
• secondary
• success
• warning
• danger
• info
• dark

position property values are :

• left
• top
• right
• bottom

Intro Initialisation

Routing Installation

Intro needs route for save if user see all intro, configure config/routes.yaml

# config/routes.yaml

userhelp_bundle:
  resource: "@UserhelpBundle/config/routes.yaml"
  prefix: /user/help

Adding js and css files to your base.html.twig. The code show intro only if route is configured in userhelp.yaml

{# base.html.twig #}
{# ... #}
{{  AddIntroCSS() }}
{% block stylesheets %}

{% endblock %}
{# ... #}
{{  AddIntroJS() }}
{% block javascripts %}

{% endblock %}

Intro configuraton

Create a new file userhelp.yaml

userhelp:
  introButtonIdentifier: introButton
  introTheme: modern
  intros:
    homepage: #Route name
      elements:
        pagetitle: #Element where intro step attach
          title: Page title
          description: description of the page title #Support HTML
        leftmenu:
          title: Menu of page
        mainpage:
          title: Content of page
        rightmenu:
          title: Menu of page

introTheme property values are :

• dark
• flattener
• modern
• nassim
• nazanin
• royal