Creating a Plone React Control-Panel

Netroxen · May 7, 2018, 12:02pm

Hi peeps, I'm looking for a little advice on creating a custom control-panel in React. When I try to access the /@@overview-controlpanel path through the plone.restapi it simply returns the page HTML. There doesn't seem to be a way of listing the control-panel contents, or the setting views for that matter. Alright, so I guess that would be expected, no problem.

BUT, if I'd like to create my own control-panel interface in React how may I go about accessing this data..? Would I have to create my own endpoint with methods to handle these settings, and then simply expose this to my React application..?

What would be the best way of doing this?

gforcada · May 7, 2018, 12:29pm

There is a controlpanel endpoint already:

Documentation:

github.com

plone/plone.restapi/blob/master/docs/source/controlpanels.rst

Control Panels
==============

Control panels in Plone allow you to configure the global site setup of a
Plone site. The @controlpanels endpoint in plone.restapi allows you to list
all existing control panels in a Plone site and to retrieve or edit the
settings of a specific control panel.

Most of the settings in the Plone control panels are based on plone.registry (since Plone 5.x). Therefore you can also use the @registry endpoint to
retrieve or manipulate site settings. The @controlpanels endpoint just gives
developers are more a convenience way of accessing the settings and makes it
easier to render control panels on the front-end.


.. note:: This is currently only implemented for Plone 5.


Listing Control Panels
----------------------

This file has been truncated. show original

If you want to create your own control panel you need to register it with the usual profile XML file.

As for the settings displayed on that control panel, since Plone 5 all settings should be stored as registry settings, so you can ignore/avoid a control panel and use directly the registry endpoint:

github.com

plone/plone.restapi/blob/master/docs/source/registry.rst

Registry
========

Registry records can be addressed through the ``@registry`` endpoint on the
Plone site. In order to address a specific record, the fully qualified dotted
name of the registry record has to be passed as a path segment
(e.g. `/plone/@registy/my.record`).

Reading or writing registry records require the ``cmf.ManagePortal``
permission.

Reading registry records
------------------------

Reading a single record:

..  http:example:: curl httpie python-requests
    :request: ../../src/plone/restapi/tests/http-examples/registry_get.req

Example Response:

This file has been truncated. show original

Netroxen · May 7, 2018, 1:20pm

Awesome sauce, thank you!