@canva/platform

A Canva Developers SDK package for building apps inside Canva. Provides utility methods.

Table of contents

• Introduction
• Installation
• Usage
• API reference
• Related packages
• Contributing
• License

Introduction

@canva/platform is an npm package for building apps inside Canva with the Canva Developers SDK. It provides utility methods that are useful for a broad range of apps. For example, the requestOpenExternalUrl method opens an external web page.

Note: To get up and running with the Canva Developers SDK, check out the quick start guide.

Installation

npm install @canva/platform

Usage

1. Import a method or namespace from the @canva/platform package:

   import { getPlatformInfo } from '@canva/platform';
   

2. Call a method, passing in the required arguments (if any):

   getPlatformInfo();
   

API reference

• getPlatformInfo
• requestOpenExternalUrl

Related packages

Apps inside Canva are built with the following Canva Developers SDK packages:

• @canva/app-ui-kit - React-based component library for creating apps that mimic the look and feel of Canva.
• @canva/asset - Provides methods for working with assets, such as image and video files.
• @canva/design - Provides methods for interacting with the user's design, such as creating elements.
• @canva/error - Provides a CanvaError class for handling errors.
• @canva/platform - Provides utility methods, such as a method for opening external links.
• @canva/user - Provides methods for accessing user data and authenticating users.

Contributing

We're actively developing this package but are not currently accepting third-party contributions. If you'd like to request any changes or additions to the package, submit a feature request via the Canva Developers Community.

License

See the LICENSE.md file.