From 0b5ef78ce6a0a045d8db7a05ecc650364150c943 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Fri, 3 Dec 2021 23:34:02 +0100 Subject: [PATCH] @uppy/webcam: fix broken links in `webcam.md` This also updates files that were out of sync with the build process. --- website/src/docs/aws-s3.md | 2 +- website/src/docs/core.md | 2 +- website/src/docs/screen-capture.md | 2 +- website/src/docs/status-bar.md | 1 + website/src/docs/webcam.md | 14 +++++++++++--- 5 files changed, 15 insertions(+), 6 deletions(-) diff --git a/website/src/docs/aws-s3.md b/website/src/docs/aws-s3.md index cfbef44c7c..d68e0a6583 100644 --- a/website/src/docs/aws-s3.md +++ b/website/src/docs/aws-s3.md @@ -133,7 +133,7 @@ To allow Uppy to upload directly to a bucket, at least its CORS permissions need CORS permissions can be found in the [S3 Management Console](https://console.aws.amazon.com/s3/home). Click the bucket that will receive the uploads, then go into the `Permissions` tab and select the `CORS configuration` button. -A JSON document will be shown that defines the CORS configuration. (AWS used to use XML but now only allow JSON). More information about the [S3 CORS format here](https://docs.amazonaws.cn/en\_us/AmazonS3/latest/userguide/ManageCorsUsing.html). +A JSON document will be shown that defines the CORS configuration. (AWS used to use XML but now only allow JSON). More information about the [S3 CORS format here](https://docs.amazonaws.cn/en_us/AmazonS3/latest/userguide/ManageCorsUsing.html). A good practice is to use two CORS rules: one for viewing the uploaded files, and one for uploading files. diff --git a/website/src/docs/core.md b/website/src/docs/core.md index 22e41be1fd..9ae564c459 100644 --- a/website/src/docs/core.md +++ b/website/src/docs/core.md @@ -139,7 +139,7 @@ Optionally, provide rules and conditions to limit the type and/or number of file `maxNumberOfFiles` also affects the number of files a user is able to select via the system file dialog in UI plugins like `DragDrop`, `FileInput` and `Dashboard`: when set to `1`, they will only be able to select a single file. When `null` or another number is provided, they will be able to select several files. -`allowedFileTypes` gets passed to the system file dialog via [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#Limiting\_accepted\_file\_types)’s accept attribute, so only files matching these types will be selectable. +`allowedFileTypes` gets passed to the system file dialog via [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#Limiting_accepted_file_types)’s accept attribute, so only files matching these types will be selectable. > If you’d like to force a certain meta field data to be entered before the upload, you can [do so using `onBeforeUpload`](https://github.com/transloadit/uppy/issues/1703#issuecomment-507202561). diff --git a/website/src/docs/screen-capture.md b/website/src/docs/screen-capture.md index 60b1d7fcdf..e9e581adf8 100644 --- a/website/src/docs/screen-capture.md +++ b/website/src/docs/screen-capture.md @@ -10,7 +10,7 @@ tagline: "upload selfies or audio / video recordings" The `@uppy/screen-capture` plugin can record your screen or an application and save it as a video. -> To use the screen capture plugin in a Chromium-based browser, [your site must be served over https](https://developers.google.com/web/updates/2015/10/chrome-47-webrtc#public\_service\_announcements). This restriction does not apply on `localhost`, so you don’t have to jump through many hoops during development. +> To use the screen capture plugin in a Chromium-based browser, [your site must be served over https](https://developers.google.com/web/updates/2015/10/chrome-47-webrtc#public_service_announcements). This restriction does not apply on `localhost`, so you don’t have to jump through many hoops during development. ```js import ScreenCapture from '@uppy/screen-capture' diff --git a/website/src/docs/status-bar.md b/website/src/docs/status-bar.md index 8824489bf5..ad86d0212d 100644 --- a/website/src/docs/status-bar.md +++ b/website/src/docs/status-bar.md @@ -169,6 +169,7 @@ module.exports = { 0: '%{smart_count} more file added', 1: '%{smart_count} more files added', }, + showErrorDetails: 'Show error details', }, } diff --git a/website/src/docs/webcam.md b/website/src/docs/webcam.md index 46814badfb..6e96aa1bf7 100644 --- a/website/src/docs/webcam.md +++ b/website/src/docs/webcam.md @@ -10,7 +10,7 @@ tagline: "upload selfies or audio / video recordings" The `@uppy/webcam` plugin lets you take photos and record videos with a built-in camera on desktop and mobile devices. -> To use the Webcam plugin in Chrome, [your site must be served over https](https://developers.google.com/web/updates/2015/10/chrome-47-webrtc#public\_service\_announcements). This restriction does not apply on `localhost`, so you don’t have to jump through many hoops during development. +> To use the Webcam plugin in Chrome, [your site must be served over https](https://developers.google.com/web/updates/2015/10/chrome-47-webrtc#public_service_announcements). This restriction does not apply on `localhost`, so you don’t have to jump through many hoops during development. ```js import Webcam from '@uppy/webcam' @@ -115,9 +115,9 @@ Configures whether to mirror preview image from the camera. This option is usefu Configure the kind of video stream you would like to record. Takes an object with properties from the [MediaTrackConstraints][] interface. -You can specify acceptable ranges for the resolution of the video stream using the \[`aspectRatio`]\[aspectRatio], \[`width`]\[width], and \[`height`]\[height] properties. Each property takes an object with `{ min, ideal, max }` properties. For example, use `width: { min: 720, max: 1920, ideal: 1920 }` to allow any width between 720 and 1920 pixels wide, while preferring the highest resolution. +You can specify acceptable ranges for the resolution of the video stream using the [`aspectRatio`][], [`width`][], and [`height`][] properties. Each property takes an object with `{ min, ideal, max }` properties. For example, use `width: { min: 720, max: 1920, ideal: 1920 }` to allow any width between 720 and 1920 pixels wide, while preferring the highest resolution. -Devices sometimes have several cameras, front and back, for example. \[`facingMode`]\[facingMode] lets you specify which should be used: +Devices sometimes have several cameras, front and back, for example. [`facingMode`][] lets you specify which should be used: * `user`: The video source is facing toward the user; this includes, for example, the front-facing camera on a smartphone. * `environment`: The video source is facing away from the user, thereby viewing their environment. This is the back camera on a smartphone. @@ -128,6 +128,14 @@ For a full list of available properties, check out MDN documentation for [MediaT [MediaTrackConstraints]: https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#Properties_of_video_tracks +[`aspectRatio`]: https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/aspectRatio + +[`width`]: https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/width + +[`height`]: https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/height + +[`facingMode`]: https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/facingMode + ### `showVideoSourceDropdown: false` Configures whether to show a dropdown which enables to choose the video device to use. This option will have priority over `facingMode` if enabled. The default is `false`.