Git Product home page Git Product logo

strapi-plugin-notes's Introduction

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

  • v4.x.x

NOTE: While this plugin may work with the older Strapi versions, they are not supported, it is always recommended to use the latest version of Strapi.

Installation

npm install strapi-plugin-notes

or

yarn add strapi-plugin-notes

Configuration

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

module.exports = ({ env }) => ({
	'entity-notes': {
		enabled: true,
	},
});

IMPORTANT NOTE: Make sure any sensitive data is stored in env files.

Usage

Once the plugin has been installed, configured a notes section will be added to the informations 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.

Bugs

If any bugs are found please report them as a Github Issue

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.