Refactor/customdata docs update #11
Conversation
| @@ -73,8 +85,12 @@ export function CustomDataContainer({app, resources, customData, setCustomData, | |||
| const onSave = async (data) => { | |||
| // first, transform data to appropirate format for api request and skip pairs with empty key field | |||
| let objToSubmit = await prepForRequest(data); | |||
| // second, check if uri is in the right format to prevend invalid address | |||
| let address; | |||
| uri.charAt(0) === '/' ? address = uri.substring(1, uri.length) | |||
There was a problem hiding this comment.
@petrKavulok You dont need to have this construction of conditions here at all, you can use regex expression and do simply:
let address = url.replace(/^\//g, "");
This will always remove the first trailing slash if it will appear in the url string. If there will be no trailing slash, the url string will stay intact.
You can also make it even simplier by using this in the request (then you dont need to declare address variable)
let response = await SeaCatAuthAPI.put(`/${url.replace(/^\//g, "")}`, {"data": objToSubmit});
| @@ -11,6 +11,18 @@ import { | |||
| FormGroup | |||
| } from 'reactstrap'; | |||
|
|
|||
| /* | |||
There was a problem hiding this comment.
@petrKavulok Shouldnt this be in some doc file?
There was a problem hiding this comment.
wasn't sure where to put it, since we have docs in asab-webui/doc but this is a part of seacat-admin-webui. I wasn't sure it was worth creating a /doc folder for a documentation of this magnitude. If it should be in the doc folder, should the folder be a part of the /components folder? or have a different spot in the treemenu?
There was a problem hiding this comment.
@petrKavulok Nope, it should be in doc folder on top level (there already is a doc folder)
- asab-webui
- conf
- doc <<<< here is the doc folder where you want to add any broader description regarding of any component
- public
- src
- ....
btw. docs for asab-webui surely are in asab-webui/doc, but this is not the case, innit?
There was a problem hiding this comment.
you're right, I missed that, I'm sorry :-)
| @@ -11,6 +11,18 @@ import { | |||
| FormGroup | |||
| } from 'reactstrap'; | |||
|
|
|||
| /* | |||
There was a problem hiding this comment.
@petrKavulok Nope, it should be in doc folder on top level (there already is a doc folder)
- asab-webui
- conf
- doc <<<< here is the doc folder where you want to add any broader description regarding of any component
- public
- src
- ....
btw. docs for asab-webui surely are in asab-webui/doc, but this is not the case, innit?
doc/CustomDataContainer.md
Outdated
|
|
||
| ## Setup | ||
|
|
||
| Before using this component in your project, `react-i18next`, `reactstrap` and `react-hook-form` must be installed and added into the project's `package.json` file: |
There was a problem hiding this comment.
@petrKavulok I think here it is not necessary to mention it, since it can be used only within the seacat-admin-ui or where seacat-admin-ui is used as a submodule, but in all cases, you will need to have those libraries installed by default (it is already in package.json). Other case would be if it is a reusable component of asab-webui, but it is not.
doc/CustomDataContainer.md
Outdated
| yarn add react-hook-form | ||
| ``` | ||
|
|
||
| At the moment works ONLY with `apiPath='seacat_auth'` |
There was a problem hiding this comment.
@petrKavulok Again, not necessary to mention that, since it is used only within seacat-admin ui and for that you need to have seacat_auth proxy set in general
doc/CustomDataContainer.md
Outdated
| ... | ||
|
|
||
| <CustomDataaContainer | ||
| resources={resources} |
There was a problem hiding this comment.
@petrKavulok Watch out for padding here, it is not necessary to have it that huge
doc/CustomDataContainer.md
Outdated
|
|
||
| ... | ||
|
|
||
| return ( |
There was a problem hiding this comment.
@petrKavulok Please format the example a bit better, that it is readable
… in CustomDataContainer.md
This PR