Skip to content

Commit

Permalink
docs: correctly list exported components (#5417)
Browse files Browse the repository at this point in the history
  • Loading branch information
Murderlon authored Aug 27, 2024
1 parent 0a78023 commit f6ebc52
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/framework-integrations/angular.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions docs/framework-integrations/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions docs/framework-integrations/svelte.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit f6ebc52

Please sign in to comment.