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.

Sign up for GitHub

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

Jump to bottom

feat: add documentation for filepicker element #4520

Merged
merged 5 commits into from
Nov 11, 2024
Merged

feat: add documentation for filepicker element #4520

merged 5 commits into from
Nov 11, 2024

Conversation

vsgoulart
Copy link
Contributor

Description

Documentation for new form-js element.

Related to https://github.com/camunda/product-hub/issues/2409

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@vsgoulart vsgoulart added hold This issue is parked, do not merge. 8.7.0-alpha1 November 2024 alpha release labels Oct 25, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 25, 2024 •
edited
Loading

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/components/modeler/forms/form-element-library/forms-element-library-filepicker.md
  • docs/components/modeler/forms/form-element-library/forms-element-library.md
  • docs/components/modeler/forms/sidebar-schema.js

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@volodymyr-melnykc
Copy link
Contributor

volodymyr-melnykc commented Oct 28, 2024 •
edited
Loading

I noticed that the visual preview of form component icons is very small. It's not only for a filepicker component but all form components.
The icon size is 12x12px (because the image container has a padding in 20px). It makes it difficult to recognize the icon.

Screenshot 2024-10-28 at 09 59 21

I noticed that this issue already exists in the docs (and was not introduced with this PR): https://docs.camunda.io/docs/components/modeler/forms/form-element-library/forms-element-library-text/
Yet, maybe we should fix it here?
@vsgoulart @christinaausley

@vsgoulart
Copy link
Contributor Author

@volodymyr-melnykc I'll take a look

@vsgoulart
Copy link
Contributor Author

@volodymyr-melnykc Please check the last commit

@vsgoulart
Copy link
Contributor Author

I'll make another commit fixing the previous versions too

@volodymyr-melnykc
Copy link
Contributor

@vsgoulart The form component icons look good now, thank you!

christinaausley
christinaausley previously approved these changes Oct 28, 2024
View reviewed changes
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Nice work!

@vsgoulart
Copy link
Contributor Author

Now's it's fixed on the versioned docs also

volodymyr-melnykc
volodymyr-melnykc approved these changes Nov 7, 2024
View reviewed changes
docs/components/modeler/forms/form-element-library/forms-element-library-filepicker.md

- **Field label**: Label displayed on top of the file picker. Can either be an [expression](../../feel/language-guide/feel-expressions-introduction.md), plain text, or [templating syntax](../configuration/forms-config-templating-syntax.md).
- **Supported file formats**: [Comma-separated list of supported file formats.](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers) Can either be an [expression](../../feel/language-guide/feel-expressions-introduction.md) or plain text.
- **Upload multiple files**: Allows the user to upload multiple files at once. Can be dynamically set using an [expression](../../feel/language-guide/feel-expressions-introduction.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

@vsgoulart Since this component is only for file selection, not uploading, we can call this property "Support multiple files" instead of "Upload multiple files."

@mesellings
Copy link
Contributor

@vsgoulart Are we okay to merge and release this so it is live for the release tomorrow?

@vsgoulart
Copy link
Contributor Author

@vsgoulart Are we okay to merge and release this so it is live for the release tomorrow?

@mesellings yes

Feel free to merge it

@mesellings mesellings removed the hold This issue is parked, do not merge. label Nov 11, 2024
@mesellings mesellings merged commit 261edb9 into main Nov 11, 2024
7 of 8 checks passed
@mesellings mesellings deleted the form-js-filepicker branch November 11, 2024 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christinaausley christinaausley christinaausley approved these changes

@volodymyr-melnykc volodymyr-melnykc volodymyr-melnykc approved these changes

Assignees

@vsgoulart vsgoulart

Labels
8.7.0-alpha1 November 2024 alpha release
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@vsgoulart @volodymyr-melnykc @mesellings @christinaausley