Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomatophp/filament-notes
Add Sticky Notes to your FilamentPHP dashboard with tons of options and style
https://github.com/tomatophp/filament-notes
filament filament-plugin notes sticky-notes todo todolist tomato
Last synced: 1 day ago
JSON representation
Add Sticky Notes to your FilamentPHP dashboard with tons of options and style
- Host: GitHub
- URL: https://github.com/tomatophp/filament-notes
- Owner: tomatophp
- License: mit
- Created: 2024-07-21T12:58:32.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-10-03T11:59:39.000Z (3 months ago)
- Last Synced: 2024-12-25T20:07:14.755Z (8 days ago)
- Topics: filament, filament-plugin, notes, sticky-notes, todo, todolist, tomato
- Language: PHP
- Homepage: https://tomatophp.com/en/open-source/filament-notes
- Size: 1.98 MB
- Stars: 36
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Filament Sticky Notes
[](https://packagist.org/packages/tomatophp/filament-notes)
[](https://packagist.org/packages/tomatophp/filament-notes)
[](https://packagist.org/packages/tomatophp/filament-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
- [x] Notes Resource
- [x] Notes Style
- [x] Pined Notes
- [x] Notes Background
- [x] Notes Font Color
- [x] Notes Border Color
- [x] Notes Font Widget
- [x] Notes Widget
- [x] Notes Widget Limit
- [x] Public/Private Notes
- [x] Notes Groups
- [x] Notes Status
- [x] Notes To Notifications
- [x] Share Notes With Public Link
- [x] Share Notes With Selected User
- [x] Notes CheckLists
- [ ] Notes Reminders
- [ ] Notes Font Family
- [ ] Attach Notes To Models
- [ ] Notes Templates
## Installation
```bash
composer require tomatophp/filament-notes
```
after install your package please run this command
```bash
php artisan filament-notes:install
```
Finally reigster the plugin on `/app/Providers/Filament/AdminPanelProvider.php`
```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
```php
$panel->widgets([
\TomatoPHP\FilamentNotes\Filament\Widgets\NotesWidget::class
])
```
## Use Livewire Component
you can use selected note anywhere using livewire component
```html
```
## Use Groups & Status
to use this feature you need to install [filament-types](https://www.github.com/tomatophp/filament-types) or use this command
```bash
composer require tomatophp/filament-types
```
than you can use this feature by add this methods to the plugin
```php
$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make()
->useStatus()
->useGroups()
)
```
## Use Convert Note To Notification
to use this feature you need to install [filament-alerts](https://www.github.com/tomatophp/filament-alerts) or use this command
```bash
composer require tomatophp/filament-alerts
```
then you can use this feature by adding this method to the plugin
```php
$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
```php
$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
```php
$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
```php
$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
```php
$panel->plugin(\TomatoPHP\FilamentNotes\FilamentNotesPlugin::make()
->navigationIcon('heroicon-o-presentation-chart-line')
)
````
## Publish Assets
you can publish config file by use this command
```bash
php artisan vendor:publish --tag="filament-notes-config"
```
you can publish views file by use this command
```bash
php artisan vendor:publish --tag="filament-notes-views"
```
you can publish languages file by use this command
```bash
php artisan vendor:publish --tag="filament-notes-lang"
```
you can publish migrations file by use this command
```bash
php artisan vendor:publish --tag="filament-notes-migrations"
```
## Other Filament Packages
Checkout our [Awesome TomatoPHP](https://github.com/tomatophp/awesome)