https://github.com/tsega/drupal-8-twig-snippets-vs-code
A handful of twig functions to use with Drupal 8 in Visual Studio Code.
https://github.com/tsega/drupal-8-twig-snippets-vs-code
drupal-8 snippets twig visual-studio-code
Last synced: about 1 month ago
JSON representation
A handful of twig functions to use with Drupal 8 in Visual Studio Code.
- Host: GitHub
- URL: https://github.com/tsega/drupal-8-twig-snippets-vs-code
- Owner: tsega
- Created: 2018-05-01T19:44:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-27T15:29:18.000Z (almost 5 years ago)
- Last Synced: 2025-01-22T05:20:06.751Z (3 months ago)
- Topics: drupal-8, snippets, twig, visual-studio-code
- Size: 1.45 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Drupal 8 Twig snippets for Visual Studio Code
This extension adds 8 useful twig snippets that can be used with Drupal 8. These snippets were extracted from the [Functions - in Twig Templates](https://www.drupal.org/docs/8/theming/twig/functions-in-twig-templates) documentation.
## Installation
To install this extension use the following steps:
1. In VS Code, open the **Command Palette** using the shortcut key combination `ctrl-shift-p` (Windows, Linux) or `cmd-shift-p` (OSX)
1. Then in the Command Palette box, type in `Install Extensions` and select that form the list.
1. This will open up the **Extension Manager**. In the search box type in `Drupal 8 Twig Snippets`.
1. Click the **Install** button, after that finishes make sure to reload VS Code as well.
## Usage
Once installed, to use these snippets you can use the following two methods, the first Method is geared towards people who are new to the snippets available while the second method is suitable for people who know the available snippets and are looking to increase their speed.
### Method 1
1. Open the **Command Palette**, `ctrl-shift-p` (Windows, Linux) or `cmd-shift-p` (OSX)
1. In the command box type in `Insert Snippet`; this will list all the available snippets.
1. Select the snippet you want to use from the provided list.
### Method 2
1. In the code editor window, type in the **Prefix** of the snippet you want to insert. This will show an intellisense window as you type.
1. Insert the snippet you want by simply pressing the `tab` key.
## Features
Here you will find all the code snippets that are available in this extension. Please note that each title starts with the **Prefix** of the code snippet to insert; useful to memorize them if you plan to use [Method 2](#Method-2) above.
### lib - attach_library($library)
Attaches an asset library to the template.
Example:
```twig
{{ attach_library('classy/node') }}
```
### attr - create_attribute($attributes)
Creates an attribute on a DOM element.
Example:
```twig
{{ content }}
```
### furl - `file_url($uri)`
This helper function accepts a **relative path** from the root and creates a relative URI path to the file.
Example:
```twig
{{ file_url(node.field_example_image.entity.uri.value) }}
```
### lnk - `link($text, $url, $attributes)`
This helper function accepts as first parameter the **text**, as second parameter the **url** and as third paramter any **attributes** for the link.
Example:
```twig
{{ link(item.title, item.url, { 'class':['foo', 'bar', 'baz']} ) }}
```
### path - `path($name, $parameters, $options)`
Generates a **relative** URL path given a route name and parameters.
Example:
```twig
{# Link to user entity/profile page. #}
{{ 'View user profile'|t }}
```
### urlh - `url($name, $parameters, $options)`
Generate an absolute URL given a route name and parameters.
Example:
```twig
{{ 'View all content'|t }}
```
### urlc - `url('')`
Generate an absolute URL to the current url.
Example:
```twig
{{ 'View all content'|t }}
```
### urlf - `url('')`
Generate an absolute URL to the front page.
Example:
```twig
{{ 'View all content'|t }}
```
### Requirements
These snippets are only made available in files with a `.twig` extension. To get proper support for Twig files in Visual Studio Code, you can install the [Twig Language 2](https://marketplace.visualstudio.com/items?itemName=mblode.twig-language-2) extension by *mblode*.
## Release Notes
### 1.0.2
Fix typos in README
### 1.0.1
Added the Drupal 8 logo
### 0.0.1
Initial release