Merge pull request #21 from Muetze42/development

Development
Muetze42 · Apr 25, 2023 · fd5da38 · fd5da38
2 parents b4413e1 + e7e5af3
commit fd5da38
Show file tree

Hide file tree

Showing 31 changed files with 674 additions and 196 deletions.
diff --git a/README.md b/README.md
@@ -1,195 +1,25 @@
 # Nova Menu Advanced
 
-* ~~This package brings back the policy authorization for MenuItem~~ Include since Nova 4.2.5
-* ~~Also, the well-known canSee method is added to MenuItem and MenuSection~~ Include since Nova 4.2.5
-* ~~Empty menu sections are automatically hidden~~ Include since Nova 4.6.0
-* Heroicon, Font Awesome, SVG & Image Icon for MenuSection, MenuGroup & MenuItem
-
-![Preview 1](docs/preview.jpg)
-![Preview 2](docs/preview2.jpg)
-
-Examples from [example-app-nvpRt7](https://github.com/Muetze42/example-app-nvpRt7)
-
-![Preview Dark](docs/preview-dark.jpg)
-![Preview Light](docs/preview-light.jpg)
-![Preview Hover](docs/preview-hover.jpg)
-
-### Installation
-
-```
-composer require norman-huth/nova-menu
-```
-
-### Usage
-
-* Use `NormanHuth\NovaMenu\MenuSection` instead of `Laravel\Nova\Menu\MenuSection`
-* Use `NormanHuth\NovaMenu\MenuGroup` instead of `Laravel\Nova\Menu\MenuGroup`
-* Use `NormanHuth\NovaMenu\MenuItem` instead of `Laravel\Nova\Menu\MenuItem`
-
-#### Use Heroicon Icons
-
-Use the `icon()` method.
-
-```php
-MenuSection::make(__('Customers'), [/**...**/])->icon('chart-bar'),
-MenuGroup::make(__('Licensing'), [/**...**/])->icon('chart-bar'),
-MenuItem::resource(User::class)->icon('chart-bar'),
-```
-
-#### Use Font Awesome Icon
-
-Use the `faIcon()` method.
-
-```php
-MenuSection::make(__('Customers'), [/**...**/])->faIcon('fa-brands fa-laravel'),
-MenuGroup::make(__('Licensing'), [/**...**/])->faIcon('fa-brands fa-laravel'),
-MenuItem::resource(User::class)->faIcon('fa-brands fa-laravel'),
-```
-
-#### Use SVG Icon
-
-Use the `svgIcon()` method.
-
-##### Use SVG Directly
-
-```php
-MenuSection::make(__('Customers'), [/**...**/])->svgIcon('<svg xmlns="...'),
-MenuGroup::make(__('Licensing'), [/**...**/])->svgIcon('<svg xmlns="...'),
-MenuItem::resource(User::class)->svgIcon('<svg xmlns="...'),
-```
-
-##### Use SVG File
-
-```php
-MenuSection::make(__('Customers'), [/**...**/])->svgIcon(resource_path('icon.svg')),
-MenuGroup::make(__('Licensing'), [/**...**/])->svgIcon(resource_path('icon.svg')),
-MenuItem::resource(User::class)->svgIcon(resource_path('icon.svg')),
-```
-
-#### Use Image Icon
-
-Use the `imageIcon()` method.
-
-```php
-MenuSection::make(__('Customers'), [/**...**/])->imageIcon(asset('images/car-icon.png')),
-MenuGroup::make(__('Licensing'), [/**...**/])->imageIcon('https://domain.tld/images/icon.png'),
-MenuItem::resource(User::class)->imageIcon('/images/icon.png'),
-```
-
-#### Use HTML Icon
-
-Use the `htmlIcon()` method.
+This package add following features to the [Laravel Nova menu](https://nova.laravel.com/docs/4.0/customization/menus.html):
 
-```php
-MenuSection::make(__('Customers'), [/**...**/])->htmlIcon(/** Your HTML Code **/),
-MenuGroup::make(__('Licensing'), [/**...**/])->htmlIcon(/** Your HTML Code **/),
-MenuItem::resource(User::class)->htmlIcon(/** Your HTML Code **/),
-```
-
-#### Change Icon Height
-
-Use the `iconHeight()` method.  
-(Value `int` in Pixel. Possible from `4 to 32` pixels)
-
-```php
-MenuSection::make(__('Customers'), [/**...**/])->iconHeight(24), // MenuSection: 24 default
-MenuGroup::make(__('Licensing'), [/**...**/])->iconHeight(18),   // MenuGroup: 18 default
-MenuItem::resource(User::class)->iconHeight(18),                 // MenuItem: 18 default
-```
-
-#### Use Icon In Label
-
-Use the `asLabel()` method.  
-(Only available for `MenuGroup` and `MenuItem`)
-
-```php
-MenuGroup::make(__('Licensing'), [/**...**/])->asLabel(),
-MenuItem::resource(User::class)->asLabel(),
-```
-
-##### Controlling Gutters Between Icon And Label
-
-**Default**: 1 (0.25rem)
-
-| Method           | Gap      |
-|------------------|----------|
-| `->asLabel(0.5)` | 0.125rem |
-| `->asLabel(1.5)` | 0.375rem |
-| `->asLabel(2)`   | 0.5rem   |
-| `->asLabel(2.5)` | 0.625rem |
-| `->asLabel(3)`   | 0.75rem  |
-| `->asLabel(3.5)` | 0.875rem |
-| `->asLabel(4)`   | 1rem     |
-| `->asLabel(5)`   | 1.25rem  |
-| `->asLabel(6)`   | 1.5rem   |
-| `->asLabel(8)`   | 2rem     |
-
-```php
-MenuGroup::make(__('Licensing'), [/**...**/])->asLabel(2),
-MenuItem::resource(User::class)->asLabel(3.5),
-```
-
-#### Optional: Install Font Awesome
-
-If you don't have Font Awesome integrated in Nova, but want to use it, you can optionally install Font Awesome Free with this command.
-
-```
-php artisan nova-menu:font-awesome
-```
-
-#### Optional: Tailwind CSS Colors
-
-Install all Tailwind CSS [Text Color](https://tailwindcss.com/docs/text-color), [Border Color](https://tailwindcss.com/docs/border-color) and
-[Background Color](https://tailwindcss.com/docs/background-color) classes inclusive dark mode classes.
-
-**But note that with this file will be loaded 620KB more CSS!**
-
-```
-php artisan nova-menu:tailwind-colors
-```
-
-#### Add Classes To Element
-
-Use the `elemClasses()` method.
-
-```php
-MenuSection::make(__('Customers'), [/**...**/])->elemClasses('class-1 class-2'),
-MenuGroup::make(__('Licensing'), [/**...**/])->elemClasses('class-1 class-2'),
-MenuItem::resource(User::class)->elemClasses('class-1 class-2'),
-MenuSection::make(__('Customers'), [/**...**/])->elemClasses(['class-1', 'class-2']),
-MenuGroup::make(__('Licensing'), [/**...**/])->elemClasses(['class-1', 'class-2']),
-MenuItem::resource(User::class)->elemClasses(['class-1', 'class-2']),
-```
-
-#### Add Classes To Icon
-
-Use the `iconClasses()` method.
-
-```php
-MenuSection::make(__('Customers'), [/**...**/])->iconClasses('class-1 class-2'),
-MenuGroup::make(__('Licensing'), [/**...**/])->iconClasses('class-1 class-2'),
-MenuItem::resource(User::class)->iconClasses('class-1 class-2'),
-MenuSection::make(__('Customers'), [/**...**/])->iconClasses(['class-1', 'class-2']),
-MenuGroup::make(__('Licensing'), [/**...**/])->iconClasses(['class-1', 'class-2']),
-MenuItem::resource(User::class)->iconClasses(['class-1', 'class-2']),
-```
+* Heroicon, Font Awesome, SVG & Image Icon for MenuSection, MenuGroup & MenuItem
+* Add new item `MenuCard`
+* Add `tooltip()` method to MenuSection, MenuGroup, MenuItem & MenuCard (undocumented)
 
-#### Add Classes To Label
+For more informationen read the [Documentation](https://docs.huth.it/nova-menu).
 
-Use the `labelClasses()` method.
+![Preview Dark Mode](https://github.com/Muetze42/nova-menu/blob/main/docs/preview-dark-mode.png)
+![Preview Light Mode](https://github.com/Muetze42/nova-menu/blob/main/docs/preview-light-mode.png)
 
-```php
-MenuSection::make(__('Customers'), [/**...**/])->labelClasses('class-1 class-2'),
-MenuGroup::make(__('Licensing'), [/**...**/])->labelClasses('class-1 class-2'),
-MenuItem::resource(User::class)->labelClasses('class-1 class-2'),
-MenuSection::make(__('Customers'), [/**...**/])->labelClasses(['class-1', 'class-2']),
-MenuGroup::make(__('Licensing'), [/**...**/])->labelClasses(['class-1', 'class-2']),
-MenuItem::resource(User::class)->labelClasses(['class-1', 'class-2']),
-```
+Examples from [example-app-nvpRt7](https://github.com/Muetze42/example-app-nvpRt7)
 
 ---
 
-Todo: Mix for Font Awesome & Tailwind CSS
+### Deprecated Features
+
+* ~~This package brings back the policy authorization for MenuItem~~ Include since Nova 4.2.5
+* ~~Also, the well-known canSee method is added to MenuItem and MenuSection~~ Include since Nova 4.2.5
+* ~~Empty menu sections are automatically hidden~~ Include since Nova 4.6.0
 
 ---
 

diff --git a/dist/css/tool.css b/dist/css/tool.css
diff --git a/dist/js/tool.js b/dist/js/tool.js
diff --git a/dist/mix-manifest.json b/dist/mix-manifest.json
@@ -1,4 +1,4 @@
 {
-    "/js/tool.js": "/js/tool.js?id=cf9c832eb5de9f26626d5243e87f8814",
-    "/css/tool.css": "/css/tool.css?id=617a67680cd5dd5759b1963661ce40f1"
+    "/js/tool.js": "/js/tool.js?id=48ae70bd83b0ea60302ae581b4f4c23a",
+    "/css/tool.css": "/css/tool.css?id=4e2099e34bf226a8200bf60c4712a5d7"
 }
diff --git a/docs/card.md b/docs/card.md
@@ -0,0 +1,115 @@
+# Menu Card
+
+This package adds the possibility to display cards in the menu.
+
+## Usage
+
+You can create a new menu card by calling the `MenuCard::make` method.
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make()
+```
+
+### Set Content To A Card
+
+#### Set String Content
+
+You can set a string as content for a menu card by invoking the `content` method when defining the menu card:
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make()
+    ->content('Norman Huth'),
+```
+
+#### Set Blade As Content
+
+You can set a Blade template as content for a menu card by invoking the `view` method when defining the menu card:
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make()
+    ->view('admin.news', ['name' => $request->user()->name])),
+```
+
+### Authorization
+
+You can hide certain fields from a group of users by invoking the `canSee` method when defining the menu card:
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make()
+    ->canSee(function (Request $request) {
+        return str_ends_with($request->user()->email, '@huth.it');
+    }),
+```
+
+### Customize And Theming
+
+### Use A Theme
+
+The static `make` method accept a theme argument. Valid themes are `info`, `success`, `warning` and `danger`.
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make('info'),
+```
+
+### Border Radios
+
+You can add a border radius by invoking the `rounded` method when defining the menu card:
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make('info')
+    ->rounded(),
+MenuCard::make('info')
+    ->rounded('sm'),
+MenuCard::make('info')
+    ->rounded('md'),
+MenuCard::make('info')
+    ->rounded('lg'),
+```
+
+### Add Classes
+
+You can add classes to the menu card class attribute by invoking the `addClasses` method when defining the menu card:
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make()
+    ->addClasses(['text-center', 'text-white']),
+```
+
+### Add Styles
+
+You can add styles to the menu card style attribute by invoking the `addStyles` method when defining the menu card:
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make()
+    ->addStyles([
+        'color' => 'white',
+        'text-align' => 'center',
+    ]),
+```
+
+### Add `MenuItem` Spacing
+
+You can add the same left margin spacing like a `MenuItem` by invoking the `asItem` method when defining the menu card:
+
+```php
+use NormanHuth\NovaMenu\MenuCard;
+
+MenuCard::make()
+    ->asItem(),
+```