소스 검색

docs: correctly list exported components (#5417)

Merlijn Vos 7 달 전
부모
커밋
f6ebc52b5b
3개의 변경된 파일12개의 추가작업 그리고 4개의 파일을 삭제
  1. 10 4
      docs/framework-integrations/angular.mdx
  2. 1 0
      docs/framework-integrations/react.mdx
  3. 1 0
      docs/framework-integrations/svelte.mdx

+ 10 - 4
docs/framework-integrations/angular.mdx

@@ -48,10 +48,16 @@ instance can be passed into components as a `props` prop.
 
 The following plugins are available as Angular component wrappers:
 
-- `<uppy-dashboard />` renders [`@uppy/dashboard`](/docs/dashboard)
-- `<uppy-drag-drop />` renders [`@uppy/drag-drop`](/docs/drag-drop)
-- `<uppy-progress-bar />` renders [`@uppy/progress-bar`](/docs/progress-bar)
-- `<uppy-status-bar />` renders [`@uppy/status-bar`](/docs/status-bar)
+- Import `UppyAngularDashboardModule` used as `<uppy-dashboard>` renders
+  [`@uppy/dashboard`](/docs/dashboard)
+- Import `UppyAngularDashboardModalModule` used as `<uppy-dashboard-modal>`
+  renders [`@uppy/dashboard`](/docs/dashboard) as a modal
+- Import `UppyAngularProgressBarModule` used as `<uppy-progress-bar>` renders
+  [`@uppy/progress-bar`](/docs/progress-bar)
+- Import `UppyAngularStatusBarModule` used as `<uppy-status-bar>` renders
+  [`@uppy/status-bar`](/docs/status-bar)
+- Import `UppyAngularDragDropModule` used as `<uppy-drag-drop>` renders
+  [`@uppy/drag-drop`](/docs/drag-drop)
 
 Each component takes a `props` prop that will be passed to the UI Plugin.
 

+ 1 - 0
docs/framework-integrations/react.mdx

@@ -57,6 +57,7 @@ and looking at our examples below.
 The following components are exported from `@uppy/react`:
 
 - `<Dashboard />` renders [`@uppy/dashboard`](/docs/dashboard)
+- `<DashboardModal />` renders [`@uppy/dashboard`](/docs/dashboard) as a modal
 - `<DragDrop />` renders [`@uppy/drag-drop`](/docs/drag-drop)
 - `<ProgressBar />` renders [`@uppy/progress-bar`](/docs/progress-bar)
 - `<StatusBar />` renders [`@uppy/status-bar`](/docs/status-bar)

+ 1 - 0
docs/framework-integrations/svelte.mdx

@@ -41,6 +41,7 @@ You also need to install the UI plugin you want to use. For instance,
 The following plugins are available as Svelte component wrappers:
 
 - `<Dashboard />` renders [`@uppy/dashboard`](/docs/dashboard)
+- `<DashboardModal />` renders [`@uppy/dashboard`](/docs/dashboard) as a modal
 - `<DragDrop />` renders [`@uppy/drag-drop`](/docs/drag-drop)
 - `<ProgressBar />` renders [`@uppy/progress-bar`](/docs/progress-bar)
 - `<StatusBar />` renders [`@uppy/status-bar`](/docs/status-bar)