koffinate / laravel-metabase
Embed Metabase dashboard and question in your application
v1.0.4
2024-01-17 01:42 UTC
Requires
- php: ^8.1
- illuminate/support: ^8.0|^9.0|^10.0
- lcobucci/jwt: ^4.1
README
Blade component to embed metabase dashboard or question in your website. For more information about Metabase, please visit Metabase official website.
the original code was forked from Laravolt Metabase
Installation
composer require laravolt/metabase
Add following entries to config/services.php
:
'metabase' => [ 'url' => env('METABASE_URL'), 'secret' => env('METABASE_SECRET'), ],
And finally, update your .env
file:
METABASE_URL=https://metabase.example.com METABASE_SECRET=secret
Metabase secret key can be found in metabase settings page (only accessible by admin).
Visit https://www.metabase.com/docs/latest/administration-guide/13-embedding.html for more information.
Usage
<!-- embed dashboard --> <x-metabase dashboard="1"></x-metabase> <!-- embed question --> <x-metabase question="2"></x-metabase> <!-- passing html attributes --> <x-metabase question="2" width="80%" height="500px"></x-metabase> <!-- passing metabase parameters --> @php($params = ['category' => 'php']) <x-metabase dashboard="1" :params="$params"></x-metabase> // BEWARE of the colon in ":params" (not "param") because we are passing array variable directly to the component <!-- passing additional metabase parameters --> <x-metabase dashboard="1" :params="$params" :bordered="false" titled theme="night"></x-metabase>
Common Problems
Embedding is not enabled for this object.
Solution: https://www.metabase.com/learn/embedding/embedding-charts-and-dashboards
Not found.
Invalid dashboard or question ID.
Message seems corrupt or manipulated.
Invalid secret key.