Skip navigation

Skip to main content

On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.
App components
App components

Changelog

The latest changes to the App Components.

2024-12-02

🧰 Added

  • If the size is larger than the asset SDK limit, explain to user that they cannot upload the asset directly into Canva, and suggest user to download the file in a toast notification. Please provide a fileSizeKB field for Image Video and Audio types if you have the file size information, as this will help reduce failed upload SDK calls.

🐞 Fixed

  • Fix toast notification not displayed when export has succeeded or failed.

🔧 Changed

  • When Image or Video do not have a valid thumbnail url, show an image or video icon in the place of the thumbnail.

2024-11-25

🧰 Added

  • Added translation (i18n) system to SearchableListView

🔧 Changed

  • Changed toast notification position from overlapping the app content to appearing above the content, when design export fails or success.

2024-10-31

🧰 Added

  • Exported Thumbnail type that's used for thumbnail field of Image, Video, Embed, Audio and Container.

🔧 Changed

🐞 Fixed

  • Fixed not continuing to call findResourcesCallback if the previous page has a non-empty continuation but contains only "UNKNOWN" resources.

2024-10-24

🔨 Breaking changes

  • Excluded "application/json" option from accepted VideoMimeType, as it's only accepted by @canva/assets for Lottie files and DAM template does not support Lottie files yet.
  • Removed visibility field from Container.

🧰 Added

  • Added access field to Container, if it's set to "read-only", user will not be able to click the "Save to ..." button from this container, or choose this container in the export page.
  • Added support to select from the hierarchy of sub-containers when saving an exported Canva design.
  • Allow saveExportedDesign callback to include an optional errorMessage field in the returned object. If and errorMessage is provided when export failed, the message will be displayed in the alert message.

2024-10-03

🧰 Added

  • Added export.requireContainerSelected field (default true) for Config to control whether user has to select a container before exporting their design.

🔧 Changed

  • Use @canva/app-ui-kit components DateInput⁠(opens in a new tab or window) and Flyout⁠(opens in a new tab or window) in the filter form.
  • Use ImageMimeType VideoMimeType and AudioMimeType from @canva/asset package, instead of defining them locally.
  • When user is browsing on a tab (e.g. Assets) and starts a search, when showing search results, keep user on the tab they were originally at.
  • Upgraded @canva/design from 2.0.0 to 2.1.0.

2024-09-24

🔨 Breaking changes

  • acceptedFileTypes for config.export has changed from Array<"PNG" | "JPG" | "PDF_STANDARD" | "VIDEO" | "GIF" | "PPTX" | "SVG"> to Array<"png" | "jpg" | "pdf_standard" | "video" | "gif" | "pptx" | "svg"> to adapt to @canva/asset v2 ExportFileType type.

🔧 Changed

2024-09-19

🧰 Added

  • The thumbnail of image, video and embed assets would normally be used as preview images for when:

    • user is dragging the asset into their design, and
    • the asset is being uploaded.

    If the thumbnail image is blocked by CORS, the preview will look broken. In this version, we added a check on whether the thumbnail image can be displayed. If not, we will provide a fallback preview image.

🐞 Fixed

  • Fixed container name position not centralized vertically.

2024-09-09

🐞 Fixed

  • Remove unnecessary invocations of getUrl.

2024-09-05

🐞 Fixed

  • Fixed container thumbnail image squeezed narrow when the container's name is long.

2024-08-27

🧰 Added

  • Allow the Image, Audio and Video listed in FindResourcesResponse to not provide a url. When the resource does not have a url, it has to provide a getUrl: () => Promise<string> callback that when invoked, resolves to the URL. This is useful if you need to take extra steps to decide the URL of asset you are trying to upload, for example, if you need to make an additional HTTPS request to fetch the URL.

🔧 Changed

  • If the durationMs for Audio is 0 or unspecified, the template will try to detect the actual duration of the audio by inspecting the audio metadata in DOM.

2024-08-13

🧰 Added

  • Add an additional parameter, designTitle?: string to saveExportedDesign. The designTitle will be the title of exported design, if it has been set by user.

2024-07-23

🐞 Fixed

  • Fixed attachment badge being stretched on Firefox and Safari.

🔧 Changed

  • If enableAppStatePersistence is turned on and user last navigated to the export design page, do not take user back to export page when they open the app again. Instead take user to the page before export.

2024-07-08

Added

  • Added dragAndDropPreview to Image, Video and Embed resource types. It can be used to specify a fall-back image for preview when user is dragging an asset to the design, when the image at thumbnail.url does not allow canva.com as an origin.
  • Trigger a refetch of resources when user has successfully exported their Canva design, so that the newly exported design will be reflected.
  • Allow user to click the tags on the item details page to trigger a search:
    • if the app supports filtering by tag and the current tag is available as an option, start a search by filtering with this tag;
    • if the app does not support filtering by tag or the current tag is not an available option, start a keyword search with the tag's text label.

