Package Exports

@directus/format-title

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@directus/format-title) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

format-title

Custom string formatter that converts any string into Title Case

This package converts any string into title case. This means only using capital letters for the principal words. Articles, conjunctions, and prepositions do not get capital letters unless they start the title

input	output
`snowWhiteAndTheSevenDwarfs`	Snow White and the Seven Dwarfs
`NewcastleUponTyne`	Newcastle upon Tyne
`brighton_on_sea`	Brighton on Sea
`apple_releases_new_ipad`	Apple Releases New iPad

Bonus: the package also handles specially-cased words such as iPad, PDFs, or McDonalds

Installation

$ npm install @directus/format-title

Usage

The package by default converts camelCase, PascalCase, underscore, and "regular" scentences to Title Case

formatTitle(string, [separator]);

formatTitle('snowWhiteAndTheSevenDwarfs');
// => Snow White and the Seven Dwarfs

You can provide an optional separator regex as a second parameter to support splitting the string on different characters. By default, this regex is set to /\s|-|_/g.

Contributing

If your favorite specially cased word isn't being capitalized properly, please open an issue or submit a pull request on the repo that contains those words!

License

MIT License