Upload Card

The Upload Card provides a visually pleasing lockup for a file upload field along with other helpful controls.


React Component

Default State (no file selected)

Upload a JPEG

Selected File State

Restrict accepted file types using accepted_file_types.

my-image-file.jpg

Upload a JPEG this is a test

Vertical (stacked) layout

The default layout will adjust from a vertical (stacked) orientation to horizontal depending on available space and/or screen size.

Setting stack_layout to true locks the component to the vertical orientation.

my-image-file.jpg

Recommended dimensions or file size requirements

Custom content areas

Instructions area

The sage_upload_card_instructions slot provides an area for extended instructions and custom markup.

Actions area

Use the sage_upload_card_actions slot to replace the default button and display custom components, such as dropdowns.

NOTE: a file input field and label are included by default in the base component, as seen in the examples above. When applying a custom file input with `sage_upload_card_actions`, set custom_file_input_field to true to remove these defaults.

Error State

Recommended dimensions or file size requirements

This is an error message.

Sage Component

SageUploadCard
<%
  dropdown_menu_items = [
    {
      value: "Upload file",
    }, {
      value: "Select recent file",
    }, {
      style: "danger",
      modifiers: ["border-before"],
      value: "Remove image",
    }
  ]
%>

<h3>Default State (no file selected)</h3>

<%= sage_component SageUploadCard, {
  id: "upload-card-default",
  selection_label: "Select file",
} do %>
  <% content_for :sage_upload_card_instructions do %>
    <p>Upload a JPEG</p>
  <% end %>
<% end %>

<h3>Selected File State</h3>

<p>Restrict accepted file types using <code>accepted_file_types</code>.</p>

<%= sage_component SageUploadCard, {
  accepted_files: [
    {name: "my-image-file.jpg"},
  ],
  file_selected: true,
  accepted_file_types: ["image/jpg"],
  selection_preview: "https://placekitten.com/360",
  selection_label: "Replace file",
  id: "upload-card-selected",
} do %>
  <% content_for :sage_upload_card_instructions do %>
    <p>Upload a JPEG this is a test</p>
  <% end %>
<% end %>


<h3>Vertical (stacked) layout</h3>
<p>The default layout will adjust from a vertical (stacked) orientation to horizontal depending on available space and/or screen size.</p>

<p>Setting <code>stack_layout</code> to <code>true</code> locks the component to the vertical orientation.</p>

<%= sage_component SageUploadCard, {
  accepted_files: [
    {name: "my-image-file.jpg"},
  ],
  file_selected: true,
  selection_preview: "https://placekitten.com/360",
  stack_layout: true,
  id: "upload-card-stack",
  selection_label: "Edit file",
} do %>
  <% content_for :sage_upload_card_instructions do %>
    <p>Recommended dimensions or file size requirements</p>
  <% end %>
<% end %>

<h3>Custom content areas</h3>
<h4>Instructions area</h4>
<p>The <code>sage_upload_card_instructions</code> slot provides an area for  extended instructions and custom markup.</p>

<h4>Actions area</h4>
<p>Use the <code>sage_upload_card_actions</code> slot to replace the default button and display custom components, such as dropdowns.</p>
<p><strong>NOTE:</strong> a file input field and label are <em>included by default in the base component</em>, as seen in the examples above. When applying a custom file input with `sage_upload_card_actions`, set <code>custom_file_input_field</code> to <code>true</code> to remove these defaults.</p>
<%= sage_component SageUploadCard, {
  accepted_files: [
    {name: "fluffy-kitteh.jpg"},
  ],
  custom_file_input_field: true,
  file_selected: true,
  selection_preview: "https://placekitten.com/360",
  id: "upload-card-dropdown"
} do %>
  <% content_for :sage_upload_card_actions do %>
    <%= sage_component SageDropdown, { items: dropdown_menu_items } do %>
      <% content_for :sage_dropdown_trigger, flush: true do %>
        <%= sage_component SageButton, {
          style: "secondary",
          icon: { name: "caret-down", style: "right" },
          value: "Edit file",
        } %>
      <% end %>
    <% end %>
  <% end %>
<% end %>


<h3>Error State</h3>

<%= sage_component SageUploadCard, {
  has_error: true,
  id: "upload-card-error",
  selection_label: "Select a file",
  errors: [
    {text: "This is an error message."},
  ]
} do %>
  <% content_for :sage_upload_card_instructions do %>
    <p>Recommended dimensions or file size requirements</p>
  <% end %>
<% end %>
Property Description Type Default

accepted_files

Array containing file information

Array<{
  name: String,
  size: String,
}>

nil

errors

Array containing error messages

Array<{
  text: String,
}>

nil

file_selected

Adjusts UI to selected state when file is selected

Boolean

nil

has_error

Adjusts UI to error state

Boolean

nil

selection_label

Text for upload button

String

nil

selection_subtext

Small text to provide additional information

String

nil