https://github.com/brendt/php-sparkline

Generate GitHub style sparkline graphs with PHP
https://github.com/brendt/php-sparkline

Last synced: about 6 hours ago
JSON representation

Generate GitHub style sparkline graphs with PHP

• Host: GitHub
• URL: https://github.com/brendt/php-sparkline
• Owner: brendt
• License: mit
• Created: 2022-12-08T05:01:59.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-03T04:56:59.000Z (5 months ago)
• Last Synced: 2025-02-14T09:15:14.788Z (7 days ago)
• Language: PHP
• Homepage:
• Size: 216 KB
• Stars: 352
• Watchers: 6
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Generate sparkline SVGs in PHP

[![Latest Version on Packagist](https://img.shields.io/packagist/v/brendt/php-sparkline.svg?style=flat-square)](https://packagist.org/packages/brendt/php-sparkline)

[![Tests](https://github.com/brendt/php-sparkline/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/brendt/php-sparkline/actions/workflows/run-tests.yml)

[![Total Downloads](https://img.shields.io/packagist/dt/brendt/php-sparkline.svg?style=flat-square)](https://packagist.org/packages/brendt/php-sparkline)

PHP-Sparkline generates GitHub style sparkline graphs. Read this guide to know how to use it.

## Installation

You can install the package via composer:

```bash

composer require brendt/php-sparkline

```

## Usage

```php

$sparkLine = new SparkLine(1, 2, 5, 10, 2);

$total = $sparkLine->getTotal();

$svg = $sparkLine->make();

```

![](./.github/img/0.png)

To construct a sparkline, you'll have to pass in an array of values.

### Customization

You can pick any amount of colors and the sparkline will automatically generate a gradient from them:

```php

$sparkLine = (new SparkLine($days))->withColors('#4285F4', '#31ACF2', '#2BC9F4');

```

![](./.github/img/1.png)

You can configure the stroke width:

```php

$sparkLine = (new SparkLine($days))->withStrokeWidth(4);

```

As well as the dimensions (in pixels):

```php

$sparkLine = SparkLine::new($days)->withDimensions(width: 500, height: 100);

```

![](./.github/img/2.png)

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Brent Roose](https://github.com/brendt)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.