* fix/10900-textarea * Update steps.md Made necessary formatting changes to docs/docs/widgets/steps.md file * Update steps.md in versioned docs Made necessary changes to steps.md in 2.50.0 LTS versioned docs * Updated the documentation for the Link Component * fix: fx bold * Update link.md * Update link.md * Update textarea.md * Update textarea.md * [docs]: Fix documentation for the map component (#11160) * [docs]: Fix documentation for pagination component (#11145) * [docs]: Fix documentation for color picker component (#11105) * Update color-picker.md * Update color-picker.md * Update color-picker.md * Update color-picker.md * Update color-picker.md * Update color-picker.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Fix documentation for the Date-Range Picker Component (#11020) * updated ToolJet/docs/docs/widgets/date-range-picker.md * updated ToolJet/docs/versioned_docs/version-2.50.0-LTS/widgets/date-range-picker.md * removed paddingbottom and renaming widget * Update date-range-picker.md * Update date-range-picker.md * Update date-range-picker.md * Update date-range-picker.md * Update date-range-picker.md * Update date-range-picker.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Fix documentation for the Button Component (#11073) * chore: replaced `fx` to **fx**, removed padding-bottom from h2(## created) div, updated content for Event Table events description in button.md * Update button.md * Update button.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * fix : made required changes in radio-button-component (#11094) * [docs]: Fix documentation for the Circular Progressbar Component (#11091) * Update circular-progressbar.md Update according to the instructions * Update circular-progressbar.md Updated according to the instructions * Update circular-progressbar.md added a divider before the styles section * Update circular-progressbar.md added a divider before the styles section * Update circular-progressbar.md * Update circular-progressbar.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Fix documentation for tabs components (#11125) * Update documentation for tabs component Issue link - https://github.com/ToolJet/ToolJet/issues/11060 * Update documentation for ToolJet/docs/versioned_docs/version-2.50.0-LTS/widgets/tabs.md * Update tabs.md * Update tabs.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * #fixes Refactor InviteUsersForm component to support dark mode (#10869) * [docs]: Fix documentation for Code Editor Component (#11027) * docs: update component info and styling * Revert "docs: update component info and styling" This reverts commitd0e047a549. * docs(revised): update component info and styling * Update code-editor.md * Update code-editor.md * fix * chore: typo and linting * Update code-editor.md * Update code-editor.md * Update code-editor.md * Update code-editor.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Fix documentation for the Bounded Box Component (#11110) * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md * Update bounded-box.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs] : Updated documentation for File Picker Component (#11174) * Updated File-Picker * Update file-picker.md * Update file-picker.md * Update file-picker.md * Update file-picker.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Update the documentation for the Kanban Component (#11140) * [docs]: Update the documentation for the Kanban Component * Add more updates to the Kanban component documentation * Update kanban-board.md * Update kanban-board.md * Update kanban-board.md * Update kanban-board.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Fix documentation for the Star Rating Component (#11135) * Update the documentation for the Star Rating Component * Update star-rating.md * Update star-rating.md * Update star-rating.md * Update star-rating.md * Update star-rating.md * Update star-rating.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Update the documentation for the Color Picker Component (#11191) * Update documentation in color-picker.md * Update documentation in versioned color-picker.md * Update color-picker.md * Update color-picker.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Fix documentation for the Image Component (#11138) * fix issue 11124 * updated the ToolJet/docs/docs/widgets/image.md file * [docs]: Fix documentation for Tree Select Component (#11166) * Update Tree Select Component docs: formatting and content changes * Update PR with requested changes: formatting updates and content revisions. changed "padding-top" to "paddingTop" everywhere * Update tree-select.md * Update tree-select.md --------- Co-authored-by: hahaanisha <120304035+anisha1910git@users.noreply.github.com> Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Fix documentation for the QR Scanner Component (#11142) * updating the docs to make it easier to follow * 2.50.0-LTS i make chenges and 2.5.0 deleted the chenges what i made * Exposed Variable changed on both versions * Update qr-scanner.md * Update qr-scanner.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * [docs]: Fix documentation for SVG Image component (#11144) * Updated SVG Image documentation with layout and style changes * Add divider before Styles section and update Layout and Style tables * Make the fx bold in both versions * Delete the svg-image-md file created accidentally * Update svg-image.md * Update svg-image.md --------- Co-authored-by: Pratik Agrawal <pratik@tooljet.com> * Template/utf 8 encoder and decoder (#11103) * utf-8-encoder-and-decoder * utf-8-encoder-and-decoder * utf-8-encoder-and-decoder * library-management-system (#11029) * student-management-system (#11072) * Added Template for Strong Password Generator (#11048) * Template : json formatter created (#11218) * Template/utf 8 encoder and decoder (#11103) * utf-8-encoder-and-decoder * utf-8-encoder-and-decoder * utf-8-encoder-and-decoder * library-management-system (#11029) * student-management-system (#11072) * Added Template for Strong Password Generator (#11048) * Template: Created json formatter * Delete server/templates/library-management-system/definition.json * Delete server/templates/library-management-system/manifest.json * Delete server/templates/strong-password-generator/definition.json * Delete server/templates/strong-password-generator/manifest.json * Delete server/templates/student-management-system/definition.json * Delete server/templates/student-management-system/manifest.json * Delete server/templates/utf-8-encoder-and-decoder/definition.json * Delete server/templates/utf-8-encoder-and-decoder/manifest.json --------- Co-authored-by: sahilborse18 <115134682+sahilborse@users.noreply.github.com> Co-authored-by: Virender Bhambra <77726552+VirenderBhambra@users.noreply.github.com> Co-authored-by: Aman Sharma <88098873+mnshrm@users.noreply.github.com> Co-authored-by: Prashant Rai <prashant.2023ug1115@iiitranchi.ac.in> * Template: Created SQL query formatter (#11219) * Added a template to the Tooljet Community Templates, for issue #11006 (#11382) Co-authored-by: Aspireve <steve18fernandes@gmail.com> * Merge community templates 1.1, 1.3 into 1.4 (#11502) * Setup patient records management template (#9620) * Setup base64 encoder & decoder template (#9647) * Setup base64 encoder & decoder template * Fix category mismatch * Added definition.json for base64 encoder-decoder template (#9653) * Template/utf 8 encoder and decoder (#11103) * utf-8-encoder-and-decoder * utf-8-encoder-and-decoder * utf-8-encoder-and-decoder * library-management-system (#11029) * feat(ConfigFiles): Add manifest and defintion files for digital asset management (#10830) * student-management-system (#11072) * Template: Created transporation logistics tracker (#10549) * add transportation logistics tracker folder with definition.json * add manifest.json to transportation logistics tracker * Template: Created student attendance tracker (#10023) * created:student-attendance-tracker * app with TJDB * fix:filter section visibility * Community template: Course management for online courses #9925 (#10714) * upload the template json file for course-management * update the filter functionality * Added Template for Strong Password Generator (#11048) --------- Co-authored-by: Merchant Khalid <marchantkhalid7810@gmail.com> Co-authored-by: sahilborse18 <115134682+sahilborse@users.noreply.github.com> Co-authored-by: Virender Bhambra <77726552+VirenderBhambra@users.noreply.github.com> Co-authored-by: Anas Khafaga <58850182+anasKhafaga@users.noreply.github.com> Co-authored-by: Aman Sharma <88098873+mnshrm@users.noreply.github.com> Co-authored-by: Kinski (Jiaxin) Wu <112212841+kinskiwu@users.noreply.github.com> Co-authored-by: Ankit Yadav <89698311+AnkityadavIITR@users.noreply.github.com> Co-authored-by: Prashant Rai <prashant.2023ug1115@iiitranchi.ac.in> * Added placeholder image generator template (#11433) * Added placeholder image generator template * Fix code spacing * Fix community templates and add more templates * fix ui for placeholder image generator * fix manifest file for placeholder image generator * Add remaining templates * remove patient records management template * fix AWS access key value * Optimise templates images * Fix Applicant tracking system template * Fix advanced data visualization template * Fix some more templates * Fix templates images * Update package-lock.json * Revert "Update package-lock.json" This reverts commit3bf5959550. * Update template image names * Update Library management system template * Fix Library and student management templates * Bump version to 3.1.5-ce * Change version to 3.1.1-ce --------- Co-authored-by: AkashJana18 <akashjana663@gmail.com> Co-authored-by: Manbhav Sugla <manbhav234@gmail.com> Co-authored-by: Joshua Jinu <116093853+joshua-jinu@users.noreply.github.com> Co-authored-by: Pratik Agrawal <pratik@tooljet.com> Co-authored-by: Avinash S <117369858+Avinashs7@users.noreply.github.com> Co-authored-by: kabszac <69686216+kabszac@users.noreply.github.com> Co-authored-by: Johnson Cherian <johnsonc.dev@gmail.com> Co-authored-by: Sonali Singh <93927999+Sonali9737@users.noreply.github.com> Co-authored-by: Rudraksh Gajanan Nalbalwar <126509395+rudrakshnalbalwar@users.noreply.github.com> Co-authored-by: Aman Kumar <45187207+Namchi7@users.noreply.github.com> Co-authored-by: Ishan Sawai <133170549+ishan657@users.noreply.github.com> Co-authored-by: Deepanshu Yadav <yadavdeepanshu000@gmail.com> Co-authored-by: Anas Younis <itsyunus102@gmail.com> Co-authored-by: Ayyan Shaikh <ayyan.sameer.shaikh.eren@gmail.com> Co-authored-by: Jon Pablo <38892213+JP-sDEV@users.noreply.github.com> Co-authored-by: Bhojraj Lalit Narware <105192321+bhojrajnarwae@users.noreply.github.com> Co-authored-by: Shreyas0410 <70795867+Shreyas0410@users.noreply.github.com> Co-authored-by: Muskan Saxena <121862200+MuskanSaxena6@users.noreply.github.com> Co-authored-by: Parth Dwivedi <99666524+Parth4git@users.noreply.github.com> Co-authored-by: ChinoUkaegbu <77782533+ChinoUkaegbu@users.noreply.github.com> Co-authored-by: Saurabh Gurde <128987288+SaurabhGurde@users.noreply.github.com> Co-authored-by: hahaanisha <168823401+hahaanisha@users.noreply.github.com> Co-authored-by: hahaanisha <120304035+anisha1910git@users.noreply.github.com> Co-authored-by: Arnav Singha <102987879+ArnavSingha@users.noreply.github.com> Co-authored-by: veesood <123954200+vroomvee@users.noreply.github.com> Co-authored-by: sahilborse18 <115134682+sahilborse@users.noreply.github.com> Co-authored-by: Virender Bhambra <77726552+VirenderBhambra@users.noreply.github.com> Co-authored-by: Aman Sharma <88098873+mnshrm@users.noreply.github.com> Co-authored-by: Prashant Rai <prashant.2023ug1115@iiitranchi.ac.in> Co-authored-by: Abhishek-53 <abhishekvpatil1@gmail.com> Co-authored-by: Niyatijain-9 <niyatijain9113@gmail.com> Co-authored-by: Steve Fernandes <93852415+Aspireve@users.noreply.github.com> Co-authored-by: Aspireve <steve18fernandes@gmail.com> Co-authored-by: Merchant Khalid <marchantkhalid7810@gmail.com> Co-authored-by: Anas Khafaga <58850182+anasKhafaga@users.noreply.github.com> Co-authored-by: Kinski (Jiaxin) Wu <112212841+kinskiwu@users.noreply.github.com> Co-authored-by: Ankit Yadav <89698311+AnkityadavIITR@users.noreply.github.com> Co-authored-by: Vikash <106796672+vikashsprem@users.noreply.github.com> Co-authored-by: Sherfin Shamsudeen <sherfin94@gmail.com>
6.3 KiB
| id | title |
|---|---|
| file-picker | File Picker |
File Picker
File Picker component allows the user to drag and drop files or upload files by browsing the filesystem and selecting one or more files in a directory.
:::info File types must be a valid MIME type according to input element specification or a valid file extension.
To accept any/all file type(s), set Accept file types to an empty value.
:::
:::tip MIME type determination is not reliable across platforms. CSV files, for example, are reported as text/plain under macOS but as application/vnd.ms-excel under Windows. :::
Properties
| <div style={{ width:"135px"}}> Property | <div style={{ width:"100px"}}> Description |
|---|---|
| Instruction text | Instruction text can be set to give information on the file picker. |
| Use drop zone | Creates a drag & drop zone. Files can be dragged and dropped to the "drag & drop" zone. |
| Use file picker | On clicking it invokes the default OS file prompt. |
| Pick multiple files | Allows drag and drop (or selection from the file dialog) of multiple files. Pick multiple files is disabled by default. |
| Max file count | The maximum accepted number of files The default value is 2. |
| Accept file types | By providing types, you can make the dropzone accept specific file types and reject the others. Example: {{"image/*,application/pdf,application/msword"}}. |
| Max size limit | Maximum file size (in bytes). |
| Min size limit | Minimum file size (in bytes). |
:::tip
Files can be accepted or rejected based on the file types, maximum file count, maximum file size (in bytes) and minimum file size (in bytes).
If Pick multiple files is set to false and additional files are dropped, all files besides the first will be rejected.
Any file that does not have a size in the range of Max size limit and Min size limit will be rejected.
:::
Events
| <div style={{ width:"135px"}}> Event | <div style={{ width:"100px"}}> Description |
|---|---|
| On file selected | Triggers whenever one or more files are selected by the selector dialogue box. |
| On file loaded | Triggers whenever a file is loaded in the browser. |
| On file deselected | Triggers whenever one or more files are removed from the picker. |
:::info Checkout this guide to learn how to refer or display images/PDFs using base64 string. :::
Component Specific Actions (CSA)
| Actions | Description | How To Access |
|---|---|---|
| <div style={{ width:"100px"}}> clearFiles() | Clears the selected files from the file picker component. | Employ a RunJS query (for e.g., await components.filepicker1.clearFiles()) or trigger it using an event. |
Exposed Variables
| <div style={{ width:"100px"}}> Variables | <div style={{ width:"200px"}}> Description | <div style={{ width:"200px"}}> How To Access |
|---|---|---|
| file | Holds an array of file objects loaded in the file picker, each with properties: name, type, content, dataURL, base64Data, parsedData, filePath. | Accessible dynamically with JS (for e.g., {{components.filepicker1.file[0].base64Data}}). |
Options
| <div style={{ width:"135px"}}> Option | <div style={{ width:"100px"}}> Description |
|---|---|
| Parse content | Parse the selected files, supports CSV, xls, and xlsx files. |
| File type | If Parse content is enabled, options to auto-detect files and parse content or parse selected file types. |
:::info
- If Parse content option is toggled off, File Type option will not be available.
- If the Parse content option is toggled on, it only parses the next file that is selected, not the already selected one. :::
General
Tooltip
A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component.
Under the General accordion, you can set the value in the string format. Now hovering over the component will display the string as the tooltip.
Devices
| <div style={{ width:"100px"}}> Property | <div style={{ width:"100px"}}> Description | <div style={{ width:"135px"}}> Expected Value |
|---|---|---|
| Show on desktop | Makes the component visible in desktop view. | You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
| Show on mobile | Makes the component visible in mobile view. | You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
Styles
| <div style={{ width:"100px"}}> Style | <div style={{ width:"135px"}}> Description | <div style={{ width:"100px"}}> Default Value |
|---|---|---|
| Visibility | This is to control the visibility of the component. If {{false}} the component will not visible after the app is deployed. It can only have boolean values i.e. either {{true}} or {{false}}. |
By default, it's set to {{true}}. |
| Disable | This property only accepts boolean values. If set to {{true}}, the component will be locked and becomes non-functional. |
By default, its value is set to {{false}}. |
| Border radius | Use this property to modify the border radius of the File Picker component. The field expects only numerical value from 1 to 100. |
By default, its value is set to 0. |
:::info Any property having fx button next to its field can be programmatically configured. :::