Skip to content

Commit 6629cfd

Browse files
committed
Update Minimal Theme documentation
1 parent 58cad90 commit 6629cfd

File tree

2 files changed

+8
-181
lines changed

2 files changed

+8
-181
lines changed

content/plugins/filament-minimal-theme.md

Lines changed: 6 additions & 179 deletions
Original file line numberDiff line numberDiff line change
@@ -3,197 +3,24 @@ name: Minimal Theme
33
slug: filament-minimal-theme
44
author_slug: filament
55
categories: [form-builder, panel-builder, table-builder, theme]
6-
checkout_url: https://filamentthemes.lemonsqueezy.com/buy/6f82d347-e136-468f-8ee4-02c0f04e3aec?embed=1&logo=0&discount=0
7-
description: Featuring a clean design with less rounding, a lighter background and redesigned UI components.
6+
url: https://whizzy.dev/themes/minimal?utm_source=filament&utm_medium=referral&utm_campaign=plugin&utm_content=button
7+
description: Featuring a clean design with less rounding, lighter backgrounds, and restyled UI components.
88
github_repository: filamentphp/minimal-theme
99
has_dark_theme: true
1010
has_translations: true
11-
is_lemon_squeezy_embedded: true
1211
price: €49.00
1312
versions: [3]
1413
publish_date: 2023-09-05
1514
---
1615

17-
Want your Filament applications to look more streamlined? The official Filament Minimal Theme features a clean design with less rounding, a lighter background and redesigned UI components. No need to hire a designer to make your projects look different from the default Filament style. Simply install our Composer package and you're good to go. Perfect for corporate software.
16+
Want your Filament apps to look more streamlined? The official Minimal theme features a clean design with less rounding, lighter backgrounds, and restyled UI components. No need to hire a designer to make your projects look different from the default Filament style. Simply install the Composer package and youre good to go.
1817

