From 4a362f9cffeb768c593a2cebeeab6a443ab88c12 Mon Sep 17 00:00:00 2001 From: z-song Date: Wed, 26 Sep 2018 01:12:32 +0800 Subject: [PATCH] update --- README.md | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++- composer.json | 2 +- 2 files changed, 98 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 064b073..df1cce3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,100 @@ Use jQuery Sparkline in laravel-admin ====== -Under development \ No newline at end of file +## Screenshots + +![qq20180926-010814](https://user-images.githubusercontent.com/1479100/46030513-edf66280-c128-11e8-9589-13adb73f432a.png) + +![qq20180926-010742](https://user-images.githubusercontent.com/1479100/46030524-f9498e00-c128-11e8-8acb-4e85a0f58ba7.png) + +## Installation + +```bash +composer require laravel-admin-ext/sparkline + +php artisan vendor:publish --tag=laravel-admin-sparkline +``` + +## Configuration + +Open `config/admin.php`, add configurations that belong to this extension at `extensions` section. + +```php + + 'extensions' => [ + + 'sparkline' => [ + + // Set to `false` if you want to disable this extension + 'enable' => true, + ] + ] + +``` + +## Usage + +### Use as chart panel + +Create a view in views directory like `resources/views/admin/sparkline/bar.blade.php`, and add following codes: + +```html +
+
+
+ +``` + +Then show it on the page + +```php +class SparklineController extends Controller +{ + public function index(Content $content) + { + return $content + ->header('jQuery sparkline') + ->body(new Box('Bar chart', view('admin.sparkline.bar'))); + } +} +``` + +For more usage, please refer to the official [Documentation](https://omnipotent.net/jquery.sparkline) of jQuery sparkline. + +### Use in grid column + +If column `scores` returns a value with array type, and you wants to display this column as a inline line graphs + +```php +$grid->scores()->sparkline('line'); + +// add options +$grid->scores()->sparkline('line', [ + 'width' => 100, + 'spotRadius' => 2 +]); +``` +There are also 6 other chart types such as `bar`, `pie`,`box`,`tristate`,`bullet`,`discrete`, and all options can be found in official [Documentation](https://omnipotent.net/jquery.sparkline) of jQuery sparkline. + +## Donate + +> Help keeping the project development going, by donating a little. Thanks in advance. + +[![PayPal Me](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/zousong) + +![-1](https://cloud.githubusercontent.com/assets/1479100/23287423/45c68202-fa78-11e6-8125-3e365101a313.jpg) + +License +------------ +Licensed under [The MIT License (MIT)](LICENSE). \ No newline at end of file diff --git a/composer.json b/composer.json index 1cc535c..39dd859 100644 --- a/composer.json +++ b/composer.json @@ -13,7 +13,7 @@ ], "require": { "php": ">=7.0.0", - "encore/laravel-admin": "*" + "encore/laravel-admin": "~1.6" }, "require-dev": { "phpunit/phpunit": "~6.0"