Skip to content

Commit 7f1570a

Browse files
committed
refactor for v3 beta
1 parent 5067ba3 commit 7f1570a

File tree

14 files changed

+79
-4880
lines changed

14 files changed

+79
-4880
lines changed

.github/workflows/build-assets.yml

Lines changed: 0 additions & 28 deletions
This file was deleted.

README.md

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@ You can install the package via composer:
1515
composer require awcodes/overlook
1616
```
1717

18+
In an effort to align with Filament's theming methodology you will need to use a custom theme to use this plugin.
19+
20+
> **Note**
21+
> If you have not set up a custom theme and are using a Panel follow the instructions in the [Filament Docs](https://filamentphp.com/docs/3.x/panels/themes#creating-a-custom-theme) first.
22+
23+
Add the plugin's views to your `tailwind.config.js` file.
24+
25+
```js
26+
content: [
27+
'<path-to-vendor>/awcodes/overlook/resources/**/*.blade.php',
28+
]
29+
```
30+
1831
## Usage
1932

2033
Add the plugin and widget to your panel provider. You may use the `sort` and `columns` methods on the plugin to change the widget order and number of columns the widget will use to display its items.
@@ -133,36 +146,6 @@ public function panel(Panel $panel): Panel
133146
}
134147
```
135148

136-
## Custom Themes
137-
138-
If you are using a custom theme with Filament you will want to disable loading the css file and add its styles to your custom theme.
139-
140-
***You will also need to install tippy.js and include the styles for tippy.js if you have not already done so.***
141-
142-
```bash
143-
npm i -D tippy.js
144-
```
145-
146-
```php
147-
use Awcodes\Overlook\OverlookPlugin;
148-
149-
public function panel(Panel $panel): Panel
150-
{
151-
return $panel
152-
->plugins([
153-
OverlookPlugin::make()
154-
->disableCss(),
155-
]);
156-
}
157-
```
158-
159-
In your theme's stylesheet add the following:
160-
161-
```css
162-
@import '<path-to-vendor>/awcodes/overlook/resources/dist/overlook.css';
163-
@import '<path-to-node-modules>/tippy.js/dist/tippy.css';
164-
```
165-
166149
## Changelog
167150

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

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
],
2222
"require": {
2323
"php": "^8.1",
24-
"filament/filament": "^3.0",
24+
"filament/filament": "^3.0@beta",
2525
"spatie/laravel-package-tools": "^1.15",
2626
"ext-intl": "*"
2727
},

0 commit comments

Comments
 (0)