oncology-support/sparkline-bundle

Symfony Bundle that ease the use of Davaxi/Sparkline to display sparkline graphs in your app

2.3.2 2024-02-11 22:42 UTC

Requires

• php: >=8.2
• davaxi/sparkline: ^2.2
• symfony/config: ^6.0 || ^7.0
• symfony/dependency-injection: ^6.0 || ^7.0
• symfony/flex: ^2.3
• symfony/http-kernel: ^6.0 || ^7.0
• symfony/yaml: ^6.0 || ^7.0
• twig/twig: ^2.10 || ^3.0

Requires (Dev)

• nyholm/symfony-bundle-test: ^1.6.1
• symfony/framework-bundle: ^4.4 || ^5.0 || ^6.0 || ^7.0
• symfony/phpunit-bridge: ^4.4 || ^5.0 || ^6.0 || ^7.0

MIT

• Ernest Hymel

• symfony
• graph
• chart
• charts
• graphs
• sparkline
• davaxi

README

SparklineBundle eases the use of the excellent/handy Davaxi/Sparkline php library in your Symfony application by providing a Twig extension to do the work.

Documentation

License

SparklineBundle is released under the MIT License. See the bundled LICENSE file for details.

Installation

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

composer require oncology-support/sparkline-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require oncology-support/sparkline-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    OncologySupport\Sparkline\OncologySupportSparklineBundle::class => ['all' => true],
];

Step 3: Use it!

This bundle allows you to insert a sparkline graph directly into your twig templates by passing an array of values that will be inserted into a sparkline graph. Note the use of the |raw pipe function! This is important.

// your twig template

{{ sparkline(<array of data>)|raw }}

For example, for dataset [2,3,10,8,23,14,9,12,0,0,14] the twig line:,

// your twig template

{{ sparkline([2,3,10,8,23,14,9,12,0,0,14])|raw }}

will insert a sparkline image like so:

In the future I may add the ability to pass options to modify the appearance of the graph.

Enjoy!