You are here

public function UIkitViewGrid::buildOptionsForm in UIkit Components 8

Same name and namespace in other branches
  1. 8.3 uikit_views/src/Plugin/views/style/UIkitViewGrid.php \Drupal\uikit_views\Plugin\views\style\UIkitViewGrid::buildOptionsForm()
  2. 8.2 uikit_views/src/Plugin/views/style/UIkitViewGrid.php \Drupal\uikit_views\Plugin\views\style\UIkitViewGrid::buildOptionsForm()

Provide a form to edit options for this plugin.

Overrides StylePluginBase::buildOptionsForm

File

uikit_views/src/Plugin/views/style/UIkitViewGrid.php, line 57

Class

UIkitViewGrid
Style plugin to render each item in a UIkit Grid component.

Namespace

Drupal\uikit_views\Plugin\views\style

Code

public function buildOptionsForm(&$form, FormStateInterface $form_state) {
  parent::buildOptionsForm($form, $form_state);
  $args = [
    '@href' => 'https://getuikit.com/v2/docs/grid.html#even-grid-columns',
    '@title' => 'Grid component - UIkit documentation',
  ];
  $breakpoints = [
    'small' => $this
      ->t('Affects device widths of 480px and higher.'),
    'medium' => $this
      ->t('Affects device widths of 768px and higher.'),
    'large' => $this
      ->t('Affects device widths of 960px and higher.'),
    'xlarge' => $this
      ->t('Affects device widths of 1220px and higher.'),
  ];
  $form['column_widths'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Grid columns'),
    '#description' => $this
      ->t("To create a grid whose child elements' widths are evenly split, we apply one class to the grid for each breakpoint. Each item in the grid is then automatically applied a width based on the number of columns selected for each breakpoint. See <a href='@href' target='_blank' title='@title'>Grid component</a> for more details.", $args),
    '#open' => TRUE,
  ];
  foreach ([
    'small',
    'medium',
    'large',
    'xlarge',
  ] as $size) {
    $form["width_{$size}"] = [
      '#type' => 'select',
      '#title' => $this
        ->t("uk-grid-width-{$size}-*"),
      '#required' => TRUE,
      '#default_value' => $this->options["width_{$size}"],
      '#options' => [
        "uk-grid-width-{$size}-1-1" => 1,
        "uk-grid-width-{$size}-1-2" => 2,
        "uk-grid-width-{$size}-1-3" => 3,
        "uk-grid-width-{$size}-1-4" => 4,
        "uk-grid-width-{$size}-1-5" => 5,
        "uk-grid-width-{$size}-1-6" => 6,
        "uk-grid-width-{$size}-1-10" => 10,
      ],
      '#description' => $breakpoints[$size],
    ];
  }
  $form['grid_divider'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Grid divider'),
    '#default_value' => $this->options['grid_divider'],
    '#description' => $this
      ->t('Apply a horizontal border to each row in the grid, except the first row.'),
  ];
  $form['grid_gutter'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Grid gutter'),
    '#required' => TRUE,
    '#default_value' => $this->options['grid_gutter'],
    '#options' => [
      'default' => $this
        ->t('Default gutter'),
      'uk-grid-small' => $this
        ->t('Small gutter'),
      'uk-grid-medium' => $this
        ->t('Medium gutter'),
      'uk-grid-large' => $this
        ->t('Large gutter'),
      'uk-grid-collapse' => $this
        ->t('Collapse gutter'),
    ],
    '#description' => $this
      ->t('Grids automatically create a horizontal gutter between columns and a vertical one between two succeeding grids. By default, the grid gutter is wider on large screens.<br /><strong>Note</strong>: <em class="placeholder">Grid collapse</em> removes the grid gutter.'),
  ];
}