From 277e40ae173c70ec3509a20a2527cc62af71204e Mon Sep 17 00:00:00 2001 From: Murderlon Date: Mon, 6 May 2024 12:37:30 +0200 Subject: [PATCH 1/4] Remove redundant `target` option from docs --- README.md | 4 ++-- docs/guides/migration-guides.md | 6 ++---- docs/sources/audio.mdx | 6 ++---- docs/sources/companion-plugins/box.mdx | 7 +++---- docs/sources/companion-plugins/dropbox.mdx | 7 +++---- docs/sources/companion-plugins/facebook.mdx | 5 +---- docs/sources/companion-plugins/google-drive.mdx | 5 +---- docs/sources/companion-plugins/instagram.mdx | 5 +---- docs/sources/companion-plugins/onedrive.mdx | 5 +---- docs/sources/companion-plugins/unsplash.mdx | 5 +---- docs/sources/companion-plugins/url.mdx | 7 +++---- docs/sources/companion-plugins/zoom.mdx | 7 +++---- docs/sources/screen-capture.mdx | 6 ++---- docs/sources/webcam.mdx | 6 ++---- docs/user-interfaces/elements/image-editor.mdx | 4 ++-- packages/@uppy/image-editor/README.md | 5 +---- 16 files changed, 30 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index a0d7b464ee..7d558c0509 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ import Tus from '@uppy/tus' const uppy = new Uppy() .use(Dashboard, { trigger: '#select-files' }) .use(RemoteSources, { companionUrl: 'https://companion.uppy.io' }) - .use(Webcam, { target: Dashboard }) - .use(ImageEditor, { target: Dashboard }) + .use(Webcam) + .use(ImageEditor) .use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' }) .on('complete', (result) => { console.log('Upload result:', result) diff --git a/docs/guides/migration-guides.md b/docs/guides/migration-guides.md index ca09b5f75f..4413da8fea 100644 --- a/docs/guides/migration-guides.md +++ b/docs/guides/migration-guides.md @@ -60,16 +60,14 @@ new Uppy() companionAllowedHosts: COMPANION_ALLOWED_HOSTS, }) .use(Webcam, { - target: Dashboard, showVideoSourceDropdown: true, showRecordingLength: true, }) .use(Audio, { - target: Dashboard, showRecordingLength: true, }) - .use(ScreenCapture, { target: Dashboard }) - .use(ImageEditor, { target: Dashboard }) + .use(ScreenCapture) + .use(ImageEditor) .use(Transloadit, { service: 'https://api2.transloadit.com', async getAssemblyOptions(file) { diff --git a/docs/sources/audio.mdx b/docs/sources/audio.mdx index 0a612cfcc4..343b1b80ed 100644 --- a/docs/sources/audio.mdx +++ b/docs/sources/audio.mdx @@ -50,7 +50,7 @@ yarn add @uppy/audio import { Uppy, Dashboard, Audio } from "{{UPPY_JS_URL}}" const uppy = new Uppy() uppy.use(Dashboard, { inline: true, target: 'body' }) - uppy.use(Audio, { target: Uppy.Dashboard }) + uppy.use(Audio) `} @@ -67,9 +67,7 @@ import '@uppy/core/dist/style.min.css'; import '@uppy/dashboard/dist/style.min.css'; import '@uppy/audio/dist/style.min.css'; -new Uppy() - .use(Dashboard, { inline: true, target: 'body' }) - .use(Audio, { target: Dashboard }); +new Uppy().use(Dashboard, { inline: true, target: 'body' }).use(Audio); ``` ### API diff --git a/docs/sources/companion-plugins/box.mdx b/docs/sources/companion-plugins/box.mdx index 695a0579cd..155584ee5e 100644 --- a/docs/sources/companion-plugins/box.mdx +++ b/docs/sources/companion-plugins/box.mdx @@ -76,10 +76,9 @@ import Box from '@uppy/box'; import '@uppy/core/dist/style.min.css'; import '@uppy/dashboard/dist/style.min.css'; -new Uppy().use(Dashboard, { inline: true, target: '#dashboard' }).use(Box, { - target: Dashboard, - companionUrl: 'https://your-companion.com', -}); +new Uppy() + .use(Dashboard, { inline: true, target: '#dashboard' }) + .use(Box, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/companion-plugins/dropbox.mdx b/docs/sources/companion-plugins/dropbox.mdx index 4ac6b712ec..6717ea1f52 100644 --- a/docs/sources/companion-plugins/dropbox.mdx +++ b/docs/sources/companion-plugins/dropbox.mdx @@ -76,10 +76,9 @@ import Dropbox from '@uppy/dropbox'; import '@uppy/core/dist/style.min.css'; import '@uppy/dashboard/dist/style.min.css'; -new Uppy().use(Dashboard, { inline: true, target: '#dashboard' }).use(Dropbox, { - target: Dashboard, - companionUrl: 'https://your-companion.com', -}); +new Uppy() + .use(Dashboard, { inline: true, target: '#dashboard' }) + .use(Dropbox, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/companion-plugins/facebook.mdx b/docs/sources/companion-plugins/facebook.mdx index 40927d7c66..4e5504ce0a 100644 --- a/docs/sources/companion-plugins/facebook.mdx +++ b/docs/sources/companion-plugins/facebook.mdx @@ -78,10 +78,7 @@ import '@uppy/dashboard/dist/style.min.css'; new Uppy() .use(Dashboard, { inline: true, target: '#dashboard' }) - .use(Facebook, { - target: Dashboard, - companionUrl: 'https://your-companion.com', - }); + .use(Facebook, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/companion-plugins/google-drive.mdx b/docs/sources/companion-plugins/google-drive.mdx index 0c58b86e8f..cff3300f68 100644 --- a/docs/sources/companion-plugins/google-drive.mdx +++ b/docs/sources/companion-plugins/google-drive.mdx @@ -78,10 +78,7 @@ import '@uppy/dashboard/dist/style.min.css'; new Uppy() .use(Dashboard, { inline: true, target: '#dashboard' }) - .use(GoogleDrive, { - target: Dashboard, - companionUrl: 'https://your-companion.com', - }); + .use(GoogleDrive, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/companion-plugins/instagram.mdx b/docs/sources/companion-plugins/instagram.mdx index 8a032ed615..22aa95e656 100644 --- a/docs/sources/companion-plugins/instagram.mdx +++ b/docs/sources/companion-plugins/instagram.mdx @@ -78,10 +78,7 @@ import '@uppy/dashboard/dist/style.min.css'; new Uppy() .use(Dashboard, { inline: true, target: '#dashboard' }) - .use(Instagram, { - target: Dashboard, - companionUrl: 'https://your-companion.com', - }); + .use(Instagram, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/companion-plugins/onedrive.mdx b/docs/sources/companion-plugins/onedrive.mdx index e88397f6bd..1e565ee46a 100644 --- a/docs/sources/companion-plugins/onedrive.mdx +++ b/docs/sources/companion-plugins/onedrive.mdx @@ -78,10 +78,7 @@ import '@uppy/dashboard/dist/style.min.css'; new Uppy() .use(Dashboard, { inline: true, target: '#dashboard' }) - .use(OneDrive, { - target: Dashboard, - companionUrl: 'https://your-companion.com', - }); + .use(OneDrive, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/companion-plugins/unsplash.mdx b/docs/sources/companion-plugins/unsplash.mdx index 6e8da0d745..769819b9fe 100644 --- a/docs/sources/companion-plugins/unsplash.mdx +++ b/docs/sources/companion-plugins/unsplash.mdx @@ -78,10 +78,7 @@ import '@uppy/dashboard/dist/style.min.css'; new Uppy() .use(Dashboard, { inline: true, target: '#dashboard' }) - .use(Unsplash, { - target: Dashboard, - companionUrl: 'https://your-companion.com', - }); + .use(Unsplash, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/companion-plugins/url.mdx b/docs/sources/companion-plugins/url.mdx index 8ad4d207da..34a21a172f 100644 --- a/docs/sources/companion-plugins/url.mdx +++ b/docs/sources/companion-plugins/url.mdx @@ -83,10 +83,9 @@ import Url from '@uppy/url'; import '@uppy/core/dist/style.min.css'; import '@uppy/dashboard/dist/style.min.css'; -new Uppy().use(Dashboard, { inline: true, target: '#dashboard' }).use(Url, { - target: Dashboard, - companionUrl: 'https://your-companion.com', -}); +new Uppy() + .use(Dashboard, { inline: true, target: '#dashboard' }) + .use(Url, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/companion-plugins/zoom.mdx b/docs/sources/companion-plugins/zoom.mdx index 141bf151b6..7e7d7003d4 100644 --- a/docs/sources/companion-plugins/zoom.mdx +++ b/docs/sources/companion-plugins/zoom.mdx @@ -76,10 +76,9 @@ import Zoom from '@uppy/zoom'; import '@uppy/core/dist/style.min.css'; import '@uppy/dashboard/dist/style.min.css'; -new Uppy().use(Dashboard, { inline: true, target: '#dashboard' }).use(Zoom, { - target: Dashboard, - companionUrl: 'https://your-companion.com', -}); +new Uppy() + .use(Dashboard, { inline: true, target: '#dashboard' }) + .use(Zoom, { companionUrl: 'https://your-companion.com' }); ``` ### Use in Companion diff --git a/docs/sources/screen-capture.mdx b/docs/sources/screen-capture.mdx index 131ae50278..fd2689faa3 100644 --- a/docs/sources/screen-capture.mdx +++ b/docs/sources/screen-capture.mdx @@ -62,7 +62,7 @@ yarn add @uppy/screen-capture import { Uppy, Dashboard, ScreenCapture } from "{{UPPY_JS_URL}}" const uppy = new Uppy() uppy.use(Dashboard, { inline: true, target: 'body' }) - uppy.use(ScreenCapture, { target: Uppy.Dashboard }) + uppy.use(ScreenCapture) `} @@ -79,9 +79,7 @@ import '@uppy/core/dist/style.min.css'; import '@uppy/dashboard/dist/style.min.css'; import '@uppy/screen-capture/dist/style.min.css'; -new Uppy() - .use(Dashboard, { inline: true, target: 'body' }) - .use(ScreenCapture, { target: Dashboard }); +new Uppy().use(Dashboard, { inline: true, target: 'body' }).use(ScreenCapture); ``` ### API diff --git a/docs/sources/webcam.mdx b/docs/sources/webcam.mdx index 8df2bf2234..d1b550c514 100644 --- a/docs/sources/webcam.mdx +++ b/docs/sources/webcam.mdx @@ -51,7 +51,7 @@ yarn add @uppy/webcam import { Uppy, Dashboard, Webcam } from "{{UPPY_JS_URL}}" const uppy = new Uppy() uppy.use(Dashboard, { inline: true, target: 'body' }) - uppy.use(Webcam, { target: Uppy.Dashboard }) + uppy.use(Webcam) `} @@ -77,9 +77,7 @@ import '@uppy/core/dist/style.min.css'; import '@uppy/dashboard/dist/style.min.css'; import '@uppy/webcam/dist/style.min.css'; -new Uppy() - .use(Dashboard, { inline: true, target: 'body' }) - .use(Webcam, { target: Dashboard }); +new Uppy().use(Dashboard, { inline: true, target: 'body' }).use(Webcam); ``` ## API diff --git a/docs/user-interfaces/elements/image-editor.mdx b/docs/user-interfaces/elements/image-editor.mdx index 255038693e..033dd635ee 100644 --- a/docs/user-interfaces/elements/image-editor.mdx +++ b/docs/user-interfaces/elements/image-editor.mdx @@ -48,7 +48,7 @@ yarn add @uppy/core @uppy/dashboard @uppy/image-editor import { Uppy, Dashboard, ImageEditor } from "{{UPPY_JS_URL}}" const uppy = new Uppy() uppy.use(Dashboard, { target: '#uppy', inline: true }) - uppy.use(ImageEditor, { target: Uppy.Dashboard }) + uppy.use(ImageEditor) `} @@ -67,7 +67,7 @@ import '@uppy/image-editor/dist/style.min.css'; new Uppy() .use(Dashboard, { inline: true, target: '#dashboard' }) - .use(ImageEditor, { target: Dashboard }); + .use(ImageEditor); ``` ## API diff --git a/packages/@uppy/image-editor/README.md b/packages/@uppy/image-editor/README.md index 38185b2a2a..56628466d0 100644 --- a/packages/@uppy/image-editor/README.md +++ b/packages/@uppy/image-editor/README.md @@ -27,10 +27,7 @@ import ImageEditor from '@uppy/image-editor' const uppy = new Uppy() uppy.use(Dashboard) -uppy.use(ImageEditor, { - target: Dashboard, - quality: 0.7, -}) +uppy.use(ImageEditor, { quality: 0.7 }) ``` ## Installation From 7eb6b6da7e009a204f420607b8b734880097e599 Mon Sep 17 00:00:00 2001 From: Murderlon Date: Mon, 6 May 2024 12:48:14 +0200 Subject: [PATCH 2/4] Document `target` consistently --- docs/presets/remote-sources.mdx | 2 +- docs/sources/audio.mdx | 4 ++-- docs/sources/companion-plugins/box.mdx | 2 +- docs/sources/companion-plugins/dropbox.mdx | 2 +- docs/sources/companion-plugins/facebook.mdx | 2 +- docs/sources/companion-plugins/google-drive.mdx | 2 +- docs/sources/companion-plugins/instagram.mdx | 2 +- docs/sources/companion-plugins/onedrive.mdx | 2 +- docs/sources/companion-plugins/unsplash.mdx | 2 +- docs/sources/companion-plugins/url.mdx | 2 +- docs/sources/companion-plugins/zoom.mdx | 2 +- docs/sources/screen-capture.mdx | 4 ++-- docs/sources/webcam.mdx | 4 ++-- docs/user-interfaces/elements/drop-target.mdx | 2 +- docs/user-interfaces/elements/status-bar.mdx | 4 ++-- 15 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/presets/remote-sources.mdx b/docs/presets/remote-sources.mdx index 8c7655621c..5df0f18d1f 100644 --- a/docs/presets/remote-sources.mdx +++ b/docs/presets/remote-sources.mdx @@ -135,7 +135,7 @@ default: `same-origin`). #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: `Dashboard`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). [`request.credentials` value]: https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials diff --git a/docs/sources/audio.mdx b/docs/sources/audio.mdx index 343b1b80ed..c055267f7e 100644 --- a/docs/sources/audio.mdx +++ b/docs/sources/audio.mdx @@ -85,8 +85,8 @@ Configures the title / name shown in the UI, for instance, on Dashboard tabs #### `target` -DOM element, CSS selector, or plugin to place the audio into (`string` or -`Element`, default: `null`). +DOM element, CSS selector, or plugin to place the drag and drop area into +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `showAudioSourceDropdown` diff --git a/docs/sources/companion-plugins/box.mdx b/docs/sources/companion-plugins/box.mdx index 155584ee5e..3dc8f5202d 100644 --- a/docs/sources/companion-plugins/box.mdx +++ b/docs/sources/companion-plugins/box.mdx @@ -149,7 +149,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/dropbox.mdx b/docs/sources/companion-plugins/dropbox.mdx index 6717ea1f52..be74028aec 100644 --- a/docs/sources/companion-plugins/dropbox.mdx +++ b/docs/sources/companion-plugins/dropbox.mdx @@ -148,7 +148,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/facebook.mdx b/docs/sources/companion-plugins/facebook.mdx index 4e5504ce0a..6729f436dc 100644 --- a/docs/sources/companion-plugins/facebook.mdx +++ b/docs/sources/companion-plugins/facebook.mdx @@ -145,7 +145,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/google-drive.mdx b/docs/sources/companion-plugins/google-drive.mdx index cff3300f68..1b067f968d 100644 --- a/docs/sources/companion-plugins/google-drive.mdx +++ b/docs/sources/companion-plugins/google-drive.mdx @@ -149,7 +149,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/instagram.mdx b/docs/sources/companion-plugins/instagram.mdx index 22aa95e656..44815db918 100644 --- a/docs/sources/companion-plugins/instagram.mdx +++ b/docs/sources/companion-plugins/instagram.mdx @@ -139,7 +139,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/onedrive.mdx b/docs/sources/companion-plugins/onedrive.mdx index 1e565ee46a..1e6db52a74 100644 --- a/docs/sources/companion-plugins/onedrive.mdx +++ b/docs/sources/companion-plugins/onedrive.mdx @@ -139,7 +139,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/unsplash.mdx b/docs/sources/companion-plugins/unsplash.mdx index 769819b9fe..af3be75035 100644 --- a/docs/sources/companion-plugins/unsplash.mdx +++ b/docs/sources/companion-plugins/unsplash.mdx @@ -124,7 +124,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/url.mdx b/docs/sources/companion-plugins/url.mdx index 34a21a172f..ade3da05f3 100644 --- a/docs/sources/companion-plugins/url.mdx +++ b/docs/sources/companion-plugins/url.mdx @@ -109,7 +109,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/zoom.mdx b/docs/sources/companion-plugins/zoom.mdx index 7e7d7003d4..e5b8b82e0c 100644 --- a/docs/sources/companion-plugins/zoom.mdx +++ b/docs/sources/companion-plugins/zoom.mdx @@ -120,7 +120,7 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string` or `Element`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/screen-capture.mdx b/docs/sources/screen-capture.mdx index fd2689faa3..695d8cbfb4 100644 --- a/docs/sources/screen-capture.mdx +++ b/docs/sources/screen-capture.mdx @@ -97,8 +97,8 @@ Configures the title / name shown in the UI, for instance, on Dashboard tabs #### `target` -DOM element, CSS selector, or plugin to place the screen capture into (`string` -or `Element`, default: `null`). +DOM element, CSS selector, or plugin to place the drag and drop area into +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `displayMediaConstraints` diff --git a/docs/sources/webcam.mdx b/docs/sources/webcam.mdx index d1b550c514..cc23637a01 100644 --- a/docs/sources/webcam.mdx +++ b/docs/sources/webcam.mdx @@ -90,8 +90,8 @@ A unique identifier for this plugin (`string`, default: `'Webcam'`). #### `target` -DOM element, CSS selector, or plugin to place the webcam into (`string` or -`Element`, default: `null`). +DOM element, CSS selector, or plugin to place the drag and drop area into +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `countdown` diff --git a/docs/user-interfaces/elements/drop-target.mdx b/docs/user-interfaces/elements/drop-target.mdx index 9a891eec4d..a5f958d165 100644 --- a/docs/user-interfaces/elements/drop-target.mdx +++ b/docs/user-interfaces/elements/drop-target.mdx @@ -103,7 +103,7 @@ Event listener for the [`drop` event][]. #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: `null`). +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). [`dragover` event]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dragover_event diff --git a/docs/user-interfaces/elements/status-bar.mdx b/docs/user-interfaces/elements/status-bar.mdx index 663414f22b..487707433f 100644 --- a/docs/user-interfaces/elements/status-bar.mdx +++ b/docs/user-interfaces/elements/status-bar.mdx @@ -82,8 +82,8 @@ Use this if you need to add several StatusBar instances. #### `target` -DOM element, CSS selector, or plugin to mount the Status Bar into (`Element`, -`string`, `UIPlugin`, default: `'body'`). +DOM element, CSS selector, or plugin to place the drag and drop area into +(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). #### `hideAfterFinish` From ab1165aa672f3101402942877ea776558fc672fe Mon Sep 17 00:00:00 2001 From: Murderlon Date: Mon, 6 May 2024 12:53:25 +0200 Subject: [PATCH 3/4] Format --- docs/presets/remote-sources.mdx | 3 ++- docs/sources/audio.mdx | 3 ++- docs/sources/companion-plugins/box.mdx | 3 ++- docs/sources/companion-plugins/dropbox.mdx | 3 ++- docs/sources/companion-plugins/facebook.mdx | 3 ++- docs/sources/companion-plugins/google-drive.mdx | 3 ++- docs/sources/companion-plugins/instagram.mdx | 3 ++- docs/sources/companion-plugins/onedrive.mdx | 3 ++- docs/sources/companion-plugins/unsplash.mdx | 3 ++- docs/sources/companion-plugins/url.mdx | 3 ++- docs/sources/companion-plugins/zoom.mdx | 3 ++- docs/sources/screen-capture.mdx | 3 ++- docs/sources/webcam.mdx | 3 ++- docs/user-interfaces/elements/drop-target.mdx | 3 ++- docs/user-interfaces/elements/status-bar.mdx | 3 ++- 15 files changed, 30 insertions(+), 15 deletions(-) diff --git a/docs/presets/remote-sources.mdx b/docs/presets/remote-sources.mdx index 5df0f18d1f..1169bf90ab 100644 --- a/docs/presets/remote-sources.mdx +++ b/docs/presets/remote-sources.mdx @@ -135,7 +135,8 @@ default: `same-origin`). #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). [`request.credentials` value]: https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials diff --git a/docs/sources/audio.mdx b/docs/sources/audio.mdx index c055267f7e..c9528d3f22 100644 --- a/docs/sources/audio.mdx +++ b/docs/sources/audio.mdx @@ -86,7 +86,8 @@ Configures the title / name shown in the UI, for instance, on Dashboard tabs #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `showAudioSourceDropdown` diff --git a/docs/sources/companion-plugins/box.mdx b/docs/sources/companion-plugins/box.mdx index 3dc8f5202d..df35317e58 100644 --- a/docs/sources/companion-plugins/box.mdx +++ b/docs/sources/companion-plugins/box.mdx @@ -149,7 +149,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/dropbox.mdx b/docs/sources/companion-plugins/dropbox.mdx index be74028aec..b5c52dd86c 100644 --- a/docs/sources/companion-plugins/dropbox.mdx +++ b/docs/sources/companion-plugins/dropbox.mdx @@ -148,7 +148,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/facebook.mdx b/docs/sources/companion-plugins/facebook.mdx index 6729f436dc..059f68c45e 100644 --- a/docs/sources/companion-plugins/facebook.mdx +++ b/docs/sources/companion-plugins/facebook.mdx @@ -145,7 +145,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/google-drive.mdx b/docs/sources/companion-plugins/google-drive.mdx index 1b067f968d..3685c7ddc9 100644 --- a/docs/sources/companion-plugins/google-drive.mdx +++ b/docs/sources/companion-plugins/google-drive.mdx @@ -149,7 +149,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/instagram.mdx b/docs/sources/companion-plugins/instagram.mdx index 44815db918..358f184940 100644 --- a/docs/sources/companion-plugins/instagram.mdx +++ b/docs/sources/companion-plugins/instagram.mdx @@ -139,7 +139,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/onedrive.mdx b/docs/sources/companion-plugins/onedrive.mdx index 1e6db52a74..499cddb3de 100644 --- a/docs/sources/companion-plugins/onedrive.mdx +++ b/docs/sources/companion-plugins/onedrive.mdx @@ -139,7 +139,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/unsplash.mdx b/docs/sources/companion-plugins/unsplash.mdx index af3be75035..7bb1f59d14 100644 --- a/docs/sources/companion-plugins/unsplash.mdx +++ b/docs/sources/companion-plugins/unsplash.mdx @@ -124,7 +124,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/url.mdx b/docs/sources/companion-plugins/url.mdx index ade3da05f3..000ecebf38 100644 --- a/docs/sources/companion-plugins/url.mdx +++ b/docs/sources/companion-plugins/url.mdx @@ -109,7 +109,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/companion-plugins/zoom.mdx b/docs/sources/companion-plugins/zoom.mdx index e5b8b82e0c..2b38c6f5ac 100644 --- a/docs/sources/companion-plugins/zoom.mdx +++ b/docs/sources/companion-plugins/zoom.mdx @@ -120,7 +120,8 @@ Title / name shown in the UI, such as Dashboard tabs (`string`, default: #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `companionUrl` diff --git a/docs/sources/screen-capture.mdx b/docs/sources/screen-capture.mdx index 695d8cbfb4..a2329f7336 100644 --- a/docs/sources/screen-capture.mdx +++ b/docs/sources/screen-capture.mdx @@ -98,7 +98,8 @@ Configures the title / name shown in the UI, for instance, on Dashboard tabs #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `displayMediaConstraints` diff --git a/docs/sources/webcam.mdx b/docs/sources/webcam.mdx index cc23637a01..08cf5e3bf4 100644 --- a/docs/sources/webcam.mdx +++ b/docs/sources/webcam.mdx @@ -91,7 +91,8 @@ A unique identifier for this plugin (`string`, default: `'Webcam'`). #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `countdown` diff --git a/docs/user-interfaces/elements/drop-target.mdx b/docs/user-interfaces/elements/drop-target.mdx index a5f958d165..c7b37408b0 100644 --- a/docs/user-interfaces/elements/drop-target.mdx +++ b/docs/user-interfaces/elements/drop-target.mdx @@ -103,7 +103,8 @@ Event listener for the [`drop` event][]. #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). [`dragover` event]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dragover_event diff --git a/docs/user-interfaces/elements/status-bar.mdx b/docs/user-interfaces/elements/status-bar.mdx index 487707433f..b740672feb 100644 --- a/docs/user-interfaces/elements/status-bar.mdx +++ b/docs/user-interfaces/elements/status-bar.mdx @@ -83,7 +83,8 @@ Use this if you need to add several StatusBar instances. #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: [`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: +[`Dashboard`](/docs/dashboard)). #### `hideAfterFinish` From 33ed047cf27b79dcb2d6a165ac80afeaa78d63ad Mon Sep 17 00:00:00 2001 From: Murderlon Date: Tue, 7 May 2024 14:38:30 +0200 Subject: [PATCH 4/4] Undo copy paste mistake --- docs/user-interfaces/elements/drop-target.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/user-interfaces/elements/drop-target.mdx b/docs/user-interfaces/elements/drop-target.mdx index c7b37408b0..9a891eec4d 100644 --- a/docs/user-interfaces/elements/drop-target.mdx +++ b/docs/user-interfaces/elements/drop-target.mdx @@ -103,8 +103,7 @@ Event listener for the [`drop` event][]. #### `target` DOM element, CSS selector, or plugin to place the drag and drop area into -(`string`, `Element`, `Function`, or `UIPlugin`, default: -[`Dashboard`](/docs/dashboard)). +(`string`, `Element`, `Function`, or `UIPlugin`, default: `null`). [`dragover` event]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dragover_event