A package for Canva's Apps SDK that provides methods for interacting with a user's design.

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

@canva/design is an npm package for Canva's Apps SDK. It provides methods for interacting with a user's design. For example, the addPage method adds a page to the user's design, while requestExport exports the user's design as one or more static files.

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

npm install @canva/design

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

   import { addPage } from '@canva/design';

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

   await addPage();

• addAudioTrack
• addNativeElement
• addPage
• getCurrentPageContext
• getDefaultPageDimensions
• initAppElement
• requestExport
• selection.registerOnChange
• setCurrentPageBackground
• ui.startDrag

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.

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.

See the LICENSE.md file.