Documentation for `strapi-helper-plugin`

elhil · January 16, 2021, 2:49pm

Hi all,

Looking at plugins from the core code, it seems like strapi-helper-plugin contains a lot of useful, well, helpers for developing plugins Is there any documentation that details how to use this helper?

Thanks!

Gayrat · April 4, 2021, 5:47am

Hi, elhil
Did you find anything about strapi-helper-plugin ?
I’m find only example of usage at this place:

github.com

strapi/community-content/blob/master/tutorials/code/import-content-plugin-tutorial/plugins/import-content/admin/src/containers/HomePage/index.js#L6

    
      
          import React, {memo, Component} from "react";
          import {request} from "strapi-helper-plugin";
          import PropTypes from "prop-types";
          import pluginId from "../../pluginId";
          import UploadFileForm from "../../components/UploadFileForm";
          import {
            HeaderNav,
            LoadingIndicator,
            PluginHeader,
          } from "strapi-helper-plugin";
          import Row from "../../components/Row";
          import Block from "../../components/Block";
          import {Select, Label} from "@buffetjs/core";
          import {get, has, isEmpty, pickBy, set} from "lodash";
          import ExternalUrlForm from "../../components/ExternalUrlForm";
          import RawInputForm from "../../components/RawInputForm";

sunnyson · April 4, 2021, 8:47am

Currently, there is no documentation for the strapi-helper-plugin, but the best solution is to dig in the code and see what each exported function does.

elhil · April 5, 2021, 9:52pm

Yup. This is sort of just what coding in strapi is at the moment.

mrmossevig · June 7, 2021, 9:22pm

Do you know where I should put files to override strapi-helper-plugin?

LuisAlaguna · June 8, 2021, 3:29pm

The best thing, even to help to other people to create more and more Strapi plugins, is documenting this package since it is the core of many different plugins.

zalivadnyi · September 4, 2021, 9:23pm

It’s a good idea to clone the strapi repository locally and dive into sources of packages/strapi-helper-plugin/lib/src. You can also help the community with documentation of this part of strapi.

https://github.com/strapi/strapi/tree/master/packages/strapi-helper-plugin/lib/src

LuisAlaguna · October 6, 2021, 8:00pm

Actually, it is good if the package comes with a proper documentation, also, as they know they package better than anyone, they are the ones who can documentate it in best way.

Frank_Schwab · March 11, 2022, 3:50pm

There is still no documentation for @strapi/helper-plugin, right?

If someone wants to go with your approach, I think this is the new location within the strapi project:

https://github.com/strapi/strapi/tree/master/packages/core/helper-plugin/lib/src

LuisAlaguna · August 15, 2022, 2:35pm

We are still waiting for this, is very important for developers.

Esteban_Piacentino · March 15, 2023, 11:11am

This would be very helpful indeed!

piwi · March 15, 2023, 1:22pm

Hi! Thanks again for bringing up this topic.
There was a PR open a while ago that aimed at documenting a lot of Strapi internals.

The Strapi Documentation team, who maintains https://docs.strapi.io and its repository, unfortunately, does not have the capacity to work on these highly technical topics for now without a significant contribution from the Engineering team. However, as the Lead Technical Writer at Strapi, I’ve passed the request to the Engineering team.

FYI, engineers started maintaining a more contributor-oriented documentation, hosted at https://contributor.strapi.io and in the strapi/strapi repo. It is far from complete but will grow over time, and some parts might be ported to docs.strapi.io.

The Strapi Documentation team is at reduced capacity right now, and we’re doing our best to maintain & update the existing docs while improving the UX of the docs website. Please keep the feedback coming! It helps prioritize and focus on what matters to the community