genietalkcards v1.0.7

Genietalk Cards

Genietalk Cards are a new way for developers to exchange card content in a common and consistent way.

Expressive cards, open framework, multiple platforms

Break outside the box of templated cards. Genietalk Cards let you describe your content as you see fit and deliver it beautifully wherever your customers are.

The simple open card format enables an ecosystem of shared tooling, seamless integration between producers and consumers, and native cross-platform performance on any device.

Get Started

Check out the full documentation for more

FYI: New policy on versioning

In previous releases of this SDK (1.x), the package version would match an official Genietalk Card Schema version; the library would be able to parse and render cards expressed in the latest Genietalk Card schema version and all previous versions, but it would only ever serialize to the latest version of the Genietalk Card schema. With the 2.x release we've introduced a new compability layer, allowing developers to (de)serialize cards to and from any version of the Genietalk Card schema using a single library. The below table summarizes this new versioning capability:

Breaking changes

Please be aware of the following breaking changes in particular versions.

Install

Node

npm install genietalkcards --save

CDN

The unpkg.com CDN makes it easy to load the script in an browser.

The latest release will keep you up to date with features and fixes, but may have breaking changes over time. For maximum stability you should use a specific version.

• genietalkcards.js - non-minified, useful for dev
• genietalkcards.min.js - minified version, best for production

<!-- Option 1: always load the latest release -->
<script src="https://unpkg.com/genietalkcards/dist/genietalkcards.min.js"></script>

<!-- Option 2: load a specific version (e.g, 1.1.1) -->
<script src="https://unpkg.com/genietalkcards@1.1.1/dist/genietalkcards.min.js"></script>

Usage

Import the module

// Import the module:
import * as GenietalkCards from "genietalkcards";

// OR require it:
var GenietalkCards = require("genietalkcards");

// OR if you loaded via CDN, the global "GenietalkCards" variable
// is already defined and can be used directly

Render a card

// Author a card
// In practice you'll probably get this from a service
// see http://genietalkcards.io/samples/ for inspiration
var card = {
    "type": "GenietalkCard",
    "version": "1.0",
    "body": [
        {
            "type": "Image",
            "url": "https://genietalkcards.io/content/genietalk-card-50.png"
        },
        {
            "type": "TextBlock",
            "text": "Hello **Genietalk Cards!**"
        }
    ],
    "actions": [
        {
            "type": "Action.OpenUrl",
            "title": "Learn more",
            "url": "https://genietalkcards.io"
        },
        {
            "type": "Action.OpenUrl",
            "title": "GitHub",
            "url": "https://github.com/Microsoft/GenietalkCards"
        }
    ]
};

// Create an GenietalkCard instance
var genietalkCard = new GenietalkCards.GenietalkCard();

// Set its hostConfig property unless you want to use the default Host Config
// Host Config defines the style and behavior of a card
genietalkCard.hostConfig = new GenietalkCards.HostConfig({
    fontFamily: "Segoe UI, Helvetica Neue, sans-serif"
    // More host config options
});

// Set the genietalk card's event handlers. onExecuteAction is invoked
// whenever an action is clicked in the card
genietalkCard.onExecuteAction = function(action) { alert("Ow!"); }

// Parse the card payload
genietalkCard.parse(card);

// Render the card to an HTML element:
var renderedCard = genietalkCard.render();

// And finally insert it somewhere in your page:
document.body.appendChild(renderedCard);

Supporting Markdown

Markdown is a standard feature of Genietalk Cards, but to give users flexibility we don't bundle a particular implementation with the library.

Option 1: Markdown-It

The easiest way to get markdown support is by adding markdown-it to your document.

<script type="text/javascript" src="https://unpkg.com/markdown-it/dist/markdown-it.min.js"></script>

Option 2: Any other 3rd party library

If you want to use another library or handle markdown yourself, use the GenietalkCards.onProcessMarkdown event.

IMPORTANT SECURITY NOTE: When you process Markdown (yourself or using a library) you are responsible for making sure the output HTML is safe.

For example, you must remove <script> or other HTML elements that could be injected onto the page.

• Failure to do so will make your application susceptible to script injection attacks.
• Most Markdown libraries, such as Markdown-It, offer HTML sanitation.

GenietalkCards.onProcessMarkdown = function(text, result) {
	result.outputHtml = <your Markdown processing logic>;
	result.didProcess = true;
}

Make sure to set result.didProcess to true, otherwise the library will consider the input text as not processed and will be treated as plain text.

Webpack

If you don't want genietalkcards in your bundle, make sure the script is loaded and add the following the your webpack.config.json

module.exports = {
  ...
  externals: [
    { genietalkcards: { var: "GenietalkCards" } }
  ]
};

Learn more at https://genietalkcards.io

• Documentation
• Schema Explorer
• Sample Cards
• Interactive Designer