@strapi/helper-plugin

What is @strapi/helper-plugin?

@strapi/helper-plugin is a utility package designed to assist in the development of Strapi plugins. It provides a set of tools and components that streamline the process of creating and managing plugins within the Strapi ecosystem.

What are @strapi/helper-plugin's main functionalities?

API Requests

This feature allows you to make API requests easily within your Strapi plugin. The `request` function simplifies the process of sending HTTP requests and handling responses.

import { request } from '@strapi/helper-plugin';

const fetchData = async () => {
  try {
    const data = await request('/some-endpoint', { method: 'GET' });
    console.log(data);
  } catch (error) {
    console.error('Error fetching data:', error);
  }
};

fetchData();

Notification System

The notification system allows you to display notifications within your plugin. The `useNotification` hook provides a simple way to trigger notifications with different types and messages.

import { useNotification } from '@strapi/helper-plugin';

const MyComponent = () => {
  const toggleNotification = useNotification();

  const handleClick = () => {
    toggleNotification({ type: 'success', message: 'Operation successful!' });
  };

  return <button onClick={handleClick}>Click me</button>;
};

Form Handling

Form handling is made easier with the `useFormik` hook from @strapi/helper-plugin. It helps manage form state, validation, and submission.

import { useFormik } from '@strapi/helper-plugin';

const MyForm = () => {
  const formik = useFormik({
    initialValues: { name: '' },
    onSubmit: values => {
      console.log('Form data:', values);
    },
  });

  return (
    <form onSubmit={formik.handleSubmit}>
      <input
        type="text"
        name="name"
        value={formik.values.name}
        onChange={formik.handleChange}
      />
      <button type="submit">Submit</button>
    </form>
  );
};

Other packages similar to @strapi/helper-plugin

formik

Formik is a popular library for building and managing forms in React. It provides a comprehensive set of tools for handling form state, validation, and submission. Compared to @strapi/helper-plugin, Formik is more general-purpose and can be used in any React application, not just Strapi plugins.

axios

Axios is a widely-used HTTP client for making API requests in JavaScript. It offers a simple and intuitive API for sending HTTP requests and handling responses. While @strapi/helper-plugin's `request` function is tailored for Strapi, Axios can be used in any JavaScript project.

react-toastify

React-Toastify is a library for displaying notifications in React applications. It provides a flexible and customizable notification system. Compared to @strapi/helper-plugin's notification system, React-Toastify offers more customization options and can be used in any React project.

README

Strapi Helper Plugin

Description

Helper to develop Strapi plugins.

Contributing

Please read our Contributing Guide before submitting a Pull Request to the project.