19-
> This theme covers all Filament packages and can be used standalone. You may choose a license for a single project (3 activations) or unlimited projects, both including free updates.
18+
[Visit the theme website to learn more.](https://whizzy.dev/themes/minimal?utm_source=filament&utm_medium=referral&utm_campaign=plugin&utm_content=introduction)
2019

2120
## Screenshots
2221

23-
List orders page in light mode using the Filament Minimal Theme:
24-
![Screenshot of the list orders page in light mode using the Filament Minimal Theme](/images/content/plugins/images/filament-minimal-theme-screenshot-light-list-orders.webp)
25-
26-
List orders page in light mode using the default Filament theme:
27-
![Screenshot of the list orders page in light mode using the default Filament theme](/images/content/plugins/images/filament-minimal-theme-screenshot-light-list-orders-default.webp)
28-
29-
List orders page in dark mode using the Filament Minimal Theme:
30-
![Screenshot of the list orders page in dark mode using the Filament Minimal Theme](/images/content/plugins/images/filament-minimal-theme-screenshot-dark-list-orders.webp)
31-
32-
List orders page in light mode using the default Filament theme:
33-
![Screenshot of the list orders page in dark mode using the default Filament theme](/images/content/plugins/images/filament-minimal-theme-screenshot-dark-list-orders-default.webp)
34-
35-
Edit post page in light mode using the Filament Minimal Theme:
36-
![Screenshot of the edit post page in light mode using the Filament Minimal Theme](/images/content/plugins/images/filament-minimal-theme-screenshot-light-edit-post.webp)
37-
38-
Edit post page in light mode using the default Filament theme:
39-
![Screenshot of the edit post page in light mode using the default Filament theme](/images/content/plugins/images/filament-minimal-theme-screenshot-light-edit-post-default.webp)
40-
41-
Edit post page in dark mode using the Filament Minimal Theme:
42-
![Screenshot of the edit post page in dark mode using the Filament Minimal Theme](/images/content/plugins/images/filament-minimal-theme-screenshot-dark-edit-post.webp)
43-
44-
Edit post page in dark mode using the default Filament theme:
45-
![Screenshot of the edit post page in dark mode using the default Filament theme](/images/content/plugins/images/filament-minimal-theme-screenshot-dark-edit-post-default.webp)
46-
47-
Registration page in light mode using the Filament Minimal Theme:
48-
![Screenshot of the registration page in light mode using the Filament Minimal Theme](/images/content/plugins/images/filament-minimal-theme-screenshot-light-registration.webp)
49-
50-
Registration page in light mode using the default Filament theme:
51-
![Screenshot of the registration page in light mode using the default Filament theme](/images/content/plugins/images/filament-minimal-theme-screenshot-light-registration-default.webp)
52-
53-
Registration page in dark mode using the Filament Minimal Theme:
54-
![Screenshot of the registration page in light mode using the Filament Minimal Theme](/images/content/plugins/images/filament-minimal-theme-screenshot-dark-registration.webp)
55-
56-
Registration page in dark mode using the default Filament theme:
57-
![Screenshot of the registration page in light mode using the default Filament theme](/images/content/plugins/images/filament-minimal-theme-screenshot-dark-registration-default.webp)
22+
Visit the Whizzy website to view [screenshots of the Filament Minimal Theme](https://whizzy.dev/themes/minimal?utm_source=filament&utm_medium=referral&utm_campaign=plugin&utm_content=screenshots) and compare it with the default Filament theme.
5823

5924
## Installation
6025

61-
### Requirements
62-
63-
This plugin requires the latest version of Filament v3, as it depends on new APIs added to Filament's core.
64-
65-
### Installation
66-
67-
Filament Minimal Theme can be installed using our private Composer repository. Configure the repository in your application's `composer.json` file by running:
68-
69-
```bash
70-
composer config repositories.whizzy composer https://whizzy.dev/composer
71-
```
72-
73-
Now you can install the package using:
74-
75-
```bash
76-
composer require filament/minimal-theme:"^3.0"
77-
```
78-
79-
You will be prompted to provide a username and password. Use your order email address as username and the license key you received as password.
80-
81-
### Panels
82-
83-
#### Stylesheet
84-
85-
To start using the Minimal Theme with the Filament Panel Builder, you need to [create a custom theme](https://filamentphp.com/docs/3.x/panels/themes#creating-a-custom-theme).
86-
87-
Next, replace the imported Panel Builder stylesheet with the Minimal Theme stylesheet in your theme CSS file:
88-
89-
```diff
90-
- @import '/vendor/filament/filament/resources/css/theme.css';
91-
+ @import '/vendor/filament/minimal-theme/resources/css/index.css';
92-
```
93-
94-
Now compile your theme stylesheet using `npm run build`.
95-
96-
#### Configuration
97-
98-
Finally, register the theme plugin in your panel configuration file, and configure the colors and icons:
99-
100-
```php
101-
<?php
102-
103-
namespace App\Providers\Filament;
104-
105-
use Filament\MinimalTheme;
106-
use Filament\Panel;
107-
use Filament\PanelProvider;
108-
109-
class AdminPanelProvider extends PanelProvider
110-
{
111-
public function panel(Panel $panel): Panel
112-
{
113-
return $panel
114-
->plugin(new MinimalTheme())
115-
->viteTheme('resources/css/filament/admin/theme.css')
116-
->colors(MinimalTheme::getColors())
117-
->icons(MinimalTheme::getIcons());
118-
}
119-
}
120-
```
121-
122-
### Standalone
123-
124-
If you're using Filament packages outside the Panel Builder, you may install the Minimal Theme using the following steps.
125-
126-
First, make sure you've properly installed any Filament packages. Your project should have a Tailwind CSS config file that extends the Filament preset, a stylesheet (e.g. `resources/css/app.css`), and a layout view that renders `@filamentStyles`.
127-
128-
#### Stylesheet
129-
130-
In your app CSS file, import the Minimal Theme stylesheets for the Filament packages you're using:
131-
132-
```css
133-
@import 'tailwindcss/base';
134-
@import 'tailwindcss/components';
135-
@import 'tailwindcss/utilities';
136-
137-
@import '/vendor/filament/minimal-theme/resources/css/actions';
138-
@import '/vendor/filament/minimal-theme/resources/css/forms';
139-
@import '/vendor/filament/minimal-theme/resources/css/infolists';
140-
@import '/vendor/filament/minimal-theme/resources/css/notifications';
141-
@import '/vendor/filament/minimal-theme/resources/css/support';
142-
@import '/vendor/filament/minimal-theme/resources/css/tables';
143-
@import '/vendor/filament/minimal-theme/resources/css/widgets';
144-
```
145-
146-
Note that some packages depend on other Filament packages, so you need to make sure to import the stylesheets of all dependencies. Here's the list of packages with their dependencies:
147-
148-
- Actions
149-
- Forms
150-
- Infolists
151-
- Notifications
152-
- Support
153-
- Forms
154-
- Actions
155-
- Infolists
156-
- Notifications
157-
- Support
158-
- Infolists
159-
- Actions
160-
- Forms
161-
- Notifications
162-
- Support
163-
- Notifications
164-
- Actions
165-
- Support
166-
- Support
167-
- Tables
168-
- Actions
169-
- Forms
170-
- Infolists
171-
- Notifications
172-
- Support
173-
- Widgets
174-
- Support
175-
176-
Next, compile your updated stylesheet using `npm run build`.
177-
178-
#### Configuration
179-
180-
Finally, the theme's colors, color shades, and icons need to be configured. You may do this by registering the theme's service provider in `config/app.php` by adding it to the `providers` array:
181-
182-
```php
183-
/*
184-
* Package Service Providers...
185-
*/
186-
Filament\MinimalThemeServiceProvider::class,
187-
```
188-
189-
Alternatively, if you need more control or only want to use the theme in certain parts of your app, you may configure the theme manually (e.g. in a middleware):
190-
191-
```php
192-
use Filament\MinimalTheme;
193-
194-
MinimalTheme::configure();
195-
```
196-
197-
## Issues
198-
199-
If you find a bug in this package, please [contact Zep via email](mailto:[email protected]).
26+
The Filament Minimal Theme can be installed using Composer. Visit the documentation for complete [installation instructions](https://whizzy.dev/themes/minimal?utm_source=filament&utm_medium=referral&utm_campaign=plugin&utm_content=installation).

resources/views/plugins/view-plugin.blade.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,10 @@ class="block select-none rounded-bl-lg rounded-br-2xl rounded-tl-lg rounded-tr-l
9898
>
9999
Visit GitHub
100100
</a>
101-
@else
101+
@elseif ($checkoutUrl = $plugin->getCheckoutUrl())
102102
{{-- Price --}}
103103
<a
104-
href="{{ $plugin->getCheckoutUrl() }}"
104+
href="{{ $checkoutUrl }}"
105105
target="_blank"
106106
@class([
107107
'block select-none rounded-bl-lg rounded-br-2xl rounded-tl-lg rounded-tr-lg bg-salmon px-6 py-2.5 text-center text-sm font-medium text-white shadow-xl shadow-black/[0.02] transition duration-300 hover:-translate-y-0.5 hover:bg-[#ff8868]',

0 commit comments

Comments
 (0)