Liquid

LiquidJS: A simple, expressive and safe template engine.

Usage

There are 2 modes for rendering:

Pre-rendered (Default)

The values of the expressions are evaluated and added to the template during compilation of the result page.

The values of all expressions should be supplied in advance using custom settings to the property template.data which accepts an object of key-value pairs.

Example: This provides the value of the expression name

Custom Settings

{
  "template": {
    "data": {
      "name": "LiveCodes"
    }
  }
}

Full example below

Dynamic

To use this mode, the property template.prerender in custom settings should be set to false.

Example:

Custom Settings

{
  "template": {
    "prerender": false
  }
}

In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the result page runtime.

This can be achieved in JavaScript (or any language that compiles to it) by assigning window.livecodes.templateData to an object with the data.

Please note that template rendering occurs on page load, so the assignment must occur before that.

Example:

Script Editor (JS)

window.livecodes.templateData = { name: 'LiveCodes' };

Full example below

Language Info

Name

liquid

Extensions

.liquid, .liquidjs

Editor

markup

Compiler

The official LiquidJS compiler.

Version

liquidjs: v10.14.0

Code Formatting

Using Prettier.

Custom Settings

Custom settings added to the property liquid are passed as a JSON object to the Liquid constructor. Please check the documentation for full reference.

Please note that custom settings should be valid JSON (i.e. functions are not allowed).

Example:

Custom Settings

{
  "liquid": {
    "outputDelimiterLeft": "<%=",
    "outputDelimiterRight": "%>"
  }
}

Example Usage

Pre-rendered

show code

JS

import { createPlayground } from 'livecodes';

const options = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "customSettings": {
      "template": {
        "data": {
          "name": "livecodes"
        }
      }
    }
  },
  "params": {
    "compiled": "open"
  }
};
createPlayground('#container', options);

TS

import { createPlayground, type EmbedOptions } from 'livecodes';

const options: EmbedOptions = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "customSettings": {
      "template": {
        "data": {
          "name": "livecodes"
        }
      }
    }
  },
  "params": {
    "compiled": "open"
  }
};
createPlayground('#container', options);

React

import LiveCodes from 'livecodes/react';

export default function App() {
  const options = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "customSettings": {
      "template": {
        "data": {
          "name": "livecodes"
        }
      }
    }
  },
  "params": {
    "compiled": "open"
  }
};
  return (<LiveCodes {...options}></LiveCodes>);
}

Vue

<script setup>
import LiveCodes from "livecodes/vue";

const options = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "customSettings": {
      "template": {
        "data": {
          "name": "livecodes"
        }
      }
    }
  },
  "params": {
    "compiled": "open"
  }
};
</script>
<template>
  <LiveCodes v-bind="options" />
</template>

Svelte

<script>
import { onMount } from 'svelte';
import { createPlayground } from 'livecodes';

const options = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "customSettings": {
      "template": {
        "data": {
          "name": "livecodes"
        }
      }
    }
  },
  "params": {
    "compiled": "open"
  }
};
let container;
onMount(() => {
  createPlayground(container, options);
});
</script>

<div bind:this="{container}"></div>

Dynamic

show code

JS

import { createPlayground } from 'livecodes';

const options = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "script": {
      "language": "javascript",
      "content": "window.livecodes.templateData = { name: \"livecodes\" };"
    },
    "customSettings": {
      "template": {
        "prerender": false
      }
    },
    "activeEditor": "script"
  }
};
createPlayground('#container', options);

TS

import { createPlayground, type EmbedOptions } from 'livecodes';

const options: EmbedOptions = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "script": {
      "language": "javascript",
      "content": "window.livecodes.templateData = { name: \"livecodes\" };"
    },
    "customSettings": {
      "template": {
        "prerender": false
      }
    },
    "activeEditor": "script"
  }
};
createPlayground('#container', options);

React

import LiveCodes from 'livecodes/react';

export default function App() {
  const options = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "script": {
      "language": "javascript",
      "content": "window.livecodes.templateData = { name: \"livecodes\" };"
    },
    "customSettings": {
      "template": {
        "prerender": false
      }
    },
    "activeEditor": "script"
  }
};
  return (<LiveCodes {...options}></LiveCodes>);
}

Vue

<script setup>
import LiveCodes from "livecodes/vue";

const options = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "script": {
      "language": "javascript",
      "content": "window.livecodes.templateData = { name: \"livecodes\" };"
    },
    "customSettings": {
      "template": {
        "prerender": false
      }
    },
    "activeEditor": "script"
  }
};
</script>
<template>
  <LiveCodes v-bind="options" />
</template>

Svelte

<script>
import { onMount } from 'svelte';
import { createPlayground } from 'livecodes';

const options = {
  "config": {
    "markup": {
      "language": "liquid",
      "content": "Hello, {{ name | capitalize }}!"
    },
    "script": {
      "language": "javascript",
      "content": "window.livecodes.templateData = { name: \"livecodes\" };"
    },
    "customSettings": {
      "template": {
        "prerender": false
      }
    },
    "activeEditor": "script"
  }
};
let container;
onMount(() => {
  createPlayground(container, options);
});
</script>

<div bind:this="{container}"></div>

Links

• Official website
• Liquidjs tutorials