dskzpt/typo3-ux-chartjs

Easily build and render Chart.js charts in PHP and Fluid

1.0.0 2024-03-07 08:59 UTC

This package is auto-updated.

Last update: 2024-05-07 09:38:05 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License

TYPO3 Extension "typo3-ux-chartjs"

What does it do?

Easily build Chart.js in PHP and render them in Fluid templates.

It acts as a wrapper for symfony/ux-chartjs package.

Installation

The recommended way to install the extension is by using Composer. In your Composer based TYPO3 project root, just run:

composer require dskzpt/typo3-ux-chartjs

Setup

Before you start, make sure you have EXT:typo3_encore. This extensions integrates Webpack Encore into TYPO3.

Follow the Symfony UX Chart.js official documentation.

Additionally:

# Add this line to your package.json dependencies:
"@symfony/ux-chartjs": "file:vendor/symfony/ux-chartjs/assets",

# Install Chart.js
$ npm i chartjs

# or
$ yarn add chartjs

# Add these lines to your controllers.json:
"@symfony/ux-chartjs": {
    "chart": {
        "enabled": true,
        "fetch": "eager"
    }
},

# run
$ npm install --force
$ npm run watch

# or
$ yarn install --force
$ yarn watch

Usage

In any fluid template: Just register the Namespace and use the provided ViewHelper to render your chart:

<html xmlns:ux="http://typo3.org/ns/DSKZPT/UX/Chartjs/ViewHelpers">
    <ux:renderChart chart="{chart}" />
</html>

Please refer to the symfony/ux-chartjs docs for further information.

Contributing

Please refer to the contributing document included in this repository.