ember-cli-string-helpers

ember-cli-string-helpers

String helpers for Ember. Extracted from the great DockYard's ember-composable-helpers.

[!WARNING]
If you are using single file components you most likely do not need this addon as it's just a wrapper on @ember/string methods. You can import most methods directly from @ember/string in your components, or migrate to something like change-case.

Compatibility

• Ember.js v3.28 or above
• Ember CLI v4.4 or above
• Node.js v20 or above

Installation

ember install ember-cli-string-helpers

Available helpers

• ember-cli-string-helpers
  • Compatibility
  • Installation
  • Available helpers
  • Usage
    • camelize
    • capitalize
    • classify
    • dasherize
    • html-safe
    • humanize
    • lowercase
    • titleize
    • trim
    • truncate
    • underscore
    • uppercase
    • w
  • Glint usage
  • Template Tag usage
  • See also
  • License

Usage

camelize

Camelizes a string using Ember.String.camelize.

{{camelize "hello jim bob"}}
{{camelize stringWithDashes}}

Output: helloJimBob

⬆️ back to top

capitalize

Capitalizes a string using Ember.String.capitalize.

{{capitalize "hello jim bob"}}
{{capitalize fullName}}

Output: Hello jim bob

⬆️ back to top

classify

Classifies a string using Ember.String.classify.

{{classify "hello jim bob"}}
{{classify stringWithDashes}}

Output: HelloJimBob

⬆️ back to top

dasherize

Dasherizes a string using Ember.String.dasherize.

{{dasherize "whatsThat"}}
{{dasherize phrase}}

Output: whats-that

⬆️ back to top

html-safe

Mark a string as safe for unescaped output with Ember templates using Ember.String.htmlSafe.

{{html-safe "<div>someString</div>"}}
{{html-safe unsafeString}}

⬆️ back to top

humanize

Removes dashes and underscores from a string, capitalizes the first letter and makes the rest of the string lower case.

{{humanize "some-string"}}
{{humanize phrase}}

Output: Some string

⬆️ back to top

lowercase

Lowercases a string.

{{lowercase "People Person's Paper People"}}
{{lowercase phrase}}

Output: people person's paper people

⬆️ back to top

titleize

Capitalizes every word separated by a white space or a dash.

{{titleize "my big fat greek wedding"}}
{{titleize phrase}}

Output: My Big Fat Greek Wedding

⬆️ back to top

trim

Trim a string.

{{trim "  Lorem ipsum dolor sit amet, consectetur adipiscing elit.   "}}
{{trim phrase}}

Output: Lorem ipsum dolor sit amet, consectetur adipiscing elit.

truncate

Truncates a string with a characterLimit and optionally adds an ellipsis to the end.

{{truncate "Lorem ipsum dolor sit amet, consectetur adipiscing elit." 20 true}}
{{truncate phrase characterLimit useEllipsis}}

Output: Lorem ipsum dolor...

⬆️ back to top

underscore

Underscores a string using Ember.String.underscore.

{{underscore "whatsThat"}}
{{underscore phrase}}

Output: whats_that

⬆️ back to top

uppercase

Uppercases a string.

{{uppercase "loud noises"}}
{{uppercase phrase}}

Output: LOUD NOISES

⬆️ back to top

w

Splits a string on whitespace and/or turns multiple words into an array.

{{#each (w "First" "Second" "Last") as |rank|}}
  Our {{rank}} place winner is ...
{{/each}}

or:

{{#each (w "First Second Last") as |rank|}}
  Our {{rank}} place winner is ...
{{/each}}

See also: Ember w documentation

⬆️ back to top

Glint usage

If you are using Glint and environment-ember-loose, you can add all the helpers to your app at once by adding

import type EmberCliStringHelpersRegistry from 'ember-cli-string-helpers/template-registry';

to your app's e.g. types/glint.d.ts file, and making sure your registry extends from EmberCliStringHelpersRegistry:

declare module '@glint/environment-ember-loose/registry' {
  export default interface Registry
    extends EmberCliStringHelpersRegistry {
      // ...
    }
}

Template Tag usage

import { camelize } from 'ember-cli-string-helpers';

<template>
  {{camelize "hello jim bob"}}
</template>

See also

• ember-composable-helpers
• ember-math-helpers
• ember-truth-helpers

License

This project is licensed under the MIT License.