public function DefaultStyleguide::items in Style Guide 8

Same name and namespace in other branches

1. 2.x src/Plugin/Styleguide/DefaultStyleguide.php \Drupal\styleguide\Plugin\Styleguide\DefaultStyleguide::items()

Styleguide elements implementation.

Return value

array An array of Styleguide elements.

Overrides StyleguideInterface::items

File

src/Plugin/Styleguide/DefaultStyleguide.php, line 162

Class

DefaultStyleguide

Default Styleguide items implementation.

Namespace

Drupal\styleguide\Plugin\Styleguide

Code

public function items() {
  $current_url = $this->requestStack
    ->getCurrentRequest()
    ->getRequestUri();
  $items['a'] = [
    'title' => $this
      ->t('Link'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} {{ link }} {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'link' => $this
          ->buildLink($this->generator
          ->words(3), '/node'),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['b'] = [
    'title' => $this
      ->t('Bold'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <b>{{ bold }}</b> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'bold' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['del'] = [
    'title' => $this
      ->t('Delete'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <del>{{ del }}</del> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'del' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['em'] = [
    'title' => $this
      ->t('Emphasis'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <em>{{ em }}</em> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'em' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['figcaption'] = [
    'title' => $this
      ->t('Figcaption'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <figcaption>{{ figcaption }}</figcaption> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'figcaption' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['figure'] = [
    'title' => $this
      ->t('Figure'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <figure>{{ figure }}</figure> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'figure' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['hr'] = [
    'title' => $this
      ->t('Horizontal rule'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <hr>{{ hr }}</hr> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'hr' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['i'] = [
    'title' => $this
      ->t('Italic'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <i>{{ i }}</i> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'i' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['q'] = [
    'title' => $this
      ->t('Quote'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <q>{{ q }}</q> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'q' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['s'] = [
    'title' => $this
      ->t('Strikethrough'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <s>{{ s }}</s> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        's' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['small'] = [
    'title' => $this
      ->t('Small'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <small>{{ small }}</small> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'small' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['strong'] = [
    'title' => $this
      ->t('Strong'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <strong>{{ strong }}</strong> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'strong' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['sub'] = [
    'title' => $this
      ->t('Subscript'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <sub>{{ sub }}</sub> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'sub' => $this->generator
          ->words(1),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['sup'] = [
    'title' => $this
      ->t('Superscript'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <sup>{{ sup }}</sup> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'sup' => $this->generator
          ->words(1),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['u'] = [
    'title' => $this
      ->t('Underline'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }} <u>{{ u }}</u> {{ post }}.',
      '#context' => [
        'pre' => $this->generator
          ->words(3, 'ucfirst'),
        'u' => $this->generator
          ->words(3),
        'post' => $this->generator
          ->words(4),
      ],
    ],
  ];
  $items['ul'] = [
    'title' => $this
      ->t('Unordered list'),
    'content' => [
      '#theme' => 'item_list',
      '#items' => $this->generator
        ->wordList(),
      '#list_type' => 'ul',
    ],
    'group' => $this
      ->t('Lists'),
  ];
  $items['ol'] = [
    'title' => $this
      ->t('Ordered list'),
    'content' => [
      '#theme' => 'item_list',
      '#items' => $this->generator
        ->wordList(),
      '#list_type' => 'ol',
    ],
    'group' => $this
      ->t('Lists'),
  ];
  $items['ul_title'] = [
    'title' => $this
      ->t('Unordered list, with title'),
    'content' => [
      '#theme' => 'item_list',
      '#items' => $this->generator
        ->wordList(),
      '#list_type' => 'ul',
      '#title' => $this->generator
        ->words(3, 'ucfirst'),
    ],
    'group' => $this
      ->t('Lists'),
  ];
  $items['ol_title'] = [
    'title' => $this
      ->t('Ordered list, with title'),
    'content' => [
      '#theme' => 'item_list',
      '#items' => $this->generator
        ->wordList(),
      '#list_type' => 'ol',
      '#title' => $this->generator
        ->words(3, 'ucfirst'),
    ],
    'group' => $this
      ->t('Lists'),
  ];
  $items['ul_long'] = [
    'title' => $this
      ->t('Unordered list with wrapped list items'),
    'content' => [
      '#theme' => 'item_list',
      '#items' => $this->generator
        ->wordList(3, 120),
      '#list_type' => 'ul',
    ],
    'group' => $this
      ->t('Lists'),
  ];
  $items['ol_long'] = [
    'title' => $this
      ->t('Ordered list with wrapped list items'),
    'content' => [
      '#theme' => 'item_list',
      '#items' => $this->generator
        ->wordList(3, 120),
      '#list_type' => 'ol',
    ],
    'group' => $this
      ->t('Lists'),
  ];
  $items['ul_links'] = [
    'title' => $this
      ->t('Unordered list with links'),
    'content' => [
      '#theme' => 'links',
      '#links' => $this->generator
        ->ulLinks(),
    ],
    'group' => $this
      ->t('Lists'),
  ];
  $items['ul_links_inline'] = [
    'title' => $this
      ->t('Unordered inline list with links'),
    'content' => [
      '#theme' => 'links',
      '#links' => $this->generator
        ->ulLinks(),
      '#attributes' => [
        'class' => [
          'inline',
        ],
      ],
    ],
    'group' => $this
      ->t('Lists'),
  ];
  $menu = $this->linkTree
    ->load('admin', new MenuTreeParameters());
  $items['menu_tree'] = [
    'title' => $this
      ->t('Menu tree'),
    'content' => $this->linkTree
      ->build($menu),
    'group' => $this
      ->t('Menus'),
  ];
  $items['menu_link'] = [
    'title' => $this
      ->t('Menu link'),
    'content' => $this->generator
      ->menuItem($current_url),
    'group' => $this
      ->t('Menus'),
  ];
  $items['table'] = [
    'title' => $this
      ->t('Table'),
    'content' => [
      '#theme' => 'table',
      '#caption' => $this->generator
        ->words(3),
      '#header' => $this->generator
        ->tableHeader(),
      '#rows' => $this->generator
        ->tableRows(),
    ],
    'group' => $this
      ->t('Tables'),
  ];
  $items['text'] = [
    'title' => $this
      ->t('Text block'),
    'content' => $this->generator
      ->paragraphs(3),
    'group' => $this
      ->t('Text'),
  ];
  $items['blockquote'] = [
    'title' => $this
      ->t('Blockquote'),
    'content' => [
      '#type' => 'inline_template',
      '#template' => '{{ pre }}<blockquote>{{ blockquote }}</blockquote>{{ post }}',
      '#context' => [
        'pre' => $this->generator
          ->paragraphs(1),
        'blockquote' => $this->generator
          ->paragraphs(1),
        'post' => $this->generator
          ->paragraphs(1),
      ],
    ],
    'group' => $this
      ->t('Text'),
  ];
  $items['image-horizontal'] = [
    'title' => $this
      ->t('Image, horizontal'),
    'content' => [
      '#theme' => 'image',
      '#uri' => $this->generator
        ->image('horizontal'),
      '#alt' => $this
        ->t('My image'),
      '#title' => $this
        ->t('My image'),
    ],
    'group' => $this
      ->t('Media'),
  ];
  $items['image-vertical'] = [
    'title' => $this
      ->t('Image, vertical'),
    'content' => [
      '#theme' => 'image',
      '#uri' => $this->generator
        ->image('vertical'),
      '#alt' => $this
        ->t('My image'),
      '#title' => $this
        ->t('My image'),
    ],
    'group' => $this
      ->t('Media'),
  ];
  $items['image-inset-horizontal'] = [
    'title' => $this
      ->t('Image, horizontal, within text'),
    'content' => [
      [
        $this->generator
          ->paragraphs(1),
      ],
      [
        '#theme' => 'image',
        '#uri' => $this->generator
          ->image('horizontal'),
        '#alt' => $this
          ->t('My image'),
        '#title' => $this
          ->t('My image'),
      ],
      [
        $this->generator
          ->paragraphs(2),
      ],
    ],
    'group' => $this
      ->t('Media'),
  ];
  $items['image-inset-vertical'] = [
    'title' => $this
      ->t('Image, vertical, within text'),
    'content' => [
      [
        $this->generator
          ->paragraphs(1),
      ],
      [
        '#theme' => 'image',
        '#uri' => $this->generator
          ->image('vertical'),
        '#alt' => $this
          ->t('My image'),
        '#title' => $this
          ->t('My image'),
      ],
      [
        $this->generator
          ->paragraphs(2),
      ],
    ],
    'group' => $this
      ->t('Media'),
  ];
  $content = [];
  for ($i = 1; $i <= 6; $i++) {
    $content[] = [
      '#type' => 'inline_template',
      '#template' => '<h{{ i }}>h{{ i }}: {{ wordList }}</h{{ i }}>',
      '#context' => [
        'i' => $i,
        'wordList' => implode(' ', $this->generator
          ->wordList()),
      ],
    ];
  }
  $items['headings'] = [
    'title' => "Headings",
    'content' => $content,
    'group' => $this
      ->t('Text'),
  ];
  $content = [];
  for ($i = 1; $i <= 6; $i++) {
    $content[] = [
      '#type' => 'inline_template',
      '#template' => '<h{{ i }}>h{{ i }}: {{ wordList }}</h{{ i }}>{{ paragraph }}',
      '#context' => [
        'i' => $i,
        'wordList' => implode(' ', $this->generator
          ->wordList()),
        'paragraph' => $this->generator
          ->paragraphs(1),
      ],
    ];
  }
  $items['headings_text'] = [
    'title' => "Headings with text",
    'content' => $content,
    'group' => $this
      ->t('Text'),
  ];

  // Store all of the current messages, do not display them here.
  $message_queue = $this
    ->messenger()
    ->all();
  $messages = [
    'status',
    'warning',
    'error',
  ];
  foreach ($messages as $message) {

    // Set a new message with a link.
    $this
      ->messenger()
      ->addMessage($this->generator
      ->sentence(Url::fromUri('http://www.example.com')), $message);
    $items[$message . '-message'] = [
      'title' => ucwords($message) . ' message',
      'content' => [
        '#theme' => 'status_messages',
        '#message_list' => [
          $message => $this->messenger
            ->deleteByType($message),
        ],
      ],
    ];
  }

  // Loop through the original messages, resetting them.
  foreach ($message_queue as $message_type => $messages) {
    foreach ($messages as $message) {
      $this
        ->messenger()
        ->addMessage($message, $message_type);
    }
  }

  // Form elements.
  $form_state = new FormState();
  $elements = $this->formBuilder
    ->buildForm('Drupal\\styleguide\\Form\\StyleguideForm', $form_state);
  $basic = [];
  $details = [];
  $tabs = [];
  $markup = [];
  foreach (Element::children($elements) as $key) {
    if ($key == 'vertical_tabs' && !in_array($key, $tabs)) {
      $tabs[] = $key;
    }
    elseif (!isset($elements[$key]['#type']) || $elements[$key]['#type'] == 'item') {
      $markup[] = $key;
    }
    elseif ($elements[$key]['#type'] == 'details') {
      $details[] = $key;
    }
    elseif (in_array($elements[$key]['#type'], [
      'button',
      'submit',
      'image_button',
    ])) {
    }
    else {
      $basic[] = $key;
    }
  }
  $items['form'] = [
    'title' => $this
      ->t('Forms, basic'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', $basic),
    'group' => $this
      ->t('Forms'),
  ];
  $items['form-submit'] = [
    'title' => $this
      ->t('Forms, submit'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', [
      'submit',
    ]),
    'group' => $this
      ->t('Forms'),
  ];
  $items['form-button'] = [
    'title' => $this
      ->t('Forms, button'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', [
      'button',
    ]),
    'group' => $this
      ->t('Forms'),
  ];
  $items['form-button-disabled'] = [
    'title' => $this
      ->t('Forms, button - disabled'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', [
      'button_disabled',
    ]),
    'group' => $this
      ->t('Forms'),
  ];
  $items['form-image-button'] = [
    'title' => $this
      ->t('Forms, image button'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', [
      'image_button',
    ]),
    'group' => $this
      ->t('Forms'),
  ];
  $items['form-markup'] = [
    'title' => $this
      ->t('Forms, markup'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', $markup),
    'group' => $this
      ->t('Forms'),
  ];
  $items['form-details'] = [
    'title' => $this
      ->t('Forms, details'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', $details),
    'group' => $this
      ->t('Forms'),
  ];
  $items['form-fieldset'] = [
    'title' => $this
      ->t('Forms, fieldset'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', [
      'fieldset',
    ]),
    'group' => $this
      ->t('Forms'),
  ];
  $items['form-vertical-tabs'] = [
    'title' => $this
      ->t('Forms, vertical tabs'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', $tabs),
    'group' => $this
      ->t('Forms'),
  ];
  $items['feed_icon'] = [
    'title' => $this
      ->t('Feed icon'),
    'content' => [
      '#theme' => 'feed_icon',
      '#url' => 'rss.xml',
      '#title' => $this
        ->t('Syndicate'),
    ],
    'group' => $this
      ->t('System'),
  ];

  // Builds a link to the Styleguide maintenance page.
  $route_name = 'styleguide.maintenance_page.' . $this->themeManager
    ->getActiveTheme()
    ->getName();
  $items['maintenance_page'] = [
    'title' => $this
      ->t('Maintenance page'),
    'content' => $this
      ->buildLinkFromRoute($this
      ->t('Open the maintenance page'), $route_name, [], [
      'attributes' => [
        'target' => [
          '_blank',
        ],
      ],
    ]),
    'group' => $this
      ->t('System'),
  ];
  $plugin = $this->blockManager
    ->createInstance('system_powered_by_block');
  $items['system_powered_by'] = [
    'title' => $this
      ->t('System powered by'),
    'content' => $plugin
      ->build(),
    'group' => $this
      ->t('System'),
  ];
  $items['confirm_form'] = [
    'title' => $this
      ->t('Confirm form'),
    'content' => $this->formBuilder
      ->getForm('Drupal\\styleguide\\Form\\StyleguideConfirmForm'),
    'group' => $this
      ->t('System'),
  ];
  if ($this->moduleHandler
    ->moduleExists('filter')) {
    $items['text_format'] = [
      'title' => t('Text format'),
      'content' => $this->formBuilder
        ->getForm('Drupal\\styleguide\\Form\\StyleguideForm', [
        'text_format',
      ]),
      'group' => t('System'),
    ];
    $items['filter_tips'] = [
      'title' => t('Filter tips, short'),
      'content' => [
        '#theme' => 'filter_tips',
        '#tips' => _filter_tips(-1, FALSE),
        '#long' => FALSE,
      ],
      'group' => t('System'),
    ];
    $items['filter_tips_long'] = [
      'title' => t('Filter tips, long'),
      'content' => [
        '#theme' => 'filter_tips',
        '#tips' => _filter_tips(-1, TRUE),
        '#long' => TRUE,
      ],
      'group' => t('System'),
    ];
  }
  $items['pager'] = [
    'title' => $this
      ->t('Pager'),
    'content' => $this->generator
      ->pager(),
    'group' => $this
      ->t('User interface'),
  ];
  $items['progress_bar'] = [
    'title' => $this
      ->t('Progress bar'),
    'content' => [
      '#theme' => 'progress_bar',
      '#percent' => 57,
      '#message' => $this->generator
        ->sentence(2),
    ],
    'group' => $this
      ->t('User interface'),
  ];

  // Use alternative item name to avoid conflict with main breadcrumb.
  $breadcrumb = $this->breadcrumbManager
    ->build($this->currentRouteMatch);
  $items['styleguide_breadcrumb'] = [
    'title' => $this
      ->t('Breadcrumb'),
    'content' => $breadcrumb
      ->toRenderable(),
    'group' => $this
      ->t('User interface'),
  ];
  $items['link'] = [
    'title' => $this
      ->t('Link'),
    'content' => $this
      ->buildLink($this->generator
      ->words(2), $current_url),
    'group' => $this
      ->t('Link'),
  ];
  $items['links'] = [
    'title' => $this
      ->t('Links'),
    'content' => [
      '#theme' => 'links',
      '#links' => $this->generator
        ->links($current_url),
    ],
    'group' => $this
      ->t('Link'),
  ];
  $items['mark_new'] = [
    'title' => $this
      ->t('Mark, new'),
    'content' => [
      [
        $this
          ->buildLink($this->generator
          ->sentence(), $current_url),
      ],
      [
        '#theme' => 'mark',
        '#type' => MARK_NEW,
      ],
    ],
    'group' => $this
      ->t('Link'),
  ];
  $items['mark_updated'] = [
    'title' => $this
      ->t('Mark, updated'),
    'content' => [
      [
        $this
          ->buildLink($this->generator
          ->sentence(), $current_url),
      ],
      [
        '#theme' => 'mark',
        '#type' => MARK_UPDATED,
      ],
    ],
    'group' => $this
      ->t('Link'),
  ];
  $items['more_help_link'] = [
    'title' => $this
      ->t('More help link'),
    'content' => [
      [
        $this->generator
          ->paragraphs(1),
      ],
      [
        '#type' => 'link',
        '#url' => Url::fromUserInput($current_url),
        '#title' => t('More help'),
        '#attributes' => [
          'class' => [
            'icon-help',
          ],
        ],
      ],
    ],
    'group' => $this
      ->t('Link'),
  ];
  $items['more_link'] = [
    'title' => $this
      ->t('More link'),
    'content' => [
      [
        $this->generator
          ->paragraphs(1),
      ],
      [
        '#type' => 'more_link',
        '#url' => Url::fromUserInput($current_url),
      ],
    ],
    'group' => $this
      ->t('Link'),
  ];
  $items['monospace'] = [
    'title' => $this
      ->t('Monospace'),
    'content' => $this->generator
      ->lorem(1, 0, 'mixed', FALSE),
    'group' => $this
      ->t('Text'),
    'tag' => 'code',
  ];
  return $items;
}