PHPackages                             ics/userhelp-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. ics/userhelp-bundle

ActiveSymfony-bundle[Utility & Helpers](/categories/utility)

ics/userhelp-bundle
===================

Bundle for manage user helps

0.0.5(4y ago)17MITJavaScript

Since Nov 28Pushed 4y ago1 watchersCompare

[ Source](https://github.com/imperiumclansoftware/userhelp-bundle)[ Packagist](https://packagist.org/packages/ics/userhelp-bundle)[ RSS](/packages/ics-userhelp-bundle/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (5)Dependencies (9)Versions (6)Used By (0)

Imperium Clan Software - Userhelp Bundle
========================================

[](#imperium-clan-software---userhelp-bundle)

Userhelp management for symfony

This bundle provide javascript help for symfony with :

- [Tracelytics pageguide.js](https://tracelytics.github.io/pageguide/) for inline help

Installation
------------

[](#installation)

Make sure Composer is installed globally, as explained in the [installation chapter](https://getcomposer.org/doc/00-intro.md)of the Composer documentation.

### Applications that use Symfony Flex

[](#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

[](#applications-that-dont-use-symfony-flex)

#### Step 1: Download the Bundle

[](#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

[](#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
-------------

[](#configuration)

### Help Initialisation

[](#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

[](#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  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

[](#intro-initialisation)

#### Routing Installation

[](#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

[](#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

###  Health Score

21

—

LowBetter than 18% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

5

Last Release

1627d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1b8cd72721fa699d3afa402c0057a9438c0556e734f1128e6ffff0212f3afa42?d=identicon)[ics](/maintainers/ics)

---

Top Contributors

[![ddutas](https://avatars.githubusercontent.com/u/46941784?v=4)](https://github.com/ddutas "ddutas (7 commits)")

### Embed Badge

![Health badge](/badges/ics-userhelp-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/ics-userhelp-bundle/health.svg)](https://phpackages.com/packages/ics-userhelp-bundle)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k16.7M310](/packages/easycorp-easyadmin-bundle)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[contao/core-bundle

Contao Open Source CMS

1231.6M2.4k](/packages/contao-core-bundle)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)