Code Fieldtype

Overview#

If your content involves code snippets, this is the fieldtype for you. It's a CodeMirror field with 25 of the most common languages ready for highlighting, handles tabs and spaces, has a dark mode, and best of all — for you super nerds out there — a vim key binding.

Data Structure#

The code fieldtype stores a string. Do whatever you'd like with it.

code_snippet: |
  <?php

  public function engage()
  {
    return "Make it so.";
  }

If you've enabled the mode_selectable option, an array will be saved with code and mode in it.

code_snippet:
  mode: php
  code: |
    <?php

    public function engage()
    {
        return "Make it so.";
    }

Templating#

You can output that string just as it is. If it is indeed code (and why wouldn't it be?), you'll probably want to to wrap it in pre and code tags to display it prettier. If you want code highlighting on your front-end, we recommend hooking up prism.js.

<pre><code>{{ code_snippet }}</code></pre>

<pre><code>{!! $code_snippet !!}</code></pre>

You're also able to use it as an array if you want to output the mode.

{{ code_snippet }}
<pre class="language-{{ mode }}"><code>{{ code }}</code></pre>
{{ /code_snippet }}

<pre class="language-{{ $code_snippet['mode'] }}"><code>{!! $code_snippet['code'] !!}</code></pre>

Variables#

Inside an code fieldtype's tag pair you'll have access to the following variables.

Options