library mannequin-drupal {🖫 1,633, ⚐ 32, ★ 0}

lastcall/mannequin-drupal

Drupal extension for the Mannequin template viewer

Monday, May 28, 2018
by rbayliss
Repository
1 Watchers
0 Stars
1,633 Installations

PHP
1 Dependents
0 Suggesters
0 Forks
0 Open issues
32 Versions
23 % Grown

The README.md

Mannequin Drupal is brought to you by your friends at Last Call Media, it is a command line application that you can use to visualize and work on your Drupal Twig Templates in the browser. For example, you might use it to work on the templates inside of an existing custom theme., _(*1)

Quick Start

Using Composer, install Mannequin Drupal from your project root. From the command line:, _(*2)

$ composer require lastcall/mannequin-drupal

Next, create a new .mannequin.php file in your project root. This file is where you will configure Mannequin. Inside of that file:, _(*3)

<?php
// .mannequin.php
use LastCall\Mannequin\Core\MannequinConfig;
use LastCall\Mannequin\Drupal\DrupalExtension;
use Symfony\Component\Finder\Finder;

// Describe where to find Drupal templates.
// See https://symfony.com/doc/current/components/finder.html
$drupalFinder = Finder::create()
    // Templates can live in your normal templates directory.
    ->in(__DIR__.'/themes/mytheme/templates')
    ->files()
    ->name('*.twig');

$drupalExtension = new DrupalExtension([
    'finder' => $drupalFinder,
    'drupal_root' => __DIR__,
]);

return MannequinConfig::create()
  ->addExtension($drupalExtension)
  ->setGlobalJs([
    // themes/mytheme/js/theme.js  
  ])
  ->setGlobalCss([
    // themes/mytheme/css/theme.css
  ]);

See all of the configuration options, or view an example project, _(*4)

Setting up Components

While the .mannequin.php file tells Mannequin where to find your components, you still need to describe them to Mannequin. To do that, we use a special YAML formatted comment block at the top of your twig files. For example, to describe a "Card" component living inside of card.html.twig, you would add the following at the top of the file:, _(*5)

{# @Component
name: Card
group: Molecule
samples:
    Small:
        title: I am a small card
        body: Lorem ipsum...
        classes: ['small']
#}
<div class="{{ classes|join(' ') }}">
  ... 
</div>

See the full YAML reference here, _(*6)

Workflow

When you're ready to begin work on your templates, you can use the following worklow:, _(*7)

Fire up a live development server so you can see your component. From the command line: bash $ vendor/bin/mannequin start
This will output a URL for the Mannequin UI. Visit it in your browser.
In the UI, find the component you want to work on.
Open the file, and make your changes.
Reload the UI to see how your changes look.

The Versions

28/05 2018

dev-master

9999999-dev

Drupal extension for the Mannequin template viewer

library mannequin-drupal

Drupal extension for the Mannequin template viewer

lastcall/mannequin-drupal

The README.md

Quick Start

Setting up Components

Workflow

The Versions

dev-master

The Requires

The Development Requires

by Rob Bayliss

1.0.7

The Requires

The Development Requires

by Rob Bayliss

1.0.6

The Requires

The Development Requires

by Rob Bayliss

1.0.5

The Requires

The Development Requires

by Rob Bayliss

1.0.4

The Requires

The Development Requires

by Rob Bayliss

1.0.3

The Requires

The Development Requires

by Rob Bayliss

1.0.2

The Requires

The Development Requires

by Rob Bayliss

1.0.1

The Requires

The Development Requires

by Rob Bayliss

1.0.0

The Requires

The Development Requires

by Rob Bayliss

1.0.0-rc3

The Requires

The Development Requires

by Rob Bayliss

1.0.0-rc4

The Requires

The Development Requires

by Rob Bayliss

1.0.0-rc5

The Requires

The Development Requires

by Rob Bayliss

1.0.0-rc6

The Requires

The Development Requires

by Rob Bayliss

1.0.0-rc2

The Requires

The Development Requires

by Rob Bayliss

0.3.0

The Requires

The Development Requires

by Rob Bayliss

0.3.1

The Requires

The Development Requires

by Rob Bayliss

1.0.0-beta1

The Requires

The Development Requires

by Rob Bayliss

1.0.0-rc1

The Requires

The Development Requires

by Rob Bayliss