User Guide 1.1

Error Handling

Error handling uses Liquid’s error modes to determine how to handle errors. Please see Liquid - Error Modes for more information.

Usage

There are several tags that will modify arrays and hashes in various ways. Each tag has various attributes that specify information about the operation. The syntax for the tags and attributes is as follows:

{% tag_name attribute:value attribute:value %}

Some tags will have a default attribute which can be used if only one attribute needs specified, like so:

{% tag_name value %}

Types

Aside from the standard Liquid types, inline arrays and hashes may also be defined and used for appropriate attributes. The syntax for each is as follows:

{% tag_name array:value1,value2,value3 %}
{% tag_name hash:key1>value1,key2>value2 %}

Note: If an array is defined with a single variable and that variable contains an array, that array will be used instead of being the first element.

array_create tag

Creates an array with opinional initial items. If the variable is already defined it will reassign it.

Example

{% array_create values1 %}
{% array_create array:values2 items:"value1",2 %}

values1 => []
values2 => ["value1", 2]

array_add tag

Adds a value to the end of an array. If the array doesn’t exist, it will create it first.

Example

{% assign var = "a" %}
{% array_add array:values value:var %}
{% array_add array:values value:1 %}
{% array_add array:values value:true %}

values => ["a", 1, true]

array_delete tag

Deletes an index or all occurrences of a value from an array. If an index is used, it must be within the interval [0, length).

Example

values => ["a", "b", "c", "a"]

{% array_delete array:values index:1 %}
{% array_delete array:values value:"a" %}

values => ["c"]

array_insert tag

Inserts a value into an array at an index. The index must be within the interval [0, length]. The array must already exist and will not be created if it does not.

Example

values => ["a", "b", "c"]

{% array_insert array:values index:0 value:"z" %}
{% array_insert array:values index:2 value:"y" %}

values => ["z", "a", "y", "b", "c"]

array_replace tag

Replaces the value at an index in an array. The index must be within the interval [0, length).

Example

values => ["a", "b", "c"]

{% array_replace array:values index:0 value:"z" %}
{% array_replace array:values index:2 value:"y" %}

values => ["z", "b", "y"]

array block tag

Allows for the modification of an array without having to specify the array for every operation. If the array doesn’t exist, it will create an empty array.

Example

{% array values %}
  {% array_add "a" %}
  {% array_add "b" %}
  {% array_insert index:1 value:"z" %}
{% endarray %}

values => ["a", "z", "b"]

hash_create tag

Creates a hash with opinional initial entries. If the variable is already defined it will reassign it.

Example

{% hash_create values1 %}
{% hash_create hash:values2 entries:"key1">"a","key2",3 %}

values1 => {}
values2 => {"key1" => "a", "key2" => 3}

hash_set tag

Sets a key-value mapping in a hash, either adding it if it doesn’t already exist or replacing the existing mapping for the key. If the hash doesn’t exist, it will create it first.

Example

{% hash_set hash:values key:"key1" value:"a" %}
{% hash_set hash:values key:"key2" value:3 %}
{% hash_set hash:values key:"key3" value:false %}

values => {"key1" => "a", "key2" => 3, "key3" => false}

hash_delete tag

Deletes a key-value mapping from a hash for a key.

Example

values => {"key1" => "a", "key2" => 3, "key3" => false}

{% hash_delete hash:values key:"key1" %}
{% hash_delete hash:values key:"key2" %}

values => {"key3" => false}

hash block tag

Allows for the modification of a hash without having to specify the hash for
every operation. If the hash doesn’t exist, it will create an empty hash.

Example

{% hash values %}
  {% hash_set key:"key1" value:"a" %}
  {% hash_set key:"key2" value:"b" %}
  {% hash_set key:"key3" value:"c" %}
  {% hash_delete "key2" %}
{% endhash %}

values => {"key1" => "a", "key3" => "c"}

License

Liquid Arrays is licensed under Apache License 2.0. You may also refer to the included LICENSE.txt file.