Javascript

Javascript

{{ javascript }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published javascript
guid String The unique identifier for this javascript
value String Contains the same value as guid
name text The name of the javascript which, when combined together with the path, uniquely identifies the javscript on this site
path String The path, exluding filename, of this javascript used for organizational and reference purposes
script code The source code for the script
url String The full public URL for this javascript in the CDN
parse_liquid Boolean When true, indicates that this javascript should be parsed and rendered using liquid markup before being stored in the CDN for future reference
pre_includes javascripts Additional javascript objects to bundle together and output before the current script
post_includes javascripts Additional javascript objects to bundle together and output after the current script
minify Boolean When true, specifies that the current script should automatically be minified before being output
script_compiled String The final result of bundling, compiling, and minifying this javascript object
field_id String The identifier for this field
label String The label for this field
output String Adds the javascript to the document head, similar to calling {% add_javascript %} with it

{{ javascripts }}

Contains multiple scripts.

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this contains at least one published javascript
output String The default output that the javascripts will produce when it is output directly to the template - using the "output_in_list" property of each javascript in the items list
prepended list List containing any prepended javascripts.
fetched list List containing all of the javascripts that were fetched from the database (as opposed to prepended or appended).
appended list List containing any appended javascripts.
appended_unique list List containing any appended javascripts excluding any javascripts that are in either the list of prepended or fetched javascripts.
items list List containing all of the combined javascripts from the prepended, fetched, and appended lists. If unique is true, this list will not contain any duplicates. If max_size is set, this list will not contain more than the number of javascripts specified.
size Integer The total number of javascripts in the items list, including prepended, fetched, and appended lists, and respecting the unique and max_size properties.
max_size Integer If set, this is the maximum number of items that will be returned in the items list and the maximum number of items that will be included when this javascripts object is enumerated as a list. When not set, this value will be 0.
unique Boolean When true, the items list will not contain any duplicates. Only the first instance of each javascript will be included.
limit Integer The maximum number of items that were allowed to be in the list of fetched javascripts. May be 0 in some cases (such as when when there are no fetched javascripts.
start Integer The 1-based index of the first item in the list of fetched javascripts.
page Integer The 1-based index of the paginated results returned in the list of fetched javascripts, which is calculated from the start and limit parameters. Useful for paginated results.
total_count Integer The 1-based index of the first item in the list of fetched javascripts
total_pages Integer

{% javascript %}

{% javascript output_to_template? [var, set, or assign]? variable? output_to_template? = value %}

{% javascript
output_to_template
 
If included the javascript will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this javascript is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this javascript to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the javascript will be output directly to the template.
=
value
 
Should evaluate to a javascript object, or the name or guid of a javascript May use liquid filters.
%}
Fetches a single javascript.

{% javascripts %}

{% javascripts output_to_template? [var, set, or assign]? variable? output_to_template? = arguments %}

{% javascripts
output_to_template
 
If included the javascripts will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this javascripts is stored on. "var" is the default behavior.
variable
output_to_template
 
If included the javascripts will be output directly to the template.
=
arguments
 
Key:value pairs. May use the variable arguments syntax.
%}

arguments

prepend
 
May be a single javascript, a list of javascripts, or the name or guid of a javascript to be be included at the beginning of the javascripts.
append
 
May be a single javascript, a list of javascripts, or the name or guid of a javascript to be be included at the end of the javascripts.
exclude
 
May be a single javascript, a list of javascripts, or the name or guid of a javascript that should NOT be included in the fetched results. Has no affect on prepended or appended javascripts.
exclude_prepended
 
True to specifically exclude all prepended javascripts from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.
exclude_appended
 
True to specifically exclude all appended javascripts from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.
unique
 
True to remove duplicates from each of the resulting lists (prepended, fetched, appended, and items), although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.
max_size
 
The maximum number of items to be included in the "items" list. If there are any prepended or appended items, this will automatically lower the "limit" to only fetch as many javascripts as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting javascripts. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
minify
 
Only include javascript objects that have the specified boolean value for their minify setting
path
 
May include multiple paths. Only include javascript objects with one of the given paths (excluding child paths)
date_created_start
 
Only include javascript objects with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the javascript objects was first published.
date_created_end
 
Only include javascript objects with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the javascript object was first published.
start
 
Set the 1-based index of the first javascript to fetch.
page
 
Used to automatically calculate the first javascript to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.
limit
 
The maximum number of javascripts to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
sort_by
 
Specify which property to sort the results by. Has no affect on prepended or appended javascripts. Options include:
  • date_created: the date each javascripts was first published. Unpublishing and republishing a javascripts resets date_created to the current date.
  • random: results will be returned in a random order, which prevents the page from being fast-cached. Setting cache_random:true overrides this behavior and allows the page to be fast-cached anyway.
  • name
  • title
  • url
  • browser_title
sort_direction
 
asc or desc.
cache_random
 
True to allow the results to be cached when sort_by is "random".
Fetches a list of javascripts.