MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:Budibase/budibase into bug/attachment-issue

This commit is contained in:
mike12345567 2021-02-01 15:55:07 +00:00
parent ca2be85b7d cced03be0a
commit e33ffb7bd4
15 changed files with 283 additions and 147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
packages/builder/src/builderStore/dataBinding.js
View File

@ -7,7 +7,6 @@ import { TableNames } from "../constants"
// Regex to match all instances of template strings // Regex to match all instances of template strings
const CAPTURE_VAR_INSIDE_TEMPLATE = /{{([^}]+)}}/g const CAPTURE_VAR_INSIDE_TEMPLATE = /{{([^}]+)}}/g
const INVALID_BINDING = "{{ invalid binding }}"
/** /**
* Gets all bindable data context fields and instance fields. * Gets all bindable data context fields and instance fields.

24
packages/builder/src/components/automation/SetupPanel/GenericBindingPopover.svelte
View File

@ -3,6 +3,7 @@
import { import {
TextArea, TextArea,
Label, Label,
Input,
Heading, Heading,
Body, Body,
Spacer, Spacer,
@ -11,6 +12,8 @@
} from "@budibase/bbui" } from "@budibase/bbui"
import { createEventDispatcher } from "svelte" import { createEventDispatcher } from "svelte"
import { isValid } from "@budibase/string-templates" import { isValid } from "@budibase/string-templates"
import { handlebarsCompletions } from "constants/completions"
const dispatch = createEventDispatcher() const dispatch = createEventDispatcher()
export let value = "" export let value = ""
@ -19,11 +22,14 @@
export let align export let align
export let popover = null export let popover = null
let helpers = handlebarsCompletions()
let getCaretPosition let getCaretPosition
let validity = true let validity = true
let search = ""
$: categories = Object.entries(groupBy("category", bindings)) $: categories = Object.entries(groupBy("category", bindings))
$: value && checkValid() $: value && checkValid()
$: searchRgx = new RegExp(search, "ig")
function onClickBinding(binding) { function onClickBinding(binding) {
const position = getCaretPosition() const position = getCaretPosition()
@ -47,12 +53,17 @@
<div class="container"> <div class="container">
<div class="bindings"> <div class="bindings">
<Heading small>Available bindings</Heading> <Heading small>Available bindings</Heading>
<Spacer medium />
<Input extraThin placeholder="Search" bind:value={search} />
<Spacer medium />
<div class="bindings__wrapper"> <div class="bindings__wrapper">
<div class="bindings__list"> <div class="bindings__list">
{#each categories as [categoryName, bindings]} {#each categories as [categoryName, bindings]}
<Heading extraSmall>{categoryName}</Heading> <Heading extraSmall>{categoryName}</Heading>
<Spacer extraSmall /> <Spacer extraSmall />
{#each bindings as binding} {#each bindings.filter(binding =>
binding.label.match(searchRgx)
) as binding}
<div class="binding" on:click={() => onClickBinding(binding)}> <div class="binding" on:click={() => onClickBinding(binding)}>
<span class="binding__label">{binding.label}</span> <span class="binding__label">{binding.label}</span>
<span class="binding__type">{binding.type}</span> <span class="binding__type">{binding.type}</span>
@ -63,6 +74,17 @@
</div> </div>
{/each} {/each}
{/each} {/each}
<Heading extraSmall>Helpers</Heading>
<Spacer extraSmall />
{#each helpers.filter(helper => helper.label.match(searchRgx) || helper.description.match(searchRgx)) as helper}
<div class="binding" on:click={() => onClickBinding(helper)}>
<span class="binding__label">{helper.label}</span>
<br />
<div class="binding__description">
{@html helper.description || ''}
</div>
</div>
{/each}
</div> </div>
</div> </div>
</div> </div>

8
packages/builder/src/components/backend/DataTable/modals/EditRoles.svelte
View File

@ -9,7 +9,7 @@
let permissions = [] let permissions = []
let selectedRole = {} let selectedRole = {}
let errors = [] let errors = []
let builtInRoles = ['Admin', 'Power', 'Basic', 'Public'] let builtInRoles = ["Admin", "Power", "Basic", "Public"]
$: selectedRoleId = selectedRole._id $: selectedRoleId = selectedRole._id
$: otherRoles = $backendUiStore.roles.filter( $: otherRoles = $backendUiStore.roles.filter(
role => role._id !== selectedRoleId role => role._id !== selectedRoleId
@ -103,7 +103,11 @@
{/each} {/each}
</Select> </Select>
{#if selectedRole} {#if selectedRole}
<Input label="Name" bind:value={selectedRole.name} thin disabled={builtInRoles.includes(selectedRole.name)}/> <Input
label="Name"
bind:value={selectedRole.name}
thin
disabled={builtInRoles.includes(selectedRole.name)} />
<Select <Select
thin thin
secondary secondary

1
packages/builder/src/components/backend/DataTable/popovers/ExportPopover.svelte
View File

@ -1,6 +1,7 @@
<script> <script>
import api from "builderStore/api" import api from "builderStore/api"
import { Button, Select } from "@budibase/bbui" import { Button, Select } from "@budibase/bbui"
import download from "downloadjs"
const FORMATS = [ const FORMATS = [
{ {

70
packages/builder/src/components/design/PropertiesPanel/BindingPanel.svelte
View File

@ -1,6 +1,6 @@
<script> <script>
import groupBy from "lodash/fp/groupBy" import groupBy from "lodash/fp/groupBy"
import { TextArea, Heading, Spacer } from "@budibase/bbui" import { Input, TextArea, Heading, Spacer, Label } from "@budibase/bbui"
import { createEventDispatcher } from "svelte" import { createEventDispatcher } from "svelte"
import { isValid } from "@budibase/string-templates" import { isValid } from "@budibase/string-templates"
import { import {
@ -8,18 +8,28 @@
readableToRuntimeBinding, readableToRuntimeBinding,
} from "builderStore/dataBinding" } from "builderStore/dataBinding"
import { currentAsset, store } from "../../../builderStore" import { currentAsset, store } from "../../../builderStore"
import { handlebarsCompletions } from "constants/completions"
const dispatch = createEventDispatcher() const dispatch = createEventDispatcher()
export let bindableProperties export let bindableProperties
export let value = "" export let value = ""
export let bindingDrawer export let bindingDrawer
export let valid = true export let valid = true
let originalValue = value
let helpers = handlebarsCompletions()
let getCaretPosition
let search = ""
$: value && checkValid() $: value && checkValid()
$: bindableProperties = getBindableProperties( $: bindableProperties = getBindableProperties(
$currentAsset.props, $currentAsset.props,
$store.selectedComponentId $store.selectedComponentId
) )
$: dispatch("update", value)
$: ({ instance, context } = groupBy("type", bindableProperties))
$: searchRgx = new RegExp(search, "ig")
function checkValid() { function checkValid() {
// TODO: need to convert the value to the runtime binding // TODO: need to convert the value to the runtime binding
@ -28,47 +38,79 @@
} }
function addToText(readableBinding) { function addToText(readableBinding) {
value = `${value || ""}{{ ${readableBinding} }}` const position = getCaretPosition()
const toAdd = `{{ ${readableBinding} }}`
if (position.start) {
value =
value.substring(0, position.start) +
toAdd +
value.substring(position.end, value.length)
} else {
value += toAdd
}
} }
let originalValue = value
$: dispatch("update", value)
export function cancel() { export function cancel() {
dispatch("update", originalValue) dispatch("update", originalValue)
bindingDrawer.close() bindingDrawer.close()
} }
$: ({ instance, context } = groupBy("type", bindableProperties)) function updateValue({ detail }) {
value = detail.value
}
</script> </script>
<div class="drawer-contents"> <div class="drawer-contents">
<div class="container" data-cy="binding-dropdown-modal"> <div class="container" data-cy="binding-dropdown-modal">
<div class="list"> <div class="list">
<Input extraThin placeholder="Search" bind:value={search} />
<Spacer medium />
{#if context} {#if context}
<Heading extraSmall>Columns</Heading> <Heading extraSmall>Columns</Heading>
<Spacer small /> <Spacer small />
<ul> <ul>
{#each context as { readableBinding }} {#each context.filter(context =>
context.readableBinding.match(searchRgx)
) as { readableBinding }}
<li on:click={() => addToText(readableBinding)}> <li on:click={() => addToText(readableBinding)}>
{readableBinding} {readableBinding}
</li> </li>
{/each} {/each}
</ul> </ul>
{/if} {/if}
<Spacer small />
{#if instance} {#if instance}
<Heading extraSmall>Components</Heading> <Heading extraSmall>Components</Heading>
<Spacer small />
<ul> <ul>
{#each instance as { readableBinding }} {#each instance.filter(instance =>
instance.readableBinding.match(searchRgx)
) as { readableBinding }}
<li on:click={() => addToText(readableBinding)}> <li on:click={() => addToText(readableBinding)}>
{readableBinding} {readableBinding}
</li> </li>
{/each} {/each}
</ul> </ul>
{/if} {/if}
<Spacer small />
<Heading extraSmall>Helpers</Heading>
<Spacer small />
<ul>
{#each helpers.filter(helper => helper.label.match(searchRgx) || helper.description.match(searchRgx)) as helper}
<li on:click={() => addToText(helper.text)}>
<div>
<Label extraSmall>{helper.displayText}</Label>
<div class="description">
{@html helper.description}
</div>
</div>
</li>
{/each}
</ul>
</div> </div>
<div class="text"> <div class="text">
<TextArea <TextArea
bind:getCaretPosition
thin thin
bind:value bind:value
placeholder="Add text, or click the objects on the left to add them to placeholder="Add text, or click the objects on the left to add them to
@ -151,4 +193,16 @@
color: var(--red); color: var(--red);
text-decoration: underline; text-decoration: underline;
} }
.description :global(p) {
color: var(--grey-7);
}
.description :global(p:hover) {
color: var(--ink);
}
.description :global(p a) {
color: var(--grey-7);
}
</style> </style>

22
packages/builder/src/components/integration/QueryEditor.svelte
View File

@ -2,6 +2,7 @@
import CodeMirror from "./codemirror" import CodeMirror from "./codemirror"
import { onMount, createEventDispatcher } from "svelte" import { onMount, createEventDispatcher } from "svelte"
import { themeStore } from "builderStore" import { themeStore } from "builderStore"
import { handlebarsCompletions } from "constants/completions"
const dispatch = createEventDispatcher() const dispatch = createEventDispatcher()
@ -15,6 +16,14 @@
export let lineNumbers = true export let lineNumbers = true
export let tab = true export let tab = true
export let mode export let mode
// export let parameters = []
let completions = handlebarsCompletions()
// $: completions = parameters.map(param => ({
// text: `{{ ${param.name} }}`,
// displayText: param.name,
// }))
let width let width
let height let height
@ -109,6 +118,7 @@
mode: modes[mode] || { mode: modes[mode] || {
name: mode, name: mode,
}, },
readOnly, readOnly,
autoCloseBrackets: true, autoCloseBrackets: true,
autoCloseTags: true, autoCloseTags: true,
@ -136,6 +146,18 @@
} }
}) })
// editor.on("cursorActivity", function() {
// editor.showHint({
// hint: function() {
// return {
// from: editor.getDoc().getCursor(),
// to: editor.getDoc().getCursor(),
// list: completions,
// }
// },
// })
// })
if (first) await sleep(50) if (first) await sleep(50)
editor.refresh() editor.refresh()

2
packages/builder/src/components/integration/codemirror.js
View File

@ -1,10 +1,12 @@
import CodeMirror from "codemirror" import CodeMirror from "codemirror"
import "codemirror/lib/codemirror.css" import "codemirror/lib/codemirror.css"
import "codemirror/theme/tomorrow-night-eighties.css" import "codemirror/theme/tomorrow-night-eighties.css"
import "codemirror/addon/hint/show-hint.css"
import "codemirror/theme/neo.css" import "codemirror/theme/neo.css"
import "codemirror/mode/sql/sql" import "codemirror/mode/sql/sql"
import "codemirror/mode/css/css" import "codemirror/mode/css/css"
import "codemirror/mode/handlebars/handlebars" import "codemirror/mode/handlebars/handlebars"
import "codemirror/mode/javascript/javascript" import "codemirror/mode/javascript/javascript"
import "codemirror/addon/hint/show-hint"
export default CodeMirror export default CodeMirror

6
packages/builder/src/components/integration/index.svelte
View File

@ -28,14 +28,16 @@
mode="sql" mode="sql"
on:change={updateQuery} on:change={updateQuery}
readOnly={!editable} readOnly={!editable}
value={query.fields.sql} /> value={query.fields.sql}
parameters={query.parameters} />
{:else if schema.type === QueryTypes.JSON} {:else if schema.type === QueryTypes.JSON}
<Editor <Editor
label="Query" label="Query"
mode="json" mode="json"
on:change={updateQuery} on:change={updateQuery}
readOnly={!editable} readOnly={!editable}
value={query.fields.json} /> value={query.fields.json}
parameters={query.parameters} />
{:else if schema.type === QueryTypes.FIELDS} {:else if schema.type === QueryTypes.FIELDS}
<FieldsBuilder bind:fields={query.fields} {schema} {editable} /> <FieldsBuilder bind:fields={query.fields} {schema} {editable} />
{/if} {/if}

15
packages/builder/src/constants/completions.js Normal file
View File

@ -0,0 +1,15 @@
import { getManifest } from "@budibase/string-templates"
export function handlebarsCompletions() {
const manifest = getManifest()
return Object.keys(manifest).flatMap(key =>
Object.entries(manifest[key]).map(([helperName, helperConfig]) => ({
text: helperName,
path: helperName,
label: helperName,
displayText: helperName,
description: helperConfig.description,
}))
)
}

248
packages/string-templates/manifest.json
View File

@ -5,7 +5,7 @@
"a" "a"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Return the magnitude of `a`." "description": "<p>Return the magnitude of <code>a</code>.</p>\n"
}, },
"add": { "add": {
"args": [ "args": [
@ -13,7 +13,7 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Return the sum of `a` plus `b`." "description": "<p>Return the sum of <code>a</code> plus <code>b</code>.</p>\n"
}, },
"avg": { "avg": {
"args": [ "args": [
@ -21,14 +21,14 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{avg \"[1, 2, 3, 4, 5]\"}} <!-- results in: '3' --> ", "example": "handlebars {{avg \"[1, 2, 3, 4, 5]\"}} <!-- results in: '3' --> ",
"description": "Returns the average of all numbers in the given array." "description": "<p>Returns the average of all numbers in the given array.</p>\n"
}, },
"ceil": { "ceil": {
"args": [ "args": [
"value" "value"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Get the `Math.ceil()` of the given value." "description": "<p>Get the <code>Math.ceil()</code> of the given value.</p>\n"
}, },
"divide": { "divide": {
"args": [ "args": [
@ -36,14 +36,14 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Divide `a` by `b`" "description": "<p>Divide <code>a</code> by <code>b</code></p>\n"
}, },
"floor": { "floor": {
"args": [ "args": [
"value" "value"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Get the `Math.floor()` of the given value." "description": "<p>Get the <code>Math.floor()</code> of the given value.</p>\n"
}, },
"minus": { "minus": {
"args": [ "args": [
@ -51,7 +51,7 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Return the product of `a` minus `b`." "description": "<p>Return the product of <code>a</code> minus <code>b</code>.</p>\n"
}, },
"modulo": { "modulo": {
"args": [ "args": [
@ -59,7 +59,7 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Get the remainder of a division operation." "description": "<p>Get the remainder of a division operation.</p>\n"
}, },
"multiply": { "multiply": {
"args": [ "args": [
@ -67,7 +67,7 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Return the product of `a` times `b`." "description": "<p>Return the product of <code>a</code> times <code>b</code>.</p>\n"
}, },
"plus": { "plus": {
"args": [ "args": [
@ -75,7 +75,7 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Add `a` by `b`." "description": "<p>Add <code>a</code> by <code>b</code>.</p>\n"
}, },
"random": { "random": {
"args": [ "args": [
@ -83,7 +83,7 @@
"max" "max"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Generate a random number between two values" "description": "<p>Generate a random number between two values</p>\n"
}, },
"remainder": { "remainder": {
"args": [ "args": [
@ -91,14 +91,14 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Get the remainder when `a` is divided by `b`." "description": "<p>Get the remainder when <code>a</code> is divided by <code>b</code>.</p>\n"
}, },
"round": { "round": {
"args": [ "args": [
"number" "number"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Round the given number." "description": "<p>Round the given number.</p>\n"
}, },
"subtract": { "subtract": {
"args": [ "args": [
@ -106,7 +106,7 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Return the product of `a` minus `b`." "description": "<p>Return the product of <code>a</code> minus <code>b</code>.</p>\n"
}, },
"sum": { "sum": {
"args": [ "args": [
@ -114,7 +114,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{sum \"[1, 2, 3, 4, 5]\"}} <!-- results in: '15' --> ", "example": "handlebars {{sum \"[1, 2, 3, 4, 5]\"}} <!-- results in: '15' --> ",
"description": "Returns the sum of all numbers in the given array." "description": "<p>Returns the sum of all numbers in the given array.</p>\n"
}, },
"times": { "times": {
"args": [ "args": [
@ -122,7 +122,7 @@
"b" "b"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Multiply number `a` by number `b`." "description": "<p>Multiply number <code>a</code> by number <code>b</code>.</p>\n"
} }
}, },
"array": { "array": {
@ -133,7 +133,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{after array 1}} <!-- results in: '[\"c\"]' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{after array 1}} <!-- results in: '[\"c\"]' --> ",
"description": "Returns all of the items in an array after the specified index. Opposite of [before](#before)." "description": "<p>Returns all of the items in an array after the specified index. Opposite of <a href=\"#before\">before</a>.</p>\n"
}, },
"arrayify": { "arrayify": {
"args": [ "args": [
@ -141,7 +141,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{arrayify \"foo\"}} <!-- results in: [ \"foo\" ] --> ", "example": "handlebars {{arrayify \"foo\"}} <!-- results in: [ \"foo\" ] --> ",
"description": "Cast the given `value` to an array." "description": "<p>Cast the given <code>value</code> to an array.</p>\n"
}, },
"before": { "before": {
"args": [ "args": [
@ -150,7 +150,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{before array 2}} <!-- results in: '[\"a\", \"b\"]' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{before array 2}} <!-- results in: '[\"a\", \"b\"]' --> ",
"description": "Return all of the items in the collection before the specified count. Opposite of [after](#after)." "description": "<p>Return all of the items in the collection before the specified count. Opposite of <a href=\"#after\">after</a>.</p>\n"
}, },
"eachIndex": { "eachIndex": {
"args": [ "args": [
@ -159,7 +159,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'] --> {{#eachIndex array}} {{item}} is {{index}} {{/eachIndex}} ", "example": "handlebars <!-- array: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'] --> {{#eachIndex array}} {{item}} is {{index}} {{/eachIndex}} ",
"description": "Iterates the array, listing an item and the index of it." "description": "<p>Iterates the array, listing an item and the index of it.</p>\n"
}, },
"filter": { "filter": {
"args": [ "args": [
@ -169,7 +169,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{#filter array \"foo\"}}AAA{{else}}BBB{{/filter}} <!-- results in: 'BBB' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{#filter array \"foo\"}}AAA{{else}}BBB{{/filter}} <!-- results in: 'BBB' --> ",
"description": "Block helper that filters the given array and renders the block for values that evaluate to `true`, otherwise the inverse block is returned." "description": "<p>Block helper that filters the given array and renders the block for values that evaluate to <code>true</code>, otherwise the inverse block is returned.</p>\n"
}, },
"first": { "first": {
"args": [ "args": [
@ -178,7 +178,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{first \"['a', 'b', 'c', 'd', 'e']\" 2}} <!-- results in: '[\"a\", \"b\"]' --> ", "example": "handlebars {{first \"['a', 'b', 'c', 'd', 'e']\" 2}} <!-- results in: '[\"a\", \"b\"]' --> ",
"description": "Returns the first item, or first `n` items of an array." "description": "<p>Returns the first item, or first <code>n</code> items of an array.</p>\n"
}, },
"forEach": { "forEach": {
"args": [ "args": [
@ -186,7 +186,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars <!-- accounts = [ {'name': 'John', 'email': 'john@example.com'}, {'name': 'Malcolm', 'email': 'malcolm@example.com'}, {'name': 'David', 'email': 'david@example.com'} ] --> {{#forEach accounts}} <a href=\"mailto:{{ email }}\" title=\"Send an email to {{ name }}\"> {{ name }} </a>{{#unless isLast}}, {{/unless}} {{/forEach}} ", "example": "handlebars <!-- accounts = [ {'name': 'John', 'email': 'john@example.com'}, {'name': 'Malcolm', 'email': 'malcolm@example.com'}, {'name': 'David', 'email': 'david@example.com'} ] --> {{#forEach accounts}} <a href=\"mailto:{{ email }}\" title=\"Send an email to {{ name }}\"> {{ name }} </a>{{#unless isLast}}, {{/unless}} {{/forEach}} ",
"description": "Iterates over each item in an array and exposes the current item in the array as context to the inner block. In addition to the current array item, the helper exposes the following variables to the inner block: - `index` - `total` - `isFirst` - `isLast` Also, `@index` is exposed as a private variable, and additional private variables may be defined as hash arguments." "description": "<p>Iterates over each item in an array and exposes the current item in the array as context to the inner block. In addition to the current array item, the helper exposes the following variables to the inner block: - <code>index</code> - <code>total</code> - <code>isFirst</code> - <code>isLast</code> Also, <code>@index</code> is exposed as a private variable, and additional private variables may be defined as hash arguments.</p>\n"
}, },
"inArray": { "inArray": {
"args": [ "args": [
@ -196,7 +196,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{#inArray array \"d\"}} foo {{else}} bar {{/inArray}} <!-- results in: 'bar' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{#inArray array \"d\"}} foo {{else}} bar {{/inArray}} <!-- results in: 'bar' --> ",
"description": "Block helper that renders the block if an array has the given `value`. Optionally specify an inverse block to render when the array does not have the given value." "description": "<p>Block helper that renders the block if an array has the given <code>value</code>. Optionally specify an inverse block to render when the array does not have the given value.</p>\n"
}, },
"isArray": { "isArray": {
"args": [ "args": [
@ -204,7 +204,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{isArray \"abc\"}} <!-- results in: false --> <!-- array: [1, 2, 3] --> {{isArray array}} <!-- results in: true --> ", "example": "handlebars {{isArray \"abc\"}} <!-- results in: false --> <!-- array: [1, 2, 3] --> {{isArray array}} <!-- results in: true --> ",
"description": "Returns true if `value` is an es5 array." "description": "<p>Returns true if <code>value</code> is an es5 array.</p>\n"
}, },
"itemAt": { "itemAt": {
"args": [ "args": [
@ -213,7 +213,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{itemAt array 1}} <!-- results in: 'b' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{itemAt array 1}} <!-- results in: 'b' --> ",
"description": "Returns the item from `array` at index `idx`." "description": "<p>Returns the item from <code>array</code> at index <code>idx</code>.</p>\n"
}, },
"join": { "join": {
"args": [ "args": [
@ -222,7 +222,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{join array}} <!-- results in: 'a, b, c' --> {{join array '-'}} <!-- results in: 'a-b-c' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{join array}} <!-- results in: 'a, b, c' --> {{join array '-'}} <!-- results in: 'a-b-c' --> ",
"description": "Join all elements of array into a string, optionally using a given separator." "description": "<p>Join all elements of array into a string, optionally using a given separator.</p>\n"
}, },
"equalsLength": { "equalsLength": {
"args": [ "args": [
@ -231,7 +231,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Returns true if the the length of the given `value` is equal to the given `length`. Can be used as a block or inline helper." "description": "<p>Returns true if the the length of the given <code>value</code> is equal to the given <code>length</code>. Can be used as a block or inline helper.</p>\n"
}, },
"last": { "last": {
"args": [ "args": [
@ -240,7 +240,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- var value = ['a', 'b', 'c', 'd', 'e'] --> {{last value}} <!-- results in: ['e'] --> {{last value 2}} <!-- results in: ['d', 'e'] --> {{last value 3}} <!-- results in: ['c', 'd', 'e'] --> ", "example": "handlebars <!-- var value = ['a', 'b', 'c', 'd', 'e'] --> {{last value}} <!-- results in: ['e'] --> {{last value 2}} <!-- results in: ['d', 'e'] --> {{last value 3}} <!-- results in: ['c', 'd', 'e'] --> ",
"description": "Returns the last item, or last `n` items of an array or string. Opposite of [first](#first)." "description": "<p>Returns the last item, or last <code>n</code> items of an array or string. Opposite of <a href=\"#first\">first</a>.</p>\n"
}, },
"length": { "length": {
"args": [ "args": [
@ -248,7 +248,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{length '[\"a\", \"b\", \"c\"]'}} <!-- results in: 3 --> <!-- results in: myArray = ['a', 'b', 'c', 'd', 'e']; --> {{length myArray}} <!-- results in: 5 --> <!-- results in: myObject = {'a': 'a', 'b': 'b'}; --> {{length myObject}} <!-- results in: 2 --> ", "example": "handlebars {{length '[\"a\", \"b\", \"c\"]'}} <!-- results in: 3 --> <!-- results in: myArray = ['a', 'b', 'c', 'd', 'e']; --> {{length myArray}} <!-- results in: 5 --> <!-- results in: myObject = {'a': 'a', 'b': 'b'}; --> {{length myObject}} <!-- results in: 2 --> ",
"description": "Returns the length of the given string or array." "description": "<p>Returns the length of the given string or array.</p>\n"
}, },
"lengthEqual": { "lengthEqual": {
"args": [ "args": [
@ -257,7 +257,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Returns true if the the length of the given `value` is equal to the given `length`. Can be used as a block or inline helper." "description": "<p>Returns true if the the length of the given <code>value</code> is equal to the given <code>length</code>. Can be used as a block or inline helper.</p>\n"
}, },
"map": { "map": {
"args": [ "args": [
@ -266,7 +266,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: ['a', 'b', 'c'], and \"double\" is a fictitious function that duplicates letters --> {{map array double}} <!-- results in: '[\"aa\", \"bb\", \"cc\"]' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'], and \"double\" is a fictitious function that duplicates letters --> {{map array double}} <!-- results in: '[\"aa\", \"bb\", \"cc\"]' --> ",
"description": "Returns a new array, created by calling `function` on each element of the given `array`. For example," "description": "<p>Returns a new array, created by calling <code>function</code> on each element of the given <code>array</code>. For example,</p>\n"
}, },
"pluck": { "pluck": {
"args": [ "args": [
@ -275,7 +275,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars // {{pluck items \"data.title\"}} <!-- results in: '[\"aa\", \"bb\", \"cc\"]' --> ", "example": "handlebars // {{pluck items \"data.title\"}} <!-- results in: '[\"aa\", \"bb\", \"cc\"]' --> ",
"description": "Map over the given object or array or objects and create an array of values from the given `prop`. Dot-notation may be used (as a string) to get nested properties." "description": "<p>Map over the given object or array or objects and create an array of values from the given <code>prop</code>. Dot-notation may be used (as a string) to get nested properties.</p>\n"
}, },
"reverse": { "reverse": {
"args": [ "args": [
@ -283,7 +283,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars <!-- value: 'abcd' --> {{reverse value}} <!-- results in: 'dcba' --> <!-- value: ['a', 'b', 'c', 'd'] --> {{reverse value}} <!-- results in: ['d', 'c', 'b', 'a'] --> ", "example": "handlebars <!-- value: 'abcd' --> {{reverse value}} <!-- results in: 'dcba' --> <!-- value: ['a', 'b', 'c', 'd'] --> {{reverse value}} <!-- results in: ['d', 'c', 'b', 'a'] --> ",
"description": "Reverse the elements in an array, or the characters in a string." "description": "<p>Reverse the elements in an array, or the characters in a string.</p>\n"
}, },
"some": { "some": {
"args": [ "args": [
@ -293,7 +293,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: [1, 'b', 3] --> {{#some array isString}} Render me if the array has a string. {{else}} Render me if it doesn't. {{/some}} <!-- results in: 'Render me if the array has a string.' --> ", "example": "handlebars <!-- array: [1, 'b', 3] --> {{#some array isString}} Render me if the array has a string. {{else}} Render me if it doesn't. {{/some}} <!-- results in: 'Render me if the array has a string.' --> ",
"description": "Block helper that returns the block if the callback returns true for some value in the given array." "description": "<p>Block helper that returns the block if the callback returns true for some value in the given array.</p>\n"
}, },
"sort": { "sort": {
"args": [ "args": [
@ -302,7 +302,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: ['b', 'a', 'c'] --> {{sort array}} <!-- results in: '[\"a\", \"b\", \"c\"]' --> ", "example": "handlebars <!-- array: ['b', 'a', 'c'] --> {{sort array}} <!-- results in: '[\"a\", \"b\", \"c\"]' --> ",
"description": "Sort the given `array`. If an array of objects is passed, you may optionally pass a `key` to sort on as the second argument. You may alternatively pass a sorting function as the second argument." "description": "<p>Sort the given <code>array</code>. If an array of objects is passed, you may optionally pass a <code>key</code> to sort on as the second argument. You may alternatively pass a sorting function as the second argument.</p>\n"
}, },
"sortBy": { "sortBy": {
"args": [ "args": [
@ -311,7 +311,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: [{a: 'zzz'}, {a: 'aaa'}] --> {{sortBy array \"a\"}} <!-- results in: '[{\"a\":\"aaa\"}, {\"a\":\"zzz\"}]' --> ", "example": "handlebars <!-- array: [{a: 'zzz'}, {a: 'aaa'}] --> {{sortBy array \"a\"}} <!-- results in: '[{\"a\":\"aaa\"}, {\"a\":\"zzz\"}]' --> ",
"description": "Sort an `array`. If an array of objects is passed, you may optionally pass a `key` to sort on as the second argument. You may alternatively pass a sorting function as the second argument." "description": "<p>Sort an <code>array</code>. If an array of objects is passed, you may optionally pass a <code>key</code> to sort on as the second argument. You may alternatively pass a sorting function as the second argument.</p>\n"
}, },
"withAfter": { "withAfter": {
"args": [ "args": [
@ -321,7 +321,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: ['a', 'b', 'c', 'd', 'e'] --> {{#withAfter array 3}} {{this}} {{/withAfter}} <!-- results in: \"de\" --> ", "example": "handlebars <!-- array: ['a', 'b', 'c', 'd', 'e'] --> {{#withAfter array 3}} {{this}} {{/withAfter}} <!-- results in: \"de\" --> ",
"description": "Use the items in the array _after_ the specified index as context inside a block. Opposite of [withBefore](#withBefore)." "description": "<p>Use the items in the array <em>after</em> the specified index as context inside a block. Opposite of <a href=\"#withBefore\">withBefore</a>.</p>\n"
}, },
"withBefore": { "withBefore": {
"args": [ "args": [
@ -331,7 +331,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: ['a', 'b', 'c', 'd', 'e'] --> {{#withBefore array 3}} {{this}} {{/withBefore}} <!-- results in: 'ab' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c', 'd', 'e'] --> {{#withBefore array 3}} {{this}} {{/withBefore}} <!-- results in: 'ab' --> ",
"description": "Use the items in the array _before_ the specified index as context inside a block. Opposite of [withAfter](#withAfter)." "description": "<p>Use the items in the array <em>before</em> the specified index as context inside a block. Opposite of <a href=\"#withAfter\">withAfter</a>.</p>\n"
}, },
"withFirst": { "withFirst": {
"args": [ "args": [
@ -341,7 +341,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{#withFirst array}} {{this}} {{/withFirst}} <!-- results in: 'a' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{#withFirst array}} {{this}} {{/withFirst}} <!-- results in: 'a' --> ",
"description": "Use the first item in a collection inside a handlebars block expression. Opposite of [withLast](#withLast)." "description": "<p>Use the first item in a collection inside a handlebars block expression. Opposite of <a href=\"#withLast\">withLast</a>.</p>\n"
}, },
"withGroup": { "withGroup": {
"args": [ "args": [
@ -351,7 +351,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: ['a','b','c','d','e','f','g','h'] --> {{#withGroup array 4}} {{#each this}} {{.}} {{each}} <br> {{/withGroup}} <!-- results in: --> <!-- 'a','b','c','d'<br> --> <!-- 'e','f','g','h'<br> --> ", "example": "handlebars <!-- array: ['a','b','c','d','e','f','g','h'] --> {{#withGroup array 4}} {{#each this}} {{.}} {{each}} <br> {{/withGroup}} <!-- results in: --> <!-- 'a','b','c','d'<br> --> <!-- 'e','f','g','h'<br> --> ",
"description": "Block helper that groups array elements by given group `size`." "description": "<p>Block helper that groups array elements by given group <code>size</code>.</p>\n"
}, },
"withLast": { "withLast": {
"args": [ "args": [
@ -361,7 +361,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{#withLast array}} {{this}} {{/withLast}} <!-- results in: 'c' --> ", "example": "handlebars <!-- array: ['a', 'b', 'c'] --> {{#withLast array}} {{this}} {{/withLast}} <!-- results in: 'c' --> ",
"description": "Use the last item or `n` items in an array as context inside a block. Opposite of [withFirst](#withFirst)." "description": "<p>Use the last item or <code>n</code> items in an array as context inside a block. Opposite of <a href=\"#withFirst\">withFirst</a>.</p>\n"
}, },
"withSort": { "withSort": {
"args": [ "args": [
@ -371,7 +371,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- array: ['b', 'a', 'c'] --> {{#withSort array}}{{this}}{{/withSort}} <!-- results in: 'abc' --> ", "example": "handlebars <!-- array: ['b', 'a', 'c'] --> {{#withSort array}}{{this}}{{/withSort}} <!-- results in: 'abc' --> ",
"description": "Block helper that sorts a collection and exposes the sorted collection as context inside the block." "description": "<p>Block helper that sorts a collection and exposes the sorted collection as context inside the block.</p>\n"
}, },
"unique": { "unique": {
"args": [ "args": [
@ -380,7 +380,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- array: ['a', 'a', 'c', 'b', 'e', 'e'] --> {{#each (unique array)}}{{.}}{{/each}} <!-- results in: 'acbe' --> ", "example": "handlebars <!-- array: ['a', 'a', 'c', 'b', 'e', 'e'] --> {{#each (unique array)}}{{.}}{{/each}} <!-- results in: 'acbe' --> ",
"description": "Block helper that return an array with all duplicate values removed. Best used along with a [each](#each) helper." "description": "<p>Block helper that return an array with all duplicate values removed. Best used along with a <a href=\"#each\">each</a> helper.</p>\n"
} }
}, },
"number": { "number": {
@ -389,21 +389,21 @@
"number" "number"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Format a number to it's equivalent in bytes. If a string is passed, it's length will be formatted and returned. **Examples:** - `'foo' => 3 B` - `13661855 => 13.66 MB` - `825399 => 825.39 kB` - `1396 => 1.4 kB`" "description": "<p>Format a number to it&#39;s equivalent in bytes. If a string is passed, it&#39;s length will be formatted and returned. <strong>Examples:</strong> - <code>&#39;foo&#39; =&gt; 3 B</code> - <code>13661855 =&gt; 13.66 MB</code> - <code>825399 =&gt; 825.39 kB</code> - <code>1396 =&gt; 1.4 kB</code></p>\n"
}, },
"addCommas": { "addCommas": {
"args": [ "args": [
"num" "num"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Add commas to numbers" "description": "<p>Add commas to numbers</p>\n"
}, },
"phoneNumber": { "phoneNumber": {
"args": [ "args": [
"num" "num"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Convert a string or number to a formatted phone number." "description": "<p>Convert a string or number to a formatted phone number.</p>\n"
}, },
"toAbbr": { "toAbbr": {
"args": [ "args": [
@ -411,7 +411,7 @@
"precision" "precision"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Abbreviate numbers to the given number of `precision`. This for general numbers, not size in bytes." "description": "<p>Abbreviate numbers to the given number of <code>precision</code>. This for general numbers, not size in bytes.</p>\n"
}, },
"toExponential": { "toExponential": {
"args": [ "args": [
@ -420,7 +420,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{toExponential number digits}}; ", "example": "handlebars {{toExponential number digits}}; ",
"description": "Returns a string representing the given number in exponential notation." "description": "<p>Returns a string representing the given number in exponential notation.</p>\n"
}, },
"toFixed": { "toFixed": {
"args": [ "args": [
@ -429,21 +429,21 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{toFixed \"1.1234\" 2}} //=> '1.12' ", "example": "handlebars {{toFixed \"1.1234\" 2}} //=> '1.12' ",
"description": "Formats the given number using fixed-point notation." "description": "<p>Formats the given number using fixed-point notation.</p>\n"
}, },
"toFloat": { "toFloat": {
"args": [ "args": [
"number" "number"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Convert input to a float." "description": "<p>Convert input to a float.</p>\n"
}, },
"toInt": { "toInt": {
"args": [ "args": [
"number" "number"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Convert input to an integer." "description": "<p>Convert input to an integer.</p>\n"
}, },
"toPrecision": { "toPrecision": {
"args": [ "args": [
@ -452,7 +452,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{toPrecision \"1.1234\" 2}} //=> '1.1' ", "example": "handlebars {{toPrecision \"1.1234\" 2}} //=> '1.1' ",
"description": "Returns a string representing the `Number` object to the specified precision." "description": "<p>Returns a string representing the <code>Number</code> object to the specified precision.</p>\n"
} }
}, },
"url": { "url": {
@ -461,31 +461,31 @@
"str" "str"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Encodes a Uniform Resource Identifier (URI) component by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character." "description": "<p>Encodes a Uniform Resource Identifier (URI) component by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character.</p>\n"
}, },
"escape": { "escape": {
"args": [ "args": [
"str" "str"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Escape the given string by replacing characters with escape sequences. Useful for allowing the string to be used in a URL, etc." "description": "<p>Escape the given string by replacing characters with escape sequences. Useful for allowing the string to be used in a URL, etc.</p>\n"
}, },
"decodeURI": { "decodeURI": {
"args": [ "args": [
"str" "str"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Decode a Uniform Resource Identifier (URI) component." "description": "<p>Decode a Uniform Resource Identifier (URI) component.</p>\n"
}, },
"url_encode": { "url_encode": {
"args": [], "args": [],
"numArgs": 0, "numArgs": 0,
"description": "Alias for [encodeURI](#encodeuri)." "description": "<p>Alias for <a href=\"#encodeuri\">encodeURI</a>.</p>\n"
}, },
"url_decode": { "url_decode": {
"args": [], "args": [],
"numArgs": 0, "numArgs": 0,
"description": "Alias for [decodeURI](#decodeuri)." "description": "<p>Alias for <a href=\"#decodeuri\">decodeURI</a>.</p>\n"
}, },
"urlResolve": { "urlResolve": {
"args": [ "args": [
@ -493,21 +493,21 @@
"href" "href"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Take a base URL, and a href URL, and resolve them as a browser would for an anchor tag." "description": "<p>Take a base URL, and a href URL, and resolve them as a browser would for an anchor tag.</p>\n"
}, },
"urlParse": { "urlParse": {
"args": [ "args": [
"str" "str"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Parses a `url` string into an object." "description": "<p>Parses a <code>url</code> string into an object.</p>\n"
}, },
"stripQuerystring": { "stripQuerystring": {
"args": [ "args": [
"url" "url"
], ],
"numArgs": 1, "numArgs": 1,
"description": "Strip the query string from the given `url`." "description": "<p>Strip the query string from the given <code>url</code>.</p>\n"
}, },
"stripProtocol": { "stripProtocol": {
"args": [ "args": [
@ -515,7 +515,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars <!-- url = 'http://foo.bar' --> {{stripProtocol url}} <!-- results in: '//foo.bar' --> ", "example": "handlebars <!-- url = 'http://foo.bar' --> {{stripProtocol url}} <!-- results in: '//foo.bar' --> ",
"description": "Strip protocol from a `url`. Useful for displaying media that may have an 'http' protocol on secure connections." "description": "<p>Strip protocol from a <code>url</code>. Useful for displaying media that may have an &#39;http&#39; protocol on secure connections.</p>\n"
} }
}, },
"string": { "string": {
@ -526,7 +526,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- given that \"item.stem\" is \"foo\" --> {{append item.stem \".html\"}} <!-- results in: 'foo.html' --> ", "example": "handlebars <!-- given that \"item.stem\" is \"foo\" --> {{append item.stem \".html\"}} <!-- results in: 'foo.html' --> ",
"description": "Append the specified `suffix` to the given string." "description": "<p>Append the specified <code>suffix</code> to the given string.</p>\n"
}, },
"camelcase": { "camelcase": {
"args": [ "args": [
@ -534,7 +534,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{camelcase \"foo bar baz\"}}; <!-- results in: 'fooBarBaz' --> ", "example": "handlebars {{camelcase \"foo bar baz\"}}; <!-- results in: 'fooBarBaz' --> ",
"description": "camelCase the characters in the given `string`." "description": "<p>camelCase the characters in the given <code>string</code>.</p>\n"
}, },
"capitalize": { "capitalize": {
"args": [ "args": [
@ -542,7 +542,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{capitalize \"foo bar baz\"}} <!-- results in: \"Foo bar baz\" --> ", "example": "handlebars {{capitalize \"foo bar baz\"}} <!-- results in: \"Foo bar baz\" --> ",
"description": "Capitalize the first word in a sentence." "description": "<p>Capitalize the first word in a sentence.</p>\n"
}, },
"capitalizeAll": { "capitalizeAll": {
"args": [ "args": [
@ -550,7 +550,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{capitalizeAll \"foo bar baz\"}} <!-- results in: \"Foo Bar Baz\" --> ", "example": "handlebars {{capitalizeAll \"foo bar baz\"}} <!-- results in: \"Foo Bar Baz\" --> ",
"description": "Capitalize all words in a string." "description": "<p>Capitalize all words in a string.</p>\n"
}, },
"center": { "center": {
"args": [ "args": [
@ -558,7 +558,7 @@
"spaces" "spaces"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Center a string using non-breaking spaces" "description": "<p>Center a string using non-breaking spaces</p>\n"
}, },
"chop": { "chop": {
"args": [ "args": [
@ -566,7 +566,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{chop \"_ABC_\"}} <!-- results in: 'ABC' --> {{chop \"-ABC-\"}} <!-- results in: 'ABC' --> {{chop \" ABC \"}} <!-- results in: 'ABC' --> ", "example": "handlebars {{chop \"_ABC_\"}} <!-- results in: 'ABC' --> {{chop \"-ABC-\"}} <!-- results in: 'ABC' --> {{chop \" ABC \"}} <!-- results in: 'ABC' --> ",
"description": "Like trim, but removes both extraneous whitespace **and non-word characters** from the beginning and end of a string." "description": "<p>Like trim, but removes both extraneous whitespace <strong>and non-word characters</strong> from the beginning and end of a string.</p>\n"
}, },
"dashcase": { "dashcase": {
"args": [ "args": [
@ -574,7 +574,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{dashcase \"a-b-c d_e\"}} <!-- results in: 'a-b-c-d-e' --> ", "example": "handlebars {{dashcase \"a-b-c d_e\"}} <!-- results in: 'a-b-c-d-e' --> ",
"description": "dash-case the characters in `string`. Replaces non-word characters and periods with hyphens." "description": "<p>dash-case the characters in <code>string</code>. Replaces non-word characters and periods with hyphens.</p>\n"
}, },
"dotcase": { "dotcase": {
"args": [ "args": [
@ -582,7 +582,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{dotcase \"a-b-c d_e\"}} <!-- results in: 'a.b.c.d.e' --> ", "example": "handlebars {{dotcase \"a-b-c d_e\"}} <!-- results in: 'a.b.c.d.e' --> ",
"description": "dot.case the characters in `string`." "description": "<p>dot.case the characters in <code>string</code>.</p>\n"
}, },
"downcase": { "downcase": {
"args": [ "args": [
@ -590,7 +590,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{downcase \"aBcDeF\"}} <!-- results in: 'abcdef' --> ", "example": "handlebars {{downcase \"aBcDeF\"}} <!-- results in: 'abcdef' --> ",
"description": "Lowercase all of the characters in the given string. Alias for [lowercase](#lowercase)." "description": "<p>Lowercase all of the characters in the given string. Alias for <a href=\"#lowercase\">lowercase</a>.</p>\n"
}, },
"ellipsis": { "ellipsis": {
"args": [ "args": [
@ -599,7 +599,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{ellipsis (sanitize \"<span>foo bar baz</span>\"), 7}} <!-- results in: 'foo bar…' --> {{ellipsis \"foo bar baz\", 7}} <!-- results in: 'foo bar…' --> ", "example": "handlebars {{ellipsis (sanitize \"<span>foo bar baz</span>\"), 7}} <!-- results in: 'foo bar…' --> {{ellipsis \"foo bar baz\", 7}} <!-- results in: 'foo bar…' --> ",
"description": "Truncates a string to the specified `length`, and appends it with an elipsis, `…`." "description": "<p>Truncates a string to the specified <code>length</code>, and appends it with an elipsis, <code>…</code>.</p>\n"
}, },
"hyphenate": { "hyphenate": {
"args": [ "args": [
@ -607,7 +607,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{hyphenate \"foo bar baz qux\"}} <!-- results in: \"foo-bar-baz-qux\" --> ", "example": "handlebars {{hyphenate \"foo bar baz qux\"}} <!-- results in: \"foo-bar-baz-qux\" --> ",
"description": "Replace spaces in a string with hyphens." "description": "<p>Replace spaces in a string with hyphens.</p>\n"
}, },
"isString": { "isString": {
"args": [ "args": [
@ -615,7 +615,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{isString \"foo\"}} <!-- results in: 'true' --> ", "example": "handlebars {{isString \"foo\"}} <!-- results in: 'true' --> ",
"description": "Return true if `value` is a string." "description": "<p>Return true if <code>value</code> is a string.</p>\n"
}, },
"lowercase": { "lowercase": {
"args": [ "args": [
@ -623,7 +623,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{lowercase \"Foo BAR baZ\"}} <!-- results in: 'foo bar baz' --> ", "example": "handlebars {{lowercase \"Foo BAR baZ\"}} <!-- results in: 'foo bar baz' --> ",
"description": "Lowercase all characters in the given string." "description": "<p>Lowercase all characters in the given string.</p>\n"
}, },
"occurrences": { "occurrences": {
"args": [ "args": [
@ -632,7 +632,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{occurrences \"foo bar foo bar baz\" \"foo\"}} <!-- results in: 2 --> ", "example": "handlebars {{occurrences \"foo bar foo bar baz\" \"foo\"}} <!-- results in: 2 --> ",
"description": "Return the number of occurrences of `substring` within the given `string`." "description": "<p>Return the number of occurrences of <code>substring</code> within the given <code>string</code>.</p>\n"
}, },
"pascalcase": { "pascalcase": {
"args": [ "args": [
@ -640,7 +640,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{pascalcase \"foo bar baz\"}} <!-- results in: 'FooBarBaz' --> ", "example": "handlebars {{pascalcase \"foo bar baz\"}} <!-- results in: 'FooBarBaz' --> ",
"description": "PascalCase the characters in `string`." "description": "<p>PascalCase the characters in <code>string</code>.</p>\n"
}, },
"pathcase": { "pathcase": {
"args": [ "args": [
@ -648,7 +648,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{pathcase \"a-b-c d_e\"}} <!-- results in: 'a/b/c/d/e' --> ", "example": "handlebars {{pathcase \"a-b-c d_e\"}} <!-- results in: 'a/b/c/d/e' --> ",
"description": "path/case the characters in `string`." "description": "<p>path/case the characters in <code>string</code>.</p>\n"
}, },
"plusify": { "plusify": {
"args": [ "args": [
@ -656,7 +656,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{plusify \"foo bar baz\"}} <!-- results in: 'foo+bar+baz' --> ", "example": "handlebars {{plusify \"foo bar baz\"}} <!-- results in: 'foo+bar+baz' --> ",
"description": "Replace spaces in the given string with pluses." "description": "<p>Replace spaces in the given string with pluses.</p>\n"
}, },
"prepend": { "prepend": {
"args": [ "args": [
@ -665,7 +665,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars <!-- given that \"val\" is \"bar\" --> {{prepend val \"foo-\"}} <!-- results in: 'foo-bar' --> ", "example": "handlebars <!-- given that \"val\" is \"bar\" --> {{prepend val \"foo-\"}} <!-- results in: 'foo-bar' --> ",
"description": "Prepends the given `string` with the specified `prefix`." "description": "<p>Prepends the given <code>string</code> with the specified <code>prefix</code>.</p>\n"
}, },
"raw": { "raw": {
"args": [ "args": [
@ -673,7 +673,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{{{#raw}}}} {{foo}} {{{{/raw}}}} <!-- results in: '{{foo}}' --> ", "example": "handlebars {{{{#raw}}}} {{foo}} {{{{/raw}}}} <!-- results in: '{{foo}}' --> ",
"description": "Render a block without processing mustache templates inside the block." "description": "<p>Render a block without processing mustache templates inside the block.</p>\n"
}, },
"remove": { "remove": {
"args": [ "args": [
@ -682,7 +682,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{remove \"a b a b a b\" \"a \"}} <!-- results in: 'b b b' --> ", "example": "handlebars {{remove \"a b a b a b\" \"a \"}} <!-- results in: 'b b b' --> ",
"description": "Remove all occurrences of `substring` from the given `str`." "description": "<p>Remove all occurrences of <code>substring</code> from the given <code>str</code>.</p>\n"
}, },
"removeFirst": { "removeFirst": {
"args": [ "args": [
@ -691,7 +691,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{remove \"a b a b a b\" \"a\"}} <!-- results in: ' b a b a b' --> ", "example": "handlebars {{remove \"a b a b a b\" \"a\"}} <!-- results in: ' b a b a b' --> ",
"description": "Remove the first occurrence of `substring` from the given `str`." "description": "<p>Remove the first occurrence of <code>substring</code> from the given <code>str</code>.</p>\n"
}, },
"replace": { "replace": {
"args": [ "args": [
@ -701,7 +701,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars {{replace \"a b a b a b\" \"a\" \"z\"}} <!-- results in: 'z b z b z b' --> ", "example": "handlebars {{replace \"a b a b a b\" \"a\" \"z\"}} <!-- results in: 'z b z b z b' --> ",
"description": "Replace all occurrences of substring `a` with substring `b`." "description": "<p>Replace all occurrences of substring <code>a</code> with substring <code>b</code>.</p>\n"
}, },
"replaceFirst": { "replaceFirst": {
"args": [ "args": [
@ -711,7 +711,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars {{replace \"a b a b a b\" \"a\" \"z\"}} <!-- results in: 'z b a b a b' --> ", "example": "handlebars {{replace \"a b a b a b\" \"a\" \"z\"}} <!-- results in: 'z b a b a b' --> ",
"description": "Replace the first occurrence of substring `a` with substring `b`." "description": "<p>Replace the first occurrence of substring <code>a</code> with substring <code>b</code>.</p>\n"
}, },
"sentence": { "sentence": {
"args": [ "args": [
@ -719,7 +719,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{sentence \"hello world. goodbye world.\"}} <!-- results in: 'Hello world. Goodbye world.' --> ", "example": "handlebars {{sentence \"hello world. goodbye world.\"}} <!-- results in: 'Hello world. Goodbye world.' --> ",
"description": "Sentence case the given string" "description": "<p>Sentence case the given string</p>\n"
}, },
"snakecase": { "snakecase": {
"args": [ "args": [
@ -727,7 +727,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{snakecase \"a-b-c d_e\"}} <!-- results in: 'a_b_c_d_e' --> ", "example": "handlebars {{snakecase \"a-b-c d_e\"}} <!-- results in: 'a_b_c_d_e' --> ",
"description": "snake_case the characters in the given `string`." "description": "<p>snake_case the characters in the given <code>string</code>.</p>\n"
}, },
"split": { "split": {
"args": [ "args": [
@ -735,7 +735,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{split \"a,b,c\" \",\"}} <!-- results in: ['a', 'b', 'c'] --> ", "example": "handlebars {{split \"a,b,c\" \",\"}} <!-- results in: ['a', 'b', 'c'] --> ",
"description": "Split `string` by the given `character`." "description": "<p>Split <code>string</code> by the given <code>character</code>.</p>\n"
}, },
"startsWith": { "startsWith": {
"args": [ "args": [
@ -745,7 +745,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars {{#startsWith \"Goodbye\" \"Hello, world!\"}} Whoops {{else}} Bro, do you even hello world? {{/startsWith}} ", "example": "handlebars {{#startsWith \"Goodbye\" \"Hello, world!\"}} Whoops {{else}} Bro, do you even hello world? {{/startsWith}} ",
"description": "Tests whether a string begins with the given prefix." "description": "<p>Tests whether a string begins with the given prefix.</p>\n"
}, },
"titleize": { "titleize": {
"args": [ "args": [
@ -753,7 +753,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{titleize \"this title case\"}} <!-- results in: 'This Is Title Case' --> ", "example": "handlebars {{titleize \"this title case\"}} <!-- results in: 'This Is Title Case' --> ",
"description": "Title case the given string." "description": "<p>Title case the given string.</p>\n"
}, },
"trim": { "trim": {
"args": [ "args": [
@ -761,7 +761,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{trim \" ABC \"}} <!-- results in: 'ABC' --> ", "example": "handlebars {{trim \" ABC \"}} <!-- results in: 'ABC' --> ",
"description": "Removes extraneous whitespace from the beginning and end of a string." "description": "<p>Removes extraneous whitespace from the beginning and end of a string.</p>\n"
}, },
"trimLeft": { "trimLeft": {
"args": [ "args": [
@ -769,7 +769,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{trim \" ABC \"}} <!-- results in: 'ABC ' --> ", "example": "handlebars {{trim \" ABC \"}} <!-- results in: 'ABC ' --> ",
"description": "Removes extraneous whitespace from the beginning of a string." "description": "<p>Removes extraneous whitespace from the beginning of a string.</p>\n"
}, },
"trimRight": { "trimRight": {
"args": [ "args": [
@ -777,7 +777,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{trimRight \" ABC \"}} <!-- results in: ' ABC' --> ", "example": "handlebars {{trimRight \" ABC \"}} <!-- results in: ' ABC' --> ",
"description": "Removes extraneous whitespace from the end of a string." "description": "<p>Removes extraneous whitespace from the end of a string.</p>\n"
}, },
"truncate": { "truncate": {
"args": [ "args": [
@ -787,7 +787,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars truncate(\"foo bar baz\", 7); <!-- results in: 'foo bar' --> truncate(sanitize(\"<span>foo bar baz</span>\", 7)); <!-- results in: 'foo bar' --> ", "example": "handlebars truncate(\"foo bar baz\", 7); <!-- results in: 'foo bar' --> truncate(sanitize(\"<span>foo bar baz</span>\", 7)); <!-- results in: 'foo bar' --> ",
"description": "Truncate a string to the specified `length`. Also see [ellipsis](#ellipsis)." "description": "<p>Truncate a string to the specified <code>length</code>. Also see <a href=\"#ellipsis\">ellipsis</a>.</p>\n"
}, },
"truncateWords": { "truncateWords": {
"args": [ "args": [
@ -797,7 +797,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars truncateWords(\"foo bar baz\", 1); <!-- results in: 'foo…' --> truncateWords(\"foo bar baz\", 2); <!-- results in: 'foo bar…' --> truncateWords(\"foo bar baz\", 3); <!-- results in: 'foo bar baz' --> ", "example": "handlebars truncateWords(\"foo bar baz\", 1); <!-- results in: 'foo…' --> truncateWords(\"foo bar baz\", 2); <!-- results in: 'foo bar…' --> truncateWords(\"foo bar baz\", 3); <!-- results in: 'foo bar baz' --> ",
"description": "Truncate a string to have the specified number of words. Also see [truncate](#truncate)." "description": "<p>Truncate a string to have the specified number of words. Also see <a href=\"#truncate\">truncate</a>.</p>\n"
}, },
"upcase": { "upcase": {
"args": [ "args": [
@ -805,7 +805,7 @@
], ],
"numArgs": 1, "numArgs": 1,
"example": "handlebars {{upcase \"aBcDeF\"}} <!-- results in: 'ABCDEF' --> ", "example": "handlebars {{upcase \"aBcDeF\"}} <!-- results in: 'ABCDEF' --> ",
"description": "Uppercase all of the characters in the given string. Alias for [uppercase](#uppercase)." "description": "<p>Uppercase all of the characters in the given string. Alias for <a href=\"#uppercase\">uppercase</a>.</p>\n"
}, },
"uppercase": { "uppercase": {
"args": [ "args": [
@ -814,7 +814,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{uppercase \"aBcDeF\"}} <!-- results in: 'ABCDEF' --> ", "example": "handlebars {{uppercase \"aBcDeF\"}} <!-- results in: 'ABCDEF' --> ",
"description": "Uppercase all of the characters in the given string. If used as a block helper it will uppercase the entire block. This helper does not support inverse blocks." "description": "<p>Uppercase all of the characters in the given string. If used as a block helper it will uppercase the entire block. This helper does not support inverse blocks.</p>\n"
} }
}, },
"comparison": { "comparison": {
@ -826,7 +826,7 @@
], ],
"numArgs": 3, "numArgs": 3,
"example": "handlebars <!-- {great: true, magnificent: true} --> {{#and great magnificent}}A{{else}}B{{/and}} <!-- results in: 'A' --> ", "example": "handlebars <!-- {great: true, magnificent: true} --> {{#and great magnificent}}A{{else}}B{{/and}} <!-- results in: 'A' --> ",
"description": "Helper that renders the block if **both** of the given values are truthy. If an inverse block is specified it will be rendered when falsy. Works as a block helper, inline helper or subexpression." "description": "<p>Helper that renders the block if <strong>both</strong> of the given values are truthy. If an inverse block is specified it will be rendered when falsy. Works as a block helper, inline helper or subexpression.</p>\n"
}, },
"compare": { "compare": {
"args": [ "args": [
@ -836,7 +836,7 @@
"options" "options"
], ],
"numArgs": 4, "numArgs": 4,
"description": "Render a block when a comparison of the first and third arguments returns true. The second argument is the [arithemetic operator][operators] to use. You may also optionally specify an inverse block to render when falsy." "description": "<p>Render a block when a comparison of the first and third arguments returns true. The second argument is the [arithemetic operator][operators] to use. You may also optionally specify an inverse block to render when falsy.</p>\n"
}, },
"contains": { "contains": {
"args": [ "args": [
@ -847,7 +847,7 @@
], ],
"numArgs": 4, "numArgs": 4,
"example": "handlebars <!-- array = ['a', 'b', 'c'] --> {{#contains array \"d\"}} This will not be rendered. {{else}} This will be rendered. {{/contains}} ", "example": "handlebars <!-- array = ['a', 'b', 'c'] --> {{#contains array \"d\"}} This will not be rendered. {{else}} This will be rendered. {{/contains}} ",
"description": "Block helper that renders the block if `collection` has the given `value`, using strict equality (`===`) for comparison, otherwise the inverse block is rendered (if specified). If a `startIndex` is specified and is negative, it is used as the offset from the end of the collection." "description": "<p>Block helper that renders the block if <code>collection</code> has the given <code>value</code>, using strict equality (<code>===</code>) for comparison, otherwise the inverse block is rendered (if specified). If a <code>startIndex</code> is specified and is negative, it is used as the offset from the end of the collection.</p>\n"
}, },
"default": { "default": {
"args": [ "args": [
@ -855,7 +855,7 @@
"defaultValue" "defaultValue"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Returns the first value that is not undefined, otherwise the \"default\" value is returned." "description": "<p>Returns the first value that is not undefined, otherwise the &quot;default&quot; value is returned.</p>\n"
}, },
"eq": { "eq": {
"args": [ "args": [
@ -864,7 +864,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that renders a block if `a` is **equal to** `b`. If an inverse block is specified it will be rendered when falsy. You may optionally use the `compare=\"\"` hash argument for the second value." "description": "<p>Block helper that renders a block if <code>a</code> is <strong>equal to</strong> <code>b</code>. If an inverse block is specified it will be rendered when falsy. You may optionally use the <code>compare=&quot;&quot;</code> hash argument for the second value.</p>\n"
}, },
"gt": { "gt": {
"args": [ "args": [
@ -873,7 +873,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that renders a block if `a` is **greater than** `b`. If an inverse block is specified it will be rendered when falsy. You may optionally use the `compare=\"\"` hash argument for the second value." "description": "<p>Block helper that renders a block if <code>a</code> is <strong>greater than</strong> <code>b</code>. If an inverse block is specified it will be rendered when falsy. You may optionally use the <code>compare=&quot;&quot;</code> hash argument for the second value.</p>\n"
}, },
"gte": { "gte": {
"args": [ "args": [
@ -882,7 +882,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that renders a block if `a` is **greater than or equal to** `b`. If an inverse block is specified it will be rendered when falsy. You may optionally use the `compare=\"\"` hash argument for the second value." "description": "<p>Block helper that renders a block if <code>a</code> is <strong>greater than or equal to</strong> <code>b</code>. If an inverse block is specified it will be rendered when falsy. You may optionally use the <code>compare=&quot;&quot;</code> hash argument for the second value.</p>\n"
}, },
"has": { "has": {
"args": [ "args": [
@ -891,7 +891,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that renders a block if `value` has `pattern`. If an inverse block is specified it will be rendered when falsy." "description": "<p>Block helper that renders a block if <code>value</code> has <code>pattern</code>. If an inverse block is specified it will be rendered when falsy.</p>\n"
}, },
"isFalsey": { "isFalsey": {
"args": [ "args": [
@ -899,7 +899,7 @@
"options" "options"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Returns true if the given `value` is falsey. Uses the [falsey][] library for comparisons. Please see that library for more information or to report bugs with this helper." "description": "<p>Returns true if the given <code>value</code> is falsey. Uses the [falsey][] library for comparisons. Please see that library for more information or to report bugs with this helper.</p>\n"
}, },
"isTruthy": { "isTruthy": {
"args": [ "args": [
@ -907,7 +907,7 @@
"options" "options"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Returns true if the given `value` is truthy. Uses the [falsey][] library for comparisons. Please see that library for more information or to report bugs with this helper." "description": "<p>Returns true if the given <code>value</code> is truthy. Uses the [falsey][] library for comparisons. Please see that library for more information or to report bugs with this helper.</p>\n"
}, },
"ifEven": { "ifEven": {
"args": [ "args": [
@ -916,7 +916,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{#ifEven value}} render A {{else}} render B {{/ifEven}} ", "example": "handlebars {{#ifEven value}} render A {{else}} render B {{/ifEven}} ",
"description": "Return true if the given value is an even number." "description": "<p>Return true if the given value is an even number.</p>\n"
}, },
"ifNth": { "ifNth": {
"args": [ "args": [
@ -925,7 +925,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Conditionally renders a block if the remainder is zero when `a` operand is divided by `b`. If an inverse block is specified it will be rendered when the remainder is **not zero**." "description": "<p>Conditionally renders a block if the remainder is zero when <code>a</code> operand is divided by <code>b</code>. If an inverse block is specified it will be rendered when the remainder is <strong>not zero</strong>.</p>\n"
}, },
"ifOdd": { "ifOdd": {
"args": [ "args": [
@ -934,7 +934,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{#ifOdd value}} render A {{else}} render B {{/ifOdd}} ", "example": "handlebars {{#ifOdd value}} render A {{else}} render B {{/ifOdd}} ",
"description": "Block helper that renders a block if `value` is **an odd number**. If an inverse block is specified it will be rendered when falsy." "description": "<p>Block helper that renders a block if <code>value</code> is <strong>an odd number</strong>. If an inverse block is specified it will be rendered when falsy.</p>\n"
}, },
"is": { "is": {
"args": [ "args": [
@ -943,7 +943,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that renders a block if `a` is **equal to** `b`. If an inverse block is specified it will be rendered when falsy. Similar to [eq](#eq) but does not do strict equality." "description": "<p>Block helper that renders a block if <code>a</code> is <strong>equal to</strong> <code>b</code>. If an inverse block is specified it will be rendered when falsy. Similar to <a href=\"#eq\">eq</a> but does not do strict equality.</p>\n"
}, },
"isnt": { "isnt": {
"args": [ "args": [
@ -952,7 +952,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that renders a block if `a` is **not equal to** `b`. If an inverse block is specified it will be rendered when falsy. Similar to [unlessEq](#unlesseq) but does not use strict equality for comparisons." "description": "<p>Block helper that renders a block if <code>a</code> is <strong>not equal to</strong> <code>b</code>. If an inverse block is specified it will be rendered when falsy. Similar to <a href=\"#unlesseq\">unlessEq</a> but does not use strict equality for comparisons.</p>\n"
}, },
"lt": { "lt": {
"args": [ "args": [
@ -960,7 +960,7 @@
"options" "options"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Block helper that renders a block if `a` is **less than** `b`. If an inverse block is specified it will be rendered when falsy. You may optionally use the `compare=\"\"` hash argument for the second value." "description": "<p>Block helper that renders a block if <code>a</code> is <strong>less than</strong> <code>b</code>. If an inverse block is specified it will be rendered when falsy. You may optionally use the <code>compare=&quot;&quot;</code> hash argument for the second value.</p>\n"
}, },
"lte": { "lte": {
"args": [ "args": [
@ -969,7 +969,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that renders a block if `a` is **less than or equal to** `b`. If an inverse block is specified it will be rendered when falsy. You may optionally use the `compare=\"\"` hash argument for the second value." "description": "<p>Block helper that renders a block if <code>a</code> is <strong>less than or equal to</strong> <code>b</code>. If an inverse block is specified it will be rendered when falsy. You may optionally use the <code>compare=&quot;&quot;</code> hash argument for the second value.</p>\n"
}, },
"neither": { "neither": {
"args": [ "args": [
@ -978,7 +978,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that renders a block if **neither of** the given values are truthy. If an inverse block is specified it will be rendered when falsy." "description": "<p>Block helper that renders a block if <strong>neither of</strong> the given values are truthy. If an inverse block is specified it will be rendered when falsy.</p>\n"
}, },
"not": { "not": {
"args": [ "args": [
@ -986,7 +986,7 @@
"options" "options"
], ],
"numArgs": 2, "numArgs": 2,
"description": "Returns true if `val` is falsey. Works as a block or inline helper." "description": "<p>Returns true if <code>val</code> is falsey. Works as a block or inline helper.</p>\n"
}, },
"or": { "or": {
"args": [ "args": [
@ -995,7 +995,7 @@
], ],
"numArgs": 2, "numArgs": 2,
"example": "handlebars {{#or a b c}} If any value is true this will be rendered. {{/or}} ", "example": "handlebars {{#or a b c}} If any value is true this will be rendered. {{/or}} ",
"description": "Block helper that renders a block if **any of** the given values is truthy. If an inverse block is specified it will be rendered when falsy." "description": "<p>Block helper that renders a block if <strong>any of</strong> the given values is truthy. If an inverse block is specified it will be rendered when falsy.</p>\n"
}, },
"unlessEq": { "unlessEq": {
"args": [ "args": [
@ -1004,7 +1004,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that always renders the inverse block **unless `a` is equal to `b`**." "description": "<p>Block helper that always renders the inverse block <strong>unless <code>a</code> is equal to <code>b</code></strong>.</p>\n"
}, },
"unlessGt": { "unlessGt": {
"args": [ "args": [
@ -1013,7 +1013,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that always renders the inverse block **unless `a` is greater than `b`**." "description": "<p>Block helper that always renders the inverse block <strong>unless <code>a</code> is greater than <code>b</code></strong>.</p>\n"
}, },
"unlessLt": { "unlessLt": {
"args": [ "args": [
@ -1022,7 +1022,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that always renders the inverse block **unless `a` is less than `b`**." "description": "<p>Block helper that always renders the inverse block <strong>unless <code>a</code> is less than <code>b</code></strong>.</p>\n"
}, },
"unlessGteq": { "unlessGteq": {
"args": [ "args": [
@ -1031,7 +1031,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that always renders the inverse block **unless `a` is greater than or equal to `b`**." "description": "<p>Block helper that always renders the inverse block <strong>unless <code>a</code> is greater than or equal to <code>b</code></strong>.</p>\n"
}, },
"unlessLteq": { "unlessLteq": {
"args": [ "args": [
@ -1040,7 +1040,7 @@
"options" "options"
], ],
"numArgs": 3, "numArgs": 3,
"description": "Block helper that always renders the inverse block **unless `a` is less than or equal to `b`**." "description": "<p>Block helper that always renders the inverse block <strong>unless <code>a</code> is less than or equal to <code>b</code></strong>.</p>\n"
} }
}, },
"date": { "date": {
@ -1050,8 +1050,8 @@
"format" "format"
], ],
"numArgs": 2, "numArgs": 2,
"example": "{{date \"5 years ago\" \"YYYY\"}}", "example": "{{date now \"YYYY\"}}",
"description": "Format a date using moment.js data formatting." "description": "<p>Format a date using moment.js data formatting.</p>\n"
} }
} }
} }

4
packages/string-templates/package.json
View File

@ -10,7 +10,8 @@
"scripts": { "scripts": {
"build": "tsc && rollup -c", "build": "tsc && rollup -c",
"dev:builder": "tsc && rollup -cw", "dev:builder": "tsc && rollup -cw",
"test": "jest" "test": "jest",
"manifest": "node ./scripts/gen-collection-info.js"
}, },
"dependencies": { "dependencies": {
"@budibase/handlebars-helpers": "^0.11.1", "@budibase/handlebars-helpers": "^0.11.1",
@ -24,6 +25,7 @@
"@rollup/plugin-json": "^4.1.0", "@rollup/plugin-json": "^4.1.0",
"doctrine": "^3.0.0", "doctrine": "^3.0.0",
"jest": "^26.6.3", "jest": "^26.6.3",
"marked": "^1.2.8",
"rollup": "^2.36.2", "rollup": "^2.36.2",
"rollup-plugin-node-builtins": "^2.1.2", "rollup-plugin-node-builtins": "^2.1.2",
"rollup-plugin-node-globals": "^1.4.0", "rollup-plugin-node-globals": "^1.4.0",

18
packages/string-templates/scripts/gen-collection-info.js
View File

@ -1,9 +1,13 @@
const helpers = require("handlebars-helpers") const HELPER_LIBRARY = "@budibase/handlebars-helpers"
const helpers = require(HELPER_LIBRARY)
const { HelperFunctionBuiltin } = require("../src/helpers/constants") const { HelperFunctionBuiltin } = require("../src/helpers/constants")
const fs = require("fs") const fs = require("fs")
const doctrine = require("doctrine") const doctrine = require("doctrine")
const marked = require("marked")
const FILENAME = "../manifest.json" const DIRECTORY = fs.existsSync("node_modules") ? "." : ".."
const FILENAME = `${DIRECTORY}/manifest.json`
/** /**
* full list of supported helpers can be found here: * full list of supported helpers can be found here:
@ -29,8 +33,6 @@ function fixSpecialCases(name, obj) {
if (name === "toInt") { if (name === "toInt") {
obj.description = "Convert input to an integer." obj.description = "Convert input to an integer."
} }
// add the date helper
obj
return obj return obj
} }
@ -91,7 +93,7 @@ function run() {
const foundNames = [] const foundNames = []
for (let collection of COLLECTIONS) { for (let collection of COLLECTIONS) {
const collectionFile = fs.readFileSync( const collectionFile = fs.readFileSync(
`../node_modules/handlebars-helpers/lib/${collection}.js`, `${DIRECTORY}/node_modules/${HELPER_LIBRARY}/lib/${collection}.js`,
"utf8" "utf8"
) )
const collectionInfo = {} const collectionInfo = {}
@ -138,6 +140,12 @@ function run() {
description: "Format a date using moment.js data formatting.", description: "Format a date using moment.js data formatting.",
}, },
} }
// convert all markdown to HTML
for (let collection of Object.values(outputJSON)) {
for (let helper of Object.values(collection)) {
helper.description = marked(helper.description)
}
}
fs.writeFileSync(FILENAME, JSON.stringify(outputJSON, null, 2)) fs.writeFileSync(FILENAME, JSON.stringify(outputJSON, null, 2))
} }

2
packages/string-templates/test/basic.spec.js
View File

@ -107,6 +107,6 @@ describe("check manifest", () => {
it("should be able to retrieve the manifest", () => { it("should be able to retrieve the manifest", () => {
const manifest = getManifest() const manifest = getManifest()
expect(manifest.math).not.toBeNull() expect(manifest.math).not.toBeNull()
expect(manifest.math.abs.description).toBe("Return the magnitude of `a`.") expect(manifest.math.abs.description).toBe("<p>Return the magnitude of <code>a</code>.</p>\n")
}) })
}) })

2
packages/string-templates/test/helpers.spec.js
View File

@ -167,7 +167,7 @@ describe("test the date helpers", () => {
it("should allow use of the date helper with now time", async () => { it("should allow use of the date helper with now time", async () => {
const date = new Date() const date = new Date()
const output = await processString("{{ date now 'DD' }}", {}) const output = await processString("{{ date now 'DD' }}", {})
expect(output).toBe(date.getDate().toString()) expect(parseInt(output)).toBe(date.getDate())
}) })
}) })

7
packages/string-templates/yarn.lock
View File

@ -270,7 +270,7 @@
resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39" resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39"
integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw== integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==
"@budibase/handlebars-helpers@^0.11.0": "@budibase/handlebars-helpers@^0.11.1":
version "0.11.1" version "0.11.1"
resolved "https://registry.yarnpkg.com/@budibase/handlebars-helpers/-/handlebars-helpers-0.11.1.tgz#fe8672612fb4ad8fd3bad338ee15759f45e421eb" resolved "https://registry.yarnpkg.com/@budibase/handlebars-helpers/-/handlebars-helpers-0.11.1.tgz#fe8672612fb4ad8fd3bad338ee15759f45e421eb"
integrity sha512-s72LhOhlHk43QYGVcqjogaGa4h4e6y6X1AfshqWBWceTRYBs/9tUnoYDUiRJ/Mt3WoTmx8Hj5GOZekSqrUsOFQ== integrity sha512-s72LhOhlHk43QYGVcqjogaGa4h4e6y6X1AfshqWBWceTRYBs/9tUnoYDUiRJ/Mt3WoTmx8Hj5GOZekSqrUsOFQ==
@ -3419,6 +3419,11 @@ map-visit@^1.0.0:
dependencies: dependencies:
object-visit "^1.0.0" object-visit "^1.0.0"
marked@^1.2.8:
version "1.2.8"
resolved "https://registry.yarnpkg.com/marked/-/marked-1.2.8.tgz#5008ece15cfa43e653e85845f3525af4beb6bdd4"
integrity sha512-lzmFjGnzWHkmbk85q/ILZjFoHHJIQGF+SxGEfIdGk/XhiTPhqGs37gbru6Kkd48diJnEyYwnG67nru0Z2gQtuQ==
md5.js@^1.3.4: md5.js@^1.3.4:
version "1.3.5" version "1.3.5"
resolved "https://registry.yarnpkg.com/md5.js/-/md5.js-1.3.5.tgz#b5d07b8e3216e3e27cd728d72f70d1e6a342005f" resolved "https://registry.yarnpkg.com/md5.js/-/md5.js-1.3.5.tgz#b5d07b8e3216e3e27cd728d72f70d1e6a342005f"