@canva/design v2.4.1
@canva/design
A package for Canva's Apps SDK that provides methods for interacting with a user's design.
Table of contents
Introduction
@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.
Installation
npm install @canva/designUsage
Import a method or namespace from the
@canva/designpackage:import { addPage } from '@canva/design';Call a method, passing in the required arguments (if any):
await addPage();
API reference
addAudioTrackaddNativeElementaddPagegetCurrentPageContextgetDefaultPageDimensionsinitAppElementrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDrag
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 aCanvaErrorclass 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.
11 months ago
11 months ago
7 months ago
9 months ago
7 months ago
5 months ago
9 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago