PHPackages                             winter/wn-notes-plugin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. winter/wn-notes-plugin

ActiveWinter-plugin[Utility & Helpers](/categories/utility)

winter/wn-notes-plugin
======================

Easily add notes to any record in WinterCMS

v1.0.5(4y ago)121.4k5[1 PRs](https://github.com/wintercms/wn-notes-plugin/pulls)MITJavaScript

Since Jan 14Pushed 4y ago4 watchersCompare

[ Source](https://github.com/wintercms/wn-notes-plugin)[ Packagist](https://packagist.org/packages/winter/wn-notes-plugin)[ Docs](https://github.com/wintercms/wn-notes-plugin)[ GitHub Sponsors](https://github.com/LukeTowers)[ RSS](/packages/winter-wn-notes-plugin/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (1)Versions (6)Used By (0)

About
=====

[](#about)

Easily add notes to any record in WinterCMS through a Mac OS-like user experience.

 [![Screenshot of Notes FormWidget](https://github.com/wintercms/wn-notes-plugin/raw/main/assets/images/screenshot.png?raw=true)](https://github.com/wintercms/wn-notes-plugin/raw/main/assets/images/screenshot.png?raw=true)

Installation
============

[](#installation)

To install it with Composer, run `composer require winter/wn-notes-plugin` from your project root.

To install from [the repository](https://github.com/wintercms/wn-notes-plugin), clone it into `plugins/winter/notes` and then run `composer update` from your project root in order to pull in the dependencies.

Documentation
=============

[](#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
---------------------------------------

[](#add-notes-fields-to-third-party-plugins)

In your custom `Plugin.php` plugin class, do the following:

```