@chitchatjs/plugin-ax-card

Chitchat.js platform developed plugin package for displaying Card in alexa skills.

For information about how cards work in Alexa Skills, go to : https://developer.amazon.com/en-US/docs/alexa/custom-skills/request-and-response-json-reference.html#card-object

🤖 Chitchat.js is a JavaScript framework for building voice user interfaces for Alexa Skills. | 📄 Read the documentation

Get in touch

Installation

npm i @chitchatjs/plugin-ax-card

Usage

import { ax } from "@chitchatjs/alexa";
import { card } from "@chitchatjs/plugin-ax-card";

// a simple card
card.simple("Hello world", "Hi there!");

// a standard card
card.standard(
  "Hello world",
  "Hi there!",
  "https://foo.bar/smallImage.png",
  "https://foo.bar/largeImage.png"
);

// Link account card
card.linkAccount();

// Permission card
card.askPermissions([card.Permission.ListRead, card.Permission.ListWrite]);

Simply plugin the card building block into your skill anywhere:

ax.whenLaunch()
  .then(
    ax
      .compound()
      .add(ax.ask("Welcome, please provide permissions to read your lists.").build())
      .add(card.askPermissions([card.Permission.ListRead]))
      .build()
  )
  .build();