Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correctly list exported components #5417

Merged
merged 5 commits into from
Aug 27, 2024
Merged

Conversation

Murderlon
Copy link
Member

@Murderlon Murderlon commented Aug 19, 2024

Closes #5415

For angular, it's unclear whether we should document this:

- UppyAngularDashboardModule renders [`@uppy/dashboard`](/docs/dashboard)
- UppyAngularDashboardModalModule renders [`@uppy/dashboard`](/docs/dashboard) as a modal
- UppyAngularProgressBarModule renders [`@uppy/progress-bar`](/docs/progress-bar)
- UppyAngularStatusBarModule renders [`@uppy/status-bar`](/docs/status-bar)
- UppyAngularDragDropModule renders [`@uppy/drag-drop`](/docs/drag-drop)

or this

- StatusBarComponent renders [`@uppy/status-bar`](/docs/status-bar)
- ProgressBarComponent renders [`@uppy/progress-bar`](/docs/progress-bar)
- DragDropComponent renders [`@uppy/drag-drop`](/docs/drag-drop)
- DashboardComponent renders [`@uppy/dashboard`](/docs/dashboard)
- DashboardModalComponent renders [`@uppy/dashboard`](/docs/dashboard) as a modal

because we export both.

@Murderlon Murderlon requested a review from aduh95 August 19, 2024 09:04
@Murderlon Murderlon self-assigned this Aug 19, 2024
Copy link
Contributor

Diff output files
No diff

Comment on lines 51 to 52
- Import `UppyAngularDashboardModule` used as
`<uppy-dashboard> renders [`@uppy/dashboard`](/docs/dashboard)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Import `UppyAngularDashboardModule` used as
`<uppy-dashboard> renders [`@uppy/dashboard`](/docs/dashboard)
-`UppyAngularDashboardModule`, which exposes a
`<uppy-dashboard>` tag, renders [`@uppy/dashboard`](/docs/dashboard).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not an improvement imho 🤷

Co-authored-by: Antoine du Hamel <[email protected]>
@aduh95 aduh95 merged commit f6ebc52 into main Aug 27, 2024
17 checks passed
@aduh95 aduh95 deleted the framework-components-docs branch August 27, 2024 08:30
github-actions bot added a commit that referenced this pull request Aug 29, 2024
| Package                | Version | Package                | Version |
| ---------------------- | ------- | ---------------------- | ------- |
| @uppy/aws-s3           |   4.1.0 | @uppy/informer         |   4.1.0 |
| @uppy/box              |   3.1.0 | @uppy/instagram        |   4.1.0 |
| @uppy/companion        |   5.1.0 | @uppy/locales          |   4.1.0 |
| @uppy/companion-client |   4.1.0 | @uppy/onedrive         |   4.1.0 |
| @uppy/compressor       |   2.1.0 | @uppy/remote-sources   |   2.2.0 |
| @uppy/core             |   4.2.0 | @uppy/screen-capture   |   4.1.0 |
| @uppy/dashboard        |   4.1.0 | @uppy/tus              |   4.1.0 |
| @uppy/dropbox          |   4.1.0 | @uppy/unsplash         |   4.1.0 |
| @uppy/facebook         |   4.1.0 | @uppy/url              |   4.1.0 |
| @uppy/google-drive     |   4.1.0 | @uppy/xhr-upload       |   4.1.0 |
| @uppy/google-photos    |   0.3.0 | @uppy/zoom             |   3.1.0 |
| @uppy/image-editor     |   3.1.0 | uppy                   |   4.3.0 |

- @uppy/core,@uppy/dashboard: Pass container to `UIPlugin.render` for non-Preact integration (Merlijn Vos / #5437)
- @uppy/companion: do not use unsafe call to `JSON.stringify` (Antoine du Hamel / #5422)
- meta: Fix yarn.lock (Murderlon)
- @uppy/locales: Fix locale-pack for en_US (Merlijn Vos / #5431)
- meta: Add tsconfig to packages in private/ (Merlijn Vos / #5432)
- @uppy/remote-sources: support companionKeysParams (Merlijn Vos / #5434)
- @uppy/aws-s3,@uppy/box,@uppy/compressor,@uppy/dropbox,@uppy/facebook,@uppy/google-drive,@uppy/google-photos,@uppy/image-editor,@uppy/informer,@uppy/instagram,@uppy/onedrive,@uppy/screen-capture,@uppy/tus,@uppy/unsplash,@uppy/url,@uppy/xhr-upload,@uppy/zoom: export plugin options (Antoine du Hamel / #5433)
- docs: correctly list exported components (Merlijn Vos / #5417)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Indicate that @uppy/react exports DashboardModal in the docs
2 participants