From 9b74d45a861f862c536f99176f78db02e3b4fbf9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Santib=C3=A1=C3=B1ez?= Date: Mon, 2 Nov 2020 22:01:02 -0500 Subject: [PATCH] Updated README --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 56559de..6d4886c 100755 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ This package requires the following packages/libraries to work: Please follow each package/library instructions on how to set them properly in your project. -> Note: At the moment, `Apex Charts` is only supported for drawing charts. +>Note: At the moment, `Apex Charts` is only supported for drawing charts. ## Usage @@ -52,7 +52,7 @@ $columnChartModel = ; ``` -> Note: Chart model methods are chainable 💪 +>Note: Chart model methods are chainable 💪 With `$columnChartModel` at hand, we pass it to our `LivewireColumnChart` component in our Blade template. @@ -66,8 +66,8 @@ And that's it! You have a beautiful rendered chart in seconds. 👌 ![column chart example](https://github.com/asantibanez/livewire-charts/raw/master/column-chart-example.png) -> Note: You can use these charts inside other Livewire components too. Just render them in your Blade template and you -are good to go. 👍 +>Note: You can use these charts inside other Livewire components too. Just render them in your Blade template and you +are good to go. 👍 ## Enabling Interactions @@ -168,6 +168,19 @@ for each type of chart. | setXAxisVisible(boolean $visible) | Shows/hides xAxis labels | | setYAxisVisible(boolean $visible) | Shows/hides yAxis labels | +## Troubleshooting + +Chart components must be placed inside a container with fixed height. This is because the chart will use all the given +vertical space. A fixed height is needed to render properly. + + ```blade +
+ +
+ ``` + +>Note: if a fixed height is not given, the chart will grow vertically infinitely. That's not what we want, right? + ## Testing ``` bash