Components
/
S3 Uploader
Getting Started
Tutorials
Datasources
Functions
Spaces
Components
Self Hosted
Settings

S3 Uploader

Upload files into your S3 bucket with the S3 uploader component. This component lets you build tools that can upload files.

Ways to use a S3 uploader

Upload images to be displayed

If you're uploading images, you can bind an image component to your s3 bucket to display what is being uploaded.

Example:
You’re building a tool to manage the promotional banner displayed in your app. You add an S3 uploader that will allow the user to upload new banner images. Then, you bind an image component to the S3 bucket, so that the user can preview the image they just uploaded.

Store docs and other files

Build tools for storing all types of files.

Example:
You need a tool to store scanned employee documents for HR records. You can use an s3 uploader here and then bind a table to the s3 bucket so that users can browse through uploaded files.

Configuring your s3 uploader

Data

Simply select the S3 bucket that you want your files to be uploaded to (after you've connected s3).

You can customize the button text and add an optional icon.

Visibility Rules

You can create visibility rules that will determine when this component is visible and able to be interacted with.

Effects

Display Message

This effect allows you to define the text of messages for success and failure of submission of the data from the component.

  • On Successful Submit - Message to be displayed in a green-colored JavaScript alert message that will show in the UI on successful completion of the transaction between Internal and the target data source.
  • On Failed Submit - Message to be displayed in a red-colored JavaScript alert message that will show when the transaction fails.

It's also important to note that not including a message will fall back to the "system message" for that component. In the case of a success, this usually produces a JavaScript alert that says "Success" and not much else. In the case of failure, this can be a custom error message added to the meta data transformer in the function editor.

Additionally, only one message is allowed to be configured per function success and one for failure.

Refresh Component

Usually, if your import changes some data that is‍ displayed in the Space, you'll want to refresh the data. On Submit: Refresh Component options allow you to refresh the data of any component in the Space. Simply select the component to refresh from the dropdown. When the submission from your button is successfully complete, the selected component will refresh and display any changes to its data.

Auto Update by Key

This is the default state for "Effects" for this component. When the component submits its data successfully, components that are bound to that function will automatically be updated by key (e.g. Sending an email-address update to a user's table should result in the updating of associated row table data associated with that key.)

Design

Left and Top options only appear for top-level components (components that are placed directly onto the Space canvas).

Left: Set the distance of this component from the left edge of the Space canvas (x-axis position). This can be expressed as a % of the canvas or as a number of pixels.

Top: Set the distance of this component from the top edge of the Space canvas (y-axis position). This can be expressed as a % of the canvas or as a number of pixels.

Width: Set the width of this component as a number of pixels or as a % of the containing unit.

Height: Set the height of this component as a number of pixels or as a % of the containing unit.

If the component is a top-level component, the containing unit is the Space canvas.

If the component is in-line within another component, the containing unit is the parent component.

If the component is within a flexbox component, the containing unit is the flexbox.

Snap to Grid: Set the edges of this component to snap to the grid canvas in the Space.