If you haven't already, create a new app in the Developer Portal⁠(opens in a new tab or window). For more information, refer to our Quickstart guide.
In your app's configuration on the Developer Portal⁠(opens in a new tab or window), ensure the "Development URL" is set to http://localhost:8080.

Clone the starter kit:

git clone https://github.com/canva-sdks/canva-apps-sdk-starter-kit.git
cd canva-apps-sdk-starter-kit

SHELL

Install dependencies:
```
npm install
```
SHELL
Run the example:
```
npm run start:example notification
```
SHELL
Click the Preview URL link shown in the terminal to open the example in the Canva editor.

Example app source code

// For usage information, see the README.md file.
import { Button, Rows, Text } from "@canva/app-ui-kit";
import { notification } from "@canva/platform";
import * as styles from "styles/components.css";

export const App = () => {
  // Static demonstration messages for example purposes
  const funMessages = [
    "🚀 Keep going, superstar!",
    "💪 You got this!",
    "🌟 Shine bright!",
    "🔥 Crushing it!",
    "🏆 Winner vibes only!",
  ];

  const handleClick = () => {
    const randomMessage =
      funMessages[Math.floor(Math.random() * funMessages.length)];
    notification.addToast({
      messageText: randomMessage || "🎲 Random notification!",
    });
  };
  return (
    <div className={styles.scrollContainer}>
      <Rows spacing="1u">
        <Text>Apps can trigger notifications:</Text>
        <Button variant="primary" onClick={handleClick}>
          Show a fun toast notification 🍞
        </Button>
      </Rows>
    </div>
  );
};

TYPESCRIPT

// For usage information, see the README.md file.
import { AppUiProvider } from "@canva/app-ui-kit";
import { createRoot } from "react-dom/client";
import { App } from "./app";
import "@canva/app-ui-kit/styles.css";
import type { DesignEditorIntent } from "@canva/intents/design";
import { prepareDesignEditor } from "@canva/intents/design";

async function render() {
  const root = createRoot(document.getElementById("root") as Element);

  root.render(
    <AppUiProvider>
      <App />
    </AppUiProvider>,
  );
}

const designEditor: DesignEditorIntent = { render };
prepareDesignEditor(designEditor);

// Hot Module Replacement for development (automatically reloads the app when changes are made)
if (module.hot) {
  module.hot.accept("./app", render);
}

TYPESCRIPT

# Notification example

Demonstrates how to display toast notifications to users using the notification API.

For API reference docs and instructions on running this example, see: <https://www.canva.dev/docs/apps/examples/notification/>.

NOTE: This example differs from what is expected for public apps to pass a Canva review:

- Message content is hardcoded for demonstration purposes only. Production apps should provide user input interfaces or dynamic content loading.
- Error handling is simplified for demonstration. Production apps must implement comprehensive error handling with clear user feedback and graceful failure modes.
- Internationalization is not implemented. Production apps must support multiple languages using the `@canva/app-i18n-kit` package to pass Canva review requirements
- The code structure is simplified: Production apps using [intents](https://www.canva.dev/docs/apps/intents/) are recommended to call the prepareDesignEditor function from src/intents/design_editor/index.tsx.

MARKDOWN

API reference

Need help?

Join our Community Forum⁠(opens in a new tab or window)
Report issues with this example on GitHub⁠(opens in a new tab or window)