Skip to content

Commit

Permalink
refactor for v3 beta
Browse files Browse the repository at this point in the history
  • Loading branch information
awcodes committed Jul 23, 2023
1 parent 5067ba3 commit 7f1570a
Show file tree
Hide file tree
Showing 14 changed files with 79 additions and 4,880 deletions.
28 changes: 0 additions & 28 deletions .github/workflows/build-assets.yml

This file was deleted.

43 changes: 13 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@ You can install the package via composer:
composer require awcodes/overlook
```

In an effort to align with Filament's theming methodology you will need to use a custom theme to use this plugin.

> **Note**
> 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.
Add the plugin's views to your `tailwind.config.js` file.

```js
content: [
'<path-to-vendor>/awcodes/overlook/resources/**/*.blade.php',
]
```

## Usage

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.
Expand Down Expand Up @@ -133,36 +146,6 @@ public function panel(Panel $panel): Panel
}
```

## Custom Themes

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.

***You will also need to install tippy.js and include the styles for tippy.js if you have not already done so.***

```bash
npm i -D tippy.js
```

```php
use Awcodes\Overlook\OverlookPlugin;

public function panel(Panel $panel): Panel
{
return $panel
->plugins([
OverlookPlugin::make()
->disableCss(),
]);
}
```

In your theme's stylesheet add the following:

```css
@import '<path-to-vendor>/awcodes/overlook/resources/dist/overlook.css';
@import '<path-to-node-modules>/tippy.js/dist/tippy.css';
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
],
"require": {
"php": "^8.1",
"filament/filament": "^3.0",
"filament/filament": "^3.0@beta",
"spatie/laravel-package-tools": "^1.15",
"ext-intl": "*"
},
Expand Down
Loading

0 comments on commit 7f1570a

Please sign in to comment.