PHPackages                             punktde/neos-hyphenation - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. punktde/neos-hyphenation

ActiveNeos-package[Utility &amp; Helpers](/categories/utility)

punktde/neos-hyphenation
========================

Neos Eel Helper package for hyphenating Text

1.2.0(6y ago)59901[1 issues](https://github.com/punktDe/neos-hyphenation/issues)MITPHP

Since Aug 23Pushed 6y ago5 watchersCompare

[ Source](https://github.com/punktDe/neos-hyphenation)[ Packagist](https://packagist.org/packages/punktde/neos-hyphenation)[ RSS](/packages/punktde-neos-hyphenation/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (1)Versions (7)Used By (0)

Neos Package for hyphenating text output
========================================

[](#neos-package-for-hyphenating-text-output)

This package is licensed under the MIT license, please view the LICENSE file.

Since automatic hyphenation support by browsers can be described as inconsistent at best and might lead to techincally correct but ugly results, this package provides an Eel helper, which can hyphenate text with soft-hyphens (`&:shy;`) in a consistent and configurable manner. The Eel helper calls a node.js CLI app, which uses the [Hypher](https://github.com/bramstein/hypher) node module and [hyphenation pattern files](https://github.com/bramstein/hyphenation-patterns) to do the initial hyphenation. Once a word is hyphenated, the result is cached and the word will be served from the cache instead of calling the node.js app every time it occurs.

Installation
------------

[](#installation)

**Install the package:**

```
composer require punktde/neos-hyphenation

```

**Install the node.js app and its dependencies:**

Please make sure you have node.js (this app is tested on node.js 8.0.0 and newer) and npm installed. Navigate to the `Resources/Private/Library` directory of this package, where the JavaScript app lives, and install it. Please make sure the `index.js` file has its executability flag set:

```
cd Resources/Private/Library
npm install

#if necessary
chmod +x index.js

```

**Configure caching in your project:**

You might specify a different cache backend and cache lifetime in the `Caches.yaml`file. The first page hit will be very slow, but once most of the long words are in the cache, it will be quite performant.

Usage
-----

[](#usage)

This package provides the Eel Helper `Hyphenation.hyphenateText(string )`, which takes a string as an argument and returns a hyphenated version of this string.

Configuration options
---------------------

[](#configuration-options)

**Minimum word length and padding:**

Users can configure a minimum padding at `PunktDe:Neos:Hyphenation:minimumPadding:`in the `Settings.yaml` file. This is an offset which is applied from both ends of the word wherein no hyphenation can occur. Adjust this to ensure a nice and consistent look of the text, e.g. avoiding linebreaks after just one syllable which might look a bit silly in long words. To save resources, the Eel Helper will only call hyphenation on words which are at least twice as long as the minimum padding, since only those are eligible for hyphenation in the first place. The default value is `4`.

**Language/pattern file used for hyphenation:**

The pattern file can be specified in the `Resources/Private/Library/package.json` file or by running `npm install --save ` in the `Resources/Private/Library` directory. Furthermore, it needs to be specified in the `index.js` app in line 4:

```
 var language = require('');
 //replace  with the "name" from the language package's package.json file

```

Please run `npm install` in the Library directory afterwards. The default language package is german.

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity23

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~202 days

Total

4

Last Release

2217d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0fad3b9ab04057e586b701aca7a8dbbf9598718114cdfd6bf85dada030f7688e?d=identicon)[punktde](/maintainers/punktde)

---

Top Contributors

[![p-weisk](https://avatars.githubusercontent.com/u/28752561?v=4)](https://github.com/p-weisk "p-weisk (3 commits)")[![c4ll-m3-j4ck](https://avatars.githubusercontent.com/u/7119811?v=4)](https://github.com/c4ll-m3-j4ck "c4ll-m3-j4ck (2 commits)")[![daniellienert](https://avatars.githubusercontent.com/u/642226?v=4)](https://github.com/daniellienert "daniellienert (2 commits)")

---

Tags

eelhyphenationneoscms

### Embed Badge

![Health badge](/badges/punktde-neos-hyphenation/health.svg)

```
[![Health](https://phpackages.com/badges/punktde-neos-hyphenation/health.svg)](https://phpackages.com/packages/punktde-neos-hyphenation)
```

###  Alternatives

[sitegeist/monocle

An living-styleguide for Neos that is based on the actual fusion-code

45315.9k10](/packages/sitegeist-monocle)[sitegeist/kaleidoscope

Responsive-images for Neos

29352.4k10](/packages/sitegeist-kaleidoscope)[flowpack/listable

Tiny extension for listing things

35209.0k7](/packages/flowpack-listable)[kaufmanndigital/gdpr-cookieconsent

A ready-to-run package, that integrates an advanced cookie consent banner into your Neos CMS site.

2540.7k](/packages/kaufmanndigital-gdpr-cookieconsent)[neos/seo

SEO configuration and tools for Neos

13990.5k24](/packages/neos-seo)[shel/neos-colorpicker

A plugin for Neos CMS which provides a colorpicker editor

1494.4k6](/packages/shel-neos-colorpicker)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
