diff --git a/src/utils/modeHandler.js b/src/utils/modeHandler.js index 53d5a4fd12bfd89da183c049e89b856b49e274fe..65af953a7206a21b26f61c0bba4ca16f5f7e40f4 100644 --- a/src/utils/modeHandler.js +++ b/src/utils/modeHandler.js @@ -2,6 +2,16 @@ import React, {Component} from 'react'; import Form from 'react-jsonschema-form'; import { merge } from 'lodash/object'; +/** + * This class will look for the `modes` attribute if the class passed as the `component` property. This object is used + * to add buttons to show a readme about the component or a settings form. + * + * All changes to the node's settings are saved through the updateConfig function (passed as props). + * + * Expected React properties : + * - component: class for the component to be instanciated + * - updateConfig & node: as provided by the `Board` component to all its children + */ export class Modal extends Component { constructor(props) { super(props);