Skip to content

Easily bulld and render Chart.js charts with PHP and Fluid

License

Notifications You must be signed in to change notification settings

dauskonzept/typo3-ux-chartjs

Repository files navigation

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.

About

Easily bulld and render Chart.js charts with PHP and Fluid

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages