winter / wn-notes-plugin
Easily add notes to any record in WinterCMS
Fund package maintenance!
wintercms
Open Collective
Installs: 964
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 4
Forks: 5
Open Issues: 1
Language:JavaScript
Type:winter-plugin
Requires
- composer/installers: ~1.11
README
Easily add notes to any record in WinterCMS through a Mac OS-like user experience.
Installation
To install it with Composer, run composer require winter/wn-notes-plugin
from your project root.
To install from the repository, clone it into plugins/winter/notes
and then run composer update
from your project root in order to pull in the dependencies.
Documentation
Simply add the notes
MorphMany relationship to your model and add a field with a type of notes
to your fields.yaml to get started.
Example fields.yaml
:
fields: name: label: Name span: full tabs: fields: notes: # The name of the relationship the FormWidget will use label: '' tab: Notes type: notes span: full # autosaveDelay: 2000 # The amount of milliseconds to delay after typing stops to trigger an autosave # dateFormat: 'Y-m-d H:i:s' # the php date format for updated_at column
Example MorphMany Relationship definition:
public $morphMany = [ 'notes' => [\Winter\Notes\Models\Note::class, 'name' => 'target'] ];
Add notes fields to third party plugins
In your custom Plugin.php
plugin class, do the following:
<?php namespace MyAuthor\MyPlugin; use Event; use System\Classes\PluginBase; use Winter\Blog\Models\Post; class Plugin extends PluginBase { public function boot() { // Extend the Winter.Blog Post model to add the `notes` relationship Post::extend(function ($model) { $model->morphMany = array_merge($model->morphMany, ['notes' => [\Winter\Notes\Models\Note::class, 'name' => 'target']]); }); // Extend the backend fields to add the notes field Event::listen('backend.form.extendFieldsBefore', function ($widget) { // Only extend forms for the Post model if (!($widget->model instanceof Post)) { return; } // Add the notes field to the form $widget->fields = array_merge($widget->fields, ['notes' => [ 'label' => '', 'tab' => 'Notes', 'type' => 'Notes', 'span' => 'full', ]]); }); } }