@canva/platform
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

@canva/platform

A package for Canva's Apps SDK that provides utility methods.

Table of contents

Introduction

@canva/platform is an npm package for Canva's Apps 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 Apps 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

Related packages

The Apps SDK is made up of the following 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.

Readme

Keywords

none

Package Sidebar

Install

npm i @canva/platform

Weekly Downloads

265

Version

1.1.0

License

SEE LICENSE IN LICENSE.md FILE

Unpacked Size

16.9 kB

Total Files

8

Last publish

Collaborators

  • canva-dev