🐞 Fixed

  • Ensure the page has a bottom padding of 16px when there are no more resources to be loaded.
  • Ensure user can still navigate to the asset details page when the id contains special character.

2024-06-18

🧰 Added

  • Added tab field in FindResourcesRequest to indicate which tab user is currently at, so that the app backend can choose to provide different resources for different tab, even when multiple tabs are showing the same resource type.
  • Added tabs field for ContainerType, so that each container type can have their customized tabs.

🐞 Fixed

  • Fix typo for "Asset" -> "Assets" tab label inside containers.
  • Allow apps to display the more info bubble even when there are no tabs.

🔧 Changed

  • Changed tabValues field for OVERVIEW tab optional, and default to all tabs on the current page.

2024-05-30

🔧 Changed

🐞 Fixed

  • Fixed search menu overlapping tabs when tab carousel appears

2024-05-03

🔧 Changed

  • Reduced the top space of back buttons to give more space for content.

🐞 Fixed

  • Fixed export requested multiple times if no container needs to be selected for export.

2024-04-26

🧰 Added

  • Added support for customizable tabs.
  • Added support for an optional exit button.

🔧 Changed

  • Improve mobile experience with filter form.

2024-04-11

🔧 Changed

  • Improved the drag-and-drop experience in list layout by making the whole list item draggable.
  • Restrict the maximum width for the preview image for drag-and-drop to 200px.

🐞 Fixed

  • Fixed item details button not visible enough in light mode.

2024-04-09

🧰 Added

  • Included Audio to exported resource types.

🔧 Changed

  • Improved toolkit UI.

2024-04-08

🧰 Added

  • Added support for audio resource.
  • Added two optional config, resourcesPerPage and containersPerPage.

🐞 Fixed

  • Fixed type cannot be resolved correctly as ESM modules.
  • Fixed inconsistent width of the scrollable area when user has different OS or browser settings for scrollbar.

2024-03-26

Fixed

  • Fixed uploading of asset will fail if the asset id contains non-alphanumeric characters.

2024-03-21

🧰 Added

  • Add support for dynamically fetch filters during run time.
  • Allow Image, Video and Embed resources to have attachments, allow user to add image/video/embed attachments to their design, and open any other attachment types in a new tab.

🔧 Changed

  • Show export button when user has navigated inside a container or search result page.

2024-03-11

🔨 Breaking changes

  • Change Tag type to be value-label instead of id-name to be consistent with all other filters
  • Remove getFilterTags callback from props (we have a more powerful alternative coming out soon)

🐞 Fixed

  • Fixed clearing filter does not exit search result page when query string is empty.
  • Make scroll smooth when hiding sort bar.

2024-03-07

🐞 Fixed

  • Fix SearchableListView overflow caused by paddings.
  • Fix progress bar starting too early for export.
  • Add empty message when there are no containers to choose for export.

2024-03-06

🐞 Fixed

  • Make sure placeholders have consistent shape and layout as assets.
  • Remove border from video cards.
  • Fix export page broken because ToastProvider is unavailable.
  • Fix sort menu blinks when repeatedly triggering scroll event.

2024-03-05

🔧 Changed

  • UI improvement: Improve masonry display and infinite scrolling using react-infinite-scrollers and Masonry component from @canva/app-ui-kit.
  • UI improvement: Combine error or empty message into one on the "All" tab when no results are available.

2024-03-01

🐞 Fixed

  • Fix updateDate and createDate cannot be shown on item details view, when provided a date string instead of Date object
  • Fix filter button dis-positioned for some users

2024-02-28

🔨 Breaking changes

  • Rename config.search.filterFormConfig.containerTypeFilters to config.search.filterFormConfig.containerTypes

🔧 Added

  • Apply generic type ContainerTypeKey on config.search.filterFormConfig.containerTypes, config.export.containerTypes, findResourcesRequest.containerTypes and findResourcesRequest.parentContainerType

2024-02-27

🔨 Breaking changes

  • Renamed filter fieldName to label

🧰 Added

  • Added additional ListingSurface option for config.containerTypes, "SEARCH". Once included in listingSurfaces of a container type, this container type can be listed in the search results when user is searching using query/filters.

  • Added additional parentContainerType field in FindResourcesRequest, this field be provided in the request when searching for results from inside a container.

🐞 Fixed

  • Fixed search suggestion will pop out unexpectedly when user types in filter form

  • Fixed redundant retry attempts when FindResourcesCallback returns an error

2024-02-22

🔨 Breaking changes

  • Replaced all exported enums with type unions of string literals.
  • Removed unnecessarily exported types.

🐞 Fixed

  • Fixed importing the package from a node.js environment not working by removing React component from node.js environment export.