tomatophp/filament-notes

Add Sticky Notes to your FilamentPHP dashboard with tons of options and style

v1.0.18 2024-09-17 16:52 UTC

Requires

• php: ^8.1|^8.2
• filament/filament: ^3.0
• tomatophp/console-helpers: ^1.1
• tomatophp/filament-icons: ^1.1
• tomatophp/filament-types: ^1.0

MIT

• Fady Mondy

• php
• laravel
• widget
• sticky
• notes
• filament

README

Filament Sticky Notes

Add Sticky Notes to your FilamentPHP dashboard with tons of options and style

NOTE please make sure you have SQLite3 ex for PHP to make sure that Icons will be cached and work.

Screenshots

Features

• Notes Resource
• Notes Style
• Pined Notes
• Notes Background
• Notes Font Color
• Notes Border Color
• Notes Font Widget
• Notes Widget
• Notes Widget Limit
• Public/Private Notes
• Notes Groups
• Notes Status
• Notes To Notifications
• Share Notes With Public Link
• Share Notes With Selected User
• Notes CheckLists
• Notes Reminders
• Notes Font Family
• Attach Notes To Models
• Notes Templates

Installation

composer require tomatophp/filament-notes

after install your package please run this command

php artisan filament-notes:install

Finally reigster the plugin on /app/Providers/Filament/AdminPanelProvider.php

$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make())

Use Widget

you can use it as a resource or you can use it as a widget by just register a widget on your panel provider like this

$panel->widgets([
    \TomatoPHP\FilamentNotes\Filament\Widgets\NotesWidget::class
])

Use Livewire Component

you can use selected note anywhere using livewire component

 <livewire:note-action :note="$note" />

Use Groups & Status

to use this feature you need to install filament-types or use this command

composer require tomatophp/filament-types

than you can use this feature by add this methods to the plugin

$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make()
    ->useStatus()
    ->useGroups()
)

Use Convert Note To Notification

to use this feature you need to install filament-alerts or use this command

composer require tomatophp/filament-alerts

then you can use this feature by adding this method to the plugin

$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make()
    ->useNotification()
)

Use Share Note With Public Link

you can generate a public link and share it with others by allowing this feature on your provider

$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make()
    ->useShareLink()
)

Use User Access Permissions

you can use this feature to allow only selected users to access the notes by allowing this feature on your provider

$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make()
    ->useUserAccess()
)

Use Checklist

you can use this feature to add a checklist to your notes by allowing this feature on your provider

$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make()
    ->useChecklist()
)

Customize Note Resource Icon

you can customize the note resource icon by adding this method to the plugin

$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make()
    ->navigationIcon('heroicon-o-presentation-chart-line')
)

Publish Assets

you can publish config file by use this command

php artisan vendor:publish --tag="filament-notes-config"

you can publish views file by use this command

php artisan vendor:publish --tag="filament-notes-views"

you can publish languages file by use this command

php artisan vendor:publish --tag="filament-notes-lang"

you can publish migrations file by use this command

php artisan vendor:publish --tag="filament-notes-migrations"

Other Filament Packages

Checkout our Awesome TomatoPHP