strapi-plugin-notes

A plugin for Strapi that provides the ability to add notes to entity records.

Requirements

The installation requirements are the same as Strapi itself and can be found in the documentation on the Quick Start page in the Prerequisites info card.

Supported Strapi versions

• v5.x.x

Installation

pnpm add @frameless/strapi-plugin-notes

or:

yarn add @frameless/strapi-plugin-notes

Configuration

The plugin configuration is stored in a config file located at ./config/plugins.js.

export default ({ env }) => ({
  "entity-notes": {
    enabled: true,
  },
});

Usage

Once the plugin has been installed, configured a notes section will be added to the right-links sections of the edit view for all content types.

Adding a note

Navigate to the entity record that a note needs to be added to and click the Add new note text button. A modal will appear with input areas to add the note information. Once completed select save to create the note. Clicking the x icon on the top right or cancel on the bottom left will abort the note creation.

Editing a note

Navigate to the entity record that the note belongs to, and find the note in the notes list. Click on the pen can icon and a modal will appear with input areas to add the note information. Once completed select save to permanently save any changes that have been made. Clicking the x icon on the top right or cancel on the bottom left will abort all edits.

Deleting a note

Navigate to the entity record that the note belongs to, and find the note in the notes list. Click on the trash can icon and the record will be deleted.

License

This project is licensed under the European Union Public Licence (EUPL) v1.2.

See the LICENSE.md file at the root of the monorepo for full license text.