Ver Fonte

docs: clarify the `target` option in <DashboardModal />, closes #2643

Renée Kooi há 4 anos atrás
pai
commit
a1a34d97be
1 ficheiros alterados com 3 adições e 1 exclusões
  1. 3 1
      website/src/docs/react-dashboard-modal.md

+ 3 - 1
website/src/docs/react-dashboard-modal.md

@@ -43,13 +43,15 @@ Styles for Provider plugins, like Google Drive and Instagram, are also bundled w
 <a id="Options"></a>
 ## Props
 
-On top of all the [`@uppy/dashboard`][] options, the `<DashboardModal />` plugin adds two additional props:
+The `<DashboardModal />` component supports most [`@uppy/dashboard`][] options as props. It adds two more:
 
  - `open` - Boolean true or false, setting this to `true` opens the modal and setting it to `false` closes it.
  - `onRequestClose` - Callback called when the user attempts to close the modal, either by clicking the close button or by clicking outside the modal (if the `closeModalOnClickOutside` prop is set).
 
 An Uppy instance must be provided in the `uppy={}` prop: see [Initializing Uppy](/docs/react/initializing) for details.
 
+The `target={}` prop can be used to mount the Dashboard modal elsewhere in the DOM. If not given, the modal will be mounted at where the component is used. Unlike the raw [`@uppy/dashboard`][] plugin, the `<DashboardModal />` component can _only_ take DOM element objects, not CSS selectors.
+
 To use other plugins like [`@uppy/webcam`][] with the `<DashboardModal />` component, add them to the Uppy instance and then specify their `id` in the [`plugins`](/docs/dashboard/#plugins) prop:
 
 ```js