Document dynamic resources #5004

Luwangel · 2020-07-03T10:56:35Z

Fixes #4629
Follows #3907

Todo

Write a section in the documentation about the and the components

…the Admin documentation

docs/Admin.md

fzaninotto · 2020-07-03T11:43:45Z

docs/Admin.md

  - [`loginPage`](#loginpage)
  - [`logoutButton`](#logoutbutton)
  - [`initialState`](#initialstate)
  - [`history`](#history)
  - [Internationalization](#internationalization)
  - [Declaring resources at runtime](#declaring-resources-at-runtime)
+    - [Use a Function As its Child](#use-a-function-as-its-child)


I don't think we should link to level 3 headers in this list

fzaninotto · 2020-07-03T11:45:25Z

docs/Admin.md

-You might want to dynamically define the resources when the app starts. The `<Admin>` component accepts a function as its child and this function can return a Promise. If you also defined an `authProvider`, the child function will receive the result of a call to `authProvider.getPermissions()` (you can read more about this in the [Authorization](./Authorization.md) chapter).
+You might want to dynamically define the resources when the app starts.
+
+### Use a Function As its Child


Suggested change

### Use a Function As its Child

### Using a Function As `<Admin>` Child

fzaninotto · 2020-07-03T11:46:12Z

docs/Admin.md

@@ -559,13 +559,16 @@ The `i18nProvider` props let you translate the GUI. The [Translation Documentati

 ## Declaring resources at runtime

-You might want to dynamically define the resources when the app starts. The `<Admin>` component accepts a function as its child and this function can return a Promise. If you also defined an `authProvider`, the child function will receive the result of a call to `authProvider.getPermissions()` (you can read more about this in the [Authorization](./Authorization.md) chapter).
+You might want to dynamically define the resources when the app starts.


This sentence alone with the section title afterwards feels odd.

fzaninotto · 2020-07-03T11:47:41Z

docs/Admin.md

@@ -595,6 +598,44 @@ const App = () => (
 );
 ```

+### Unplug the <Admin> using the `<AdminContext>` and the `<AdminUI>`
+
+Setting Resources dynamically is still very cumbersome: even if `<Admin>` accepts [a function as child](#declaring-resources-at-runtime), this function can't execute hooks.


Suggested change

Setting Resources dynamically is still very cumbersome: even if `<Admin>` accepts [a function as child](#declaring-resources-at-runtime), this function can't execute hooks.

Setting Resources dynamically using the children-as-function syntax may not be enough in all cases, because this function can't execute hooks.

fzaninotto · 2020-07-03T11:48:21Z

docs/Admin.md

+
+Setting Resources dynamically is still very cumbersome: even if `<Admin>` accepts [a function as child](#declaring-resources-at-runtime), this function can't execute hooks.
+
+So it's impossible, for instance, to have a dynamic list of resources based on a call to the dataProvider (since the dataProvider is only defined after the Admin component renders).


Suggested change

So it's impossible, for instance, to have a dynamic list of resources based on a call to the dataProvider (since the dataProvider is only defined after the Admin component renders).

So it's impossible, for instance, to have a dynamic list of resources based on a call to the `dataProvider` (since the `dataProvider` is only defined after the `<Admin>` component renders).

fzaninotto · 2020-07-03T11:48:34Z

docs/Admin.md

+
+So it's impossible, for instance, to have a dynamic list of resources based on a call to the dataProvider (since the dataProvider is only defined after the Admin component renders).
+
+To do so, you have to build your own <Admin> component using both the <AdminContext> and the <AdminUI> (as we do internally). It's straightforward.


add backticks around components

fzaninotto · 2020-07-03T11:49:22Z

docs/Admin.md

+
+So it's impossible, for instance, to have a dynamic list of resources based on a call to the dataProvider (since the dataProvider is only defined after the Admin component renders).
+
+To do so, you have to build your own <Admin> component using both the <AdminContext> and the <AdminUI> (as we do internally). It's straightforward.


Suggested change

To do so, you have to build your own <Admin> component using both the <AdminContext> and the <AdminUI> (as we do internally). It's straightforward.

To overcome this limitation, you can build your own `<Admin>` component using two lower-level components: `<AdminContext>` (responsible for putting the providers in contexts) and `<AdminUI>` (responsible for displaying the UI). Here is an example:

fzaninotto · 2020-07-03T11:52:19Z

docs/Admin.md

+    const dataProvider = useDataProvider();
+
+    useEffect(() => {
+        dataProvider.introspect().then(r => setResources(r));


introspect isn't a legal dataProvider verb, so you'll have to be more explicit here

…tant first

Fix the table of contents sorting in the Admin documentation

d1ca4c7

Luwangel added documentation RFR Ready For Review labels Jul 3, 2020

Luwangel added 2 commits July 3, 2020 12:57

Write a section about the AdminContext and the AdminUI components in …

3278594

…the Admin documentation

Fix the raw balise in the Admin documentation

d8eb7fe

Luwangel force-pushed the document-dynamic-resources branch from ebd2388 to d8eb7fe Compare July 3, 2020 10:57

fzaninotto requested changes Jul 3, 2020

View reviewed changes

Luwangel added 3 commits July 3, 2020 14:05

Remove the third level titles

ade661f

Apply review

d1c54a7

Reorder sections in the Admin documentation to display the most impor…

f6c4440

…tant first

fzaninotto approved these changes Jul 6, 2020

View reviewed changes

fzaninotto merged commit 8e83fec into master Jul 6, 2020

fzaninotto deleted the document-dynamic-resources branch July 6, 2020 10:17

fzaninotto added this to the 3.6.3 milestone Jul 6, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document dynamic resources #5004

Document dynamic resources #5004

Luwangel commented Jul 3, 2020

fzaninotto Jul 3, 2020

fzaninotto Jul 3, 2020

fzaninotto Jul 3, 2020

fzaninotto Jul 3, 2020

fzaninotto Jul 3, 2020

fzaninotto Jul 3, 2020

fzaninotto Jul 3, 2020

fzaninotto Jul 3, 2020

	### Use a Function As its Child
	### Using a Function As `<Admin>` Child

	Setting Resources dynamically is still very cumbersome: even if `<Admin>` accepts [a function as child](#declaring-resources-at-runtime), this function can't execute hooks.
	Setting Resources dynamically using the children-as-function syntax may not be enough in all cases, because this function can't execute hooks.


		Setting Resources dynamically is still very cumbersome: even if `<Admin>` accepts [a function as child](#declaring-resources-at-runtime), this function can't execute hooks.

		So it's impossible, for instance, to have a dynamic list of resources based on a call to the dataProvider (since the dataProvider is only defined after the Admin component renders).


		So it's impossible, for instance, to have a dynamic list of resources based on a call to the dataProvider (since the dataProvider is only defined after the Admin component renders).

		To do so, you have to build your own <Admin> component using both the <AdminContext> and the <AdminUI> (as we do internally). It's straightforward.

	To do so, you have to build your own <Admin> component using both the <AdminContext> and the <AdminUI> (as we do internally). It's straightforward.
	To overcome this limitation, you can build your own `<Admin>` component using two lower-level components: `<AdminContext>` (responsible for putting the providers in contexts) and `<AdminUI>` (responsible for displaying the UI). Here is an example:

Document dynamic resources #5004

Document dynamic resources #5004

Conversation

Luwangel commented Jul 3, 2020

Todo

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment