function sidr_help in Sidr: Accessible Mobile Menus 8.3

Same name and namespace in other branches

1. 8.2 sidr.module \sidr_help()

Implements hook_help().

File

./sidr.module, line 30

Hooks and callbacks for the Sidr module.

Code

function sidr_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.sidr':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Sidr module for Drupal allows you to create "trigger" blocks. These triggers use the Sidr libraries to slide in / slide out a specified target element. This is very useful for implementing responsive menus and much more.') . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Configuring') . '</dt>';
      $output .= '<dd>' . t('From the <a href=":block-layout">Block layout</a> page, click on the <em>Place block</em> button for the region in which you want to place the trigger for your Sidr and place a <em>Sidr trigger button</em> block. This trigger will toggle your Sidr panel. Configure the block by reading the instructions on the configuration form and save it. The Sidr trigger should be visible on your site. If you click on the trigger, you should see a Sidr menu sliding out as per your configuration.', [
        ':block-layout' => Url::fromRoute('block.admin_display')
          ->toString(),
      ]) . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}