Skip to main content Link Search Menu Expand Document Toggle dark mode Copy Code (external link)

contains() : Check if String Contains Substring

Check if a string contains a specified substring.

On this page

Signature

contains(str, search)

Parameters

Parameter Type Required Description
str String Yes The string to search in
search String Yes The substring to search for

Returns

Type: Boolean

true if the substring is found, false otherwise.

Examples

{{#if contains(model.description, 'premium')}}
  <span class="badge-premium">Premium Product</span>
{{/if}}

Data:

doc.Params["model"] = new {
    description = "This is a premium quality product"
};

Output:

<span class="badge-premium">Premium Product</span>

Filter Items

{{#each model.products}}
  {{#if contains(this.name, 'Pro')}}
    <div class="product-pro">
      <h3>{{this.name}}</h3>
      <span>Professional Edition</span>
    </div>
  {{/if}}
{{/each}}

Data:

doc.Params["model"] = new {
    products = new[] {
        new { name = "Widget" },
        new { name = "Widget Pro" },
        new { name = "Gadget Pro Max" }
    }
};

Output:

<div class="product-pro">
  <h3>Widget Pro</h3>
  <span>Professional Edition</span>
</div>
<div class="product-pro">
  <h3>Gadget Pro Max</h3>
  <span>Professional Edition</span>
</div>

Keyword Highlighting

{{#each model.items}}
  {{#if contains(toLower(this.title), toLower(model.searchTerm))}}
    <div class="search-result">
      <h4>{{this.title}}</h4>
      <p>{{this.description}}</p>
    </div>
  {{/if}}
{{/each}}

Email Validation

{{#if contains(model.email, '@')}}
  <p>Email: {{model.email}}</p>
{{else}}
  <p class="error">Invalid email format</p>
{{/if}}

Data:

doc.Params["model"] = new {
    email = "user@example.com"
};

Output:

<p>Email: user@example.com</p>

Notes

  • Case-sensitive by default
  • Returns false if search string is not found
  • Empty search string returns true
  • For case-insensitive search, use with toLower(): contains(toLower(str), toLower(search))
  • For position information, use indexOf()
  • Returns false for null values

See Also