/truncatemodule

Craft CMS 3 | Basic truncate text module

Primary LanguagePHPMIT LicenseMIT

Truncate module for Craft CMS 3.x

Module to truncate text

Requirements

This module requires Craft CMS 3.0.0-RC1 or later.

Installation

To install the module, follow these instructions.

First, you'll need to add the contents of the app.php file to your config/app.php (or just copy it there if it does not exist). This ensures that your module will get loaded for each request. The file might look something like this:

return [
    'modules' => [
        'truncate-module' => [
            'class' => \modules\truncatemodule\TruncateModule::class,
        ],
    ],
    'bootstrap' => ['truncate-module'],
];

You'll also need to make sure that you add the following to your project's composer.json file so that Composer can find your module:

"autoload": {
    "psr-4": {
      "modules\\truncatemodule\\": "modules/truncatemodule/src/"
    }
},

After you have added this, you will need to do:

composer dump-autoload

…from the project’s root directory, to rebuild the Composer autoload map. This will happen automatically any time you do a composer install or composer update as well.

Using Truncate

Filter

{{ string|truncate }}
{{ string|truncate(160, '…') }}

Function

{% filter truncate %}
    {{ string }}
{% endfilter %}

Truncate Roadmap

Some things to do, and ideas for potential features:

  • Release it

Brought to you by Everything is Fun