@canva/app-components
v2.2.0
Published
Contains composite app components for reusable app patterns, for example, DAM (digital asset management) apps.
Readme
@canva/app-components
React-based library of composite app components for common Canva App patterns.
Table of contents
Introduction
The app components library extracts common Canva App patterns and provides them as a component you can reuse in your own project. For example, you can use this component to create a digital asset management (DAM) app.
If you're looking for general purpose UI components, see App UI Kit.
To learn more about developing apps on Canva, see the official documentation.
Installation
npm install @canva/app-componentsPeer Dependencies
This package requires the following peer dependencies to be installed in your project:
Required Canva SDK packages:
npm install @canva/app-ui-kit @canva/asset @canva/design @canva/error @canva/platformRequired React packages:
npm install react react-domRequired utility packages:
npm install @tanstack/react-query react-intl react-router-dom clsx loglevel react-infinite-scrollerNote: If these peer dependencies are not installed, the package will not work. npm will show warnings during installation if any peer dependencies are missing.
Usage
Building a digital asset management app
See the digital_asset_management example in the Apps SDK starter kit.
Components
The app-components library exports one component so far:
SearchableListView
To learn how to use this component, see the Storybook instance.
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.
