Browse Source

update docs with i18n strings and `title` option

Artur Paikin 6 years ago
parent
commit
ca7a3d2c57

+ 9 - 1
website/src/docs/dashboard.md

@@ -230,6 +230,8 @@ strings: {
   editFile: 'Edit file',
   // Shown in the panel header for the metadata editor. Rendered as "Editing image.png".
   editing: 'Editing %{file}',
+  // Text for a button shown on the file preview, used to edit file metadata
+  edit: 'Edit',
   // Used as the screen reader label for the button that saves metadata edits and returns to the
   // file list view.
   finishEditingFile: 'Finish editing file',
@@ -238,7 +240,7 @@ strings: {
   // Shown in the main dashboard area when no files have been selected, and one or more
   // remote provider plugins are in use. %{browse} is replaced with a link that opens the system
   // file selection dialog.
-  dropPasteImport: 'Drop files here, paste, import from one of the locations above or %{browse}',
+  dropPasteImport: 'Drop files here, paste, %{browse} or import from',
   // Shown in the main dashboard area when no files have been selected, and no provider
   // plugins are in use. %{browse} is replaced with a link that opens the system
   // file selection dialog.
@@ -255,6 +257,12 @@ strings: {
   // Used as the hover text and screen reader label for the buttons to retry failed uploads.
   retryUpload: 'Retry upload',
 
+  // Used in a title, how many files are currently selected
+  xFilesSelected: {
+    0: '%{smart_count} file selected',
+    1: '%{smart_count} files selected'
+  },
+
   // @uppy/status-bar strings:
   uploading: 'Uploading',
   complete: 'Complete'

+ 4 - 0
website/src/docs/dropbox.md

@@ -47,6 +47,10 @@ uppy.use(Dropbox, {
 
 A unique identifier for this plugin. Defaults to `'Dropbox'`.
 
+### `title: 'Dropbox'`
+
+Title / name shown in the UI, such as Dashboard tabs. It defaults to `'Dropbox'`.
+
 ### `target: null`
 
 DOM element, CSS selector, or plugin to mount the Dropbox provider into. This should normally be the Dashboard.

+ 4 - 0
website/src/docs/google-drive.md

@@ -47,6 +47,10 @@ uppy.use(GoogleDrive, {
 
 A unique identifier for this plugin. Defaults to `'GoogleDrive'`.
 
+### `title: 'Google Drive'`
+
+Title / name shown in the UI, such as Dashboard tabs. It defaults to `'Google Drive'`.
+
 ### `target: null`
 
 DOM element, CSS selector, or plugin to mount the Google Drive provider into. This should normally be the the [`@uppy/dashboard`](/docs/dashboard) plugin.

+ 4 - 0
website/src/docs/instagram.md

@@ -49,6 +49,10 @@ uppy.use(Instagram, {
 
 A unique identifier for this plugin. Defaults to `'Instagram'`.
 
+### `title: 'Instagram'`
+
+Title / name shown in the UI, such as Dashboard tabs. It defaults to `'Instagram'`.
+
 ### `target: null`
 
 DOM element, CSS selector, or plugin to mount the Instagram provider into. This should normally be the Dashboard.

+ 4 - 0
website/src/docs/url.md

@@ -48,6 +48,10 @@ uppy.use(Url, {
 
 A unique identifier for this plugin. Defaults to `'Url'`.
 
+### `title: 'Link'`
+
+Title / name shown in the UI, such as Dashboard tabs. It defaults to `'Link'`.
+
 ### `target: null`
 
 DOM element, CSS selector, or plugin to mount the Url provider into. This should normally be the Dashboard.

+ 4 - 0
website/src/docs/webcam.md

@@ -60,6 +60,10 @@ uppy.use(Webcam, {
 
 A unique identifier for this plugin. It defaults to `'Webcam'`.
 
+### `title: 'Camera'`
+
+Title / name shown in the UI, such as Dashboard tabs. It defaults to `'Camera'`.
+
 ### `target: null`
 
 DOM element, CSS selector, or plugin to mount Webcam into.