### Start the Documentation Site

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/README.md

Start the local documentation site server. Navigate to the adaptivecards-site directory.

```bash
cd adaptivecards-site
npx lerna run release
npm start
```

--------------------------------

### Install Dependencies

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/ac-typed-schema/README.md

Run this command to install project dependencies. It should be run before building or testing.

```bash
npm install
```

--------------------------------

### Start the Designer

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/README.md

Start the Adaptive Cards Designer application. Navigate to the adaptivecards-designer directory.

```bash
cd adaptivecards-designer
npm start
```

--------------------------------

### Start the Designer with Preview Features

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/README.md

Start the Adaptive Cards Designer with preview features enabled. Navigate to the adaptivecards-designer directory.

```bash
cd adaptivecards-designer
npm run start:preview
```

--------------------------------

### Install Adaptive Cards React

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-react/README.md

Install the react and adaptivecards-react modules using npm.

```bash
npm install react adaptivecards-react --save
```

--------------------------------

### Install Pods via Terminal

Source: https://github.com/microsoft/adaptivecards/blob/main/source/ios/README.md

Run the 'pod install' command in your terminal to install the specified pods.

```bash
$pod install
```

--------------------------------

### Install Adaptive Expressions and Adaptive Cards Templating (Node.js)

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-templating/README.md

Install the necessary packages for Node.js environments using npm.

```console
npm install adaptive-expressions adaptivecards-templating --save
```

--------------------------------

### Hello World Adaptive Card Templating Example

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-templating/README.md

A basic example demonstrating how to generate an Adaptive Card from a template and data. Requires the 'adaptivecards' package.

```typescript
import * as ACData from "adaptivecards-templating";
import * as AdaptiveCards from "adaptivecards";

// Define a template payload
var templatePayload = {
    "type": "AdaptiveCard",
    "version": "1.0",
    "body": [
        {
            "type": "TextBlock",
            "text": "Hello ${name}!"
        }
    ]
};

// Create a Template instance from the template payload
var template = new ACData.Template(templatePayload);

// Create a data binding context, and set its $root property to the
// data object to bind the template to
var context: ACData.IEvaluationContext = {
    $root = {
        "name": "Adaptive Cards"
    }
};

// "Expand" the template - this generates the final Adaptive Card,
// ready to render
var card = template.expand(context);

// Render the card
var adaptiveCard = new AdaptiveCards.AdaptiveCard();
adaptiveCard.parse(card);

document.getElementById('exampleDiv').appendChild(adaptiveCard.render());
```

--------------------------------

### Initialize Adaptive Cards Designer with Default Microsoft Hosts

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-designer/README.md

Create a new Adaptive Cards Designer instance using all the default host applications provided by Microsoft. This is a straightforward way to get started with common host environments.

```javascript
let hostContainers: ACDesigner.HostContainer[] = ACDesigner.defaultMicrosoftHosts;
let designer = new ACDesigner.CardDesigner(hostContainers);
```

--------------------------------

### Start UI Test App

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/README.md

Start the UI test application, which is a prerequisite for running UI tests. Navigate to the adaptivecards-ui-testapp directory.

```bash
cd adaptivecards-ui-testapp
npm run build
npm run start
```

--------------------------------

### Install Adaptive Cards via npm

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/README.md

Install the Adaptive Cards library using npm for your Node.js project.

```console
npm install adaptivecards --save
```

--------------------------------

### Example Choices Response

Source: https://github.com/microsoft/adaptivecards/blob/main/specs/DesignDiscussions/DynamicTypeahead_iOS.md

An example of an array of choices returned by the host to the SDK in response to a search query. Each choice has a title and a value.

```json
[
   { "title": "Matt", "value": "1" },
   { "title": "Mark", "value": "2" }
   { "title": "Mack", "value": "3" }
   { "title": "May", "value": "4" }
]
```

--------------------------------

### Install Designer Dependencies

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-designer/README.md

Installs the core adaptivecards-designer package along with its essential dependencies like monaco-editor and markdown-it.

```console
npm install adaptivecards-designer adaptivecards adaptive-expressions adaptivecards-templating monaco-editor markdown-it
```

--------------------------------

### CDN Setup for Adaptive Card Designer

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-designer/README.md

Includes script references for adaptivecards, adaptive-expressions, adaptivecards-templating, markdown-it (optional), adaptivecards-designer, and monaco-editor. This setup is for using the designer component with default Microsoft hosts via CDN.

```html
<!-- REQUIRED: adaptivecards library for designer to work -->
<script src="https://unpkg.com/adaptivecards@latest/dist/adaptivecards.min.js"></script>
<!-- REQUIRED: adaptive-expressions is required by adaptivecards-templating library to enable data binding support in designer -->
<script src="https://unpkg.com/adaptive-expressions@4/lib/browser.js"></script>
<!-- REQUIRED: adaptivecards-templating library to enable data binding support in designer -->
<script src="https://unpkg.com/adaptivecards-templating@latest/dist/adaptivecards-templating.min.js"></script>

<!-- OPTIONAL: markdown-it isn't required but enables out-of-the-box markdown support -->
<script src="https://unpkg.com/markdown-it@8.4.0/dist/markdown-it.min.js"></script>

<!-- DESIGNER OPTION A: Card Designer + Standard Hosts 
  (replace <VERSION> with the version you want to load, or "latest" for latest)
-->
<script src="https://unpkg.com/adaptivecards-designer@<VERSION>/dist/adaptivecards-designer.min.js"></script>

<!-- DESIGNER OPTION B: Standalone Card Designer, without standard Hosts 
  (replace <VERSION> with the version you want to load, or "latest" for latest)
  <script src="https://unpkg.com/adaptivecards-designer@<VERSION>/dist/adaptivecards-designer-standalone.min.js"></script>
-->

<!-- REQUIRED: monaco-editor is required for the designer to work -->
<script src="https://unpkg.com/monaco-editor@0.17.1/min/vs/loader.js"></script>
```

--------------------------------

### Example Error Response

Source: https://github.com/microsoft/adaptivecards/blob/main/specs/DesignDiscussions/DynamicTypeahead_iOS.md

An example of an error response returned by the host to the SDK when a query fails. It includes a code, reason, and user info.

```json
Code=204,
reason="Unable to show options right now",
UserInfo= ""
```

--------------------------------

### Build Project

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/ac-typed-schema/README.md

Compiles the project. Ensure dependencies are installed first.

```bash
npm run build
```

--------------------------------

### Hello World Example with Adaptive Cards Templating

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Library/AdaptiveCards.Templating/README.md

Demonstrates basic usage of the AdaptiveCardsTemplate class to expand a template with provided JSON data. This is useful for generating Adaptive Cards dynamically.

```csharp
string jsonTemplate = @"{ 
    \"type\": \"AdaptiveCard\",
    \"version\": \"1.0\",
    \"body\": [
        {
            \"type\": \"TextBlock\",
            \"text\": \"Hello, ${person.firstName}!\" 
        }
    ]
}";

string jsonData = @"{ 
    \"person\": { 
        \"firstName\": \"Andrew\", 
        \"lastName\": \"Leader\" 
    } 
}";

// The final JSON, it'll have "text": "Hello, Andrew!" in it!
var template = new AdaptiveCardsTemplate(jsonTemplate);
var context = new AdaptiveCardsEvaluationContext() { 
    Root = jsonData
};

string cardJson = template.Expand(context);
```

--------------------------------

### Array Data Context Example

Source: https://github.com/microsoft/adaptivecards/blob/main/specs/DesignDiscussions/Templating.md

An example of an array-type data context, where data is a list of objects.

```json
"$data": [
    { "name": "Matt" },
    { "name": "David" },
    { "name": "Thomas" }
]
```

--------------------------------

### Configure Open Sample Button in Designer

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-designer/README.md

Shows how to configure the 'Open Sample' button in the Adaptive Cards Designer by setting the `sampleCatalogueUrl` to a JSON file hosted on the web server.

```javascript
/* Configure "Open Sample" tooobar button */
designer.sampleCatalogueUrl = window.location.origin + "/sample-catalogue.json";

```

--------------------------------

### Dictionary Data Context Example

Source: https://github.com/microsoft/adaptivecards/blob/main/specs/DesignDiscussions/Templating.md

An example of a dictionary-type data context, where data is structured as key-value pairs.

```json
"$data": 
    { "name": "Matt" }
```

--------------------------------

### Bootstrap the repository with Lerna

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/README.md

Install dependencies and link packages using Lerna. Navigate to the source/nodejs directory first.

```bash
cd source/nodejs
npm install
```

--------------------------------

### Constructor

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/serialization.version.md

Initializes a new instance of the Version class.

```APIDOC
## constructor

### Description
Initializes a new instance of the Version class.

### Signature
`new Version(major?: number, minor?: number, label?: string): Version`

### Parameters
#### Parameters
- **major** (*number*) - Optional. Defaults to 1.
- **minor** (*number*) - Optional. Defaults to 1.
- **label** (*string*) - Optional.

### Returns
- [*Version*](serialization.version.md)
```

--------------------------------

### Basic CMake Project Setup

Source: https://github.com/microsoft/adaptivecards/blob/main/source/shared/cpp/ObjectModel/CMakeLists.txt

Sets the minimum CMake version, project name, and C++ standard for the ObjectModel project.

```cmake
cmake_minimum_required(VERSION 3.16)

# set the project name
project(ObjectModel)

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED True)
```

--------------------------------

### Run Unit Tests

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/README.md

Build and run all unit tests. Navigate to the tests/unit-tests directory.

```bash
cd tests/unit-tests
npm run build-and-test
```

--------------------------------

### Install Webpack Development Dependencies

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-designer/README.md

Installs development dependencies required for webpack to bundle monaco-editor and handle CSS/image assets.

```console
npm install copy-webpack-plugin monaco-editor-webpack-plugin css-loader style-loader
```

--------------------------------

### Initialize Adaptive Cards Designer with No Host Containers

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-designer/noHosts.html

Prepare an empty list of host containers to use the default built-in host container. The host container picker in the toolbar will be hidden.

```javascript
window.onload = function() {
  // Prepare a list of host containers
  // This is not required. When no list is passed (empty array or null), the designer
  // uses a default built-in host container, and the host container picker in the
  // toolbar is hidden.
  let hostContainers = [];
  let designer = new ACDesigner.CardDesigner(hostContainers);
  require.config({
    paths: {
      'vs': 'https://unpkg.com/monaco-editor@0.17.1/min/vs'
    }
  });
  require(['vs/editor/editor.main'], function () {
    designer.monacoModuleLoaded();
  });
  designer.attachTo(document.getElementById("designerRootHost"));
};
```

--------------------------------

### Run Grun with AdaptiveCardsTemplate

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Library/AdaptiveCards.Templating/tool/README.md

After building the parser, use this command to run the 'grun' tool with the AdaptiveCardsTemplate grammar to visualize a parse tree from a JSON file. The '-gui' flag enables the graphical interface.

```bash
grun AdaptiveCardsTemplate json -gui Test.json
```

--------------------------------

### Example Card Template JSON

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-site/pages/_posts/2019/Templating-on-Website.md

This is an example of a card template where dynamic content is represented by data-binding expressions in curly braces.

```json
{
	"type": "AdaptiveCard",
	"version": "1.0",
	"body": [
		{
			"type": "TextBlock",
			"text": "{name}",
			"size": "large",
			"wrap": true
		}
	]
}
```

--------------------------------

### Get Resource Information for Adaptive Card

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Library/AdaptiveCards/docs/AdaptiveCards.md

Get resource information for all images and media present in this card. This method has no parameters.

```csharp
ResourceInformation resourceInfo = card.GetResourceInformation();
```

--------------------------------

### Build all packages

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/README.md

Build all packages in the repository using Lerna's run command.

```bash
npx lerna run build
```

--------------------------------

### Blog Post Metadata Example

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-site/BLOGGING.md

This is an example of the YAML front matter required at the top of each blog post file to define its metadata.

```yaml
---
title: <REQUIRED> The title of your post, should be short and sweet
subtitle: <REQUIRED> A slightly longer subtitle that describes the post content
date: <REQUIRED> The post date YYYY-MM-DD
github_username: <REQUIRED> Your GitHub username
featured_image: <OPTIONAL> A "hero" image that aids the post visually (approx dimensions 294x172)
twitter: <OPTIONAL> Your twitter handle
---
```

```yaml
---
title: 🎉 Announcing Adaptive Cards 1.1
subtitle: All new drag-drop designer, a Media element, and more
date: 2018-10-12
featured_image: designer.png
github_username: matthidinger
twitter: matthidinger
---
```

--------------------------------

### Example Adaptive Card with associatedInputs

Source: https://github.com/microsoft/adaptivecards/blob/main/specs/DesignDiscussions/ignoreInputValidation.md

This example demonstrates how to use the 'associatedInputs' property to disable input validation and data submission for a 'Cancel' button.

```json
{
    "type": "AdaptiveCard",
    "version": "1.3",
    "body": [
        {
            "type": "Input.Text",
            "label": "You must type some text",
            "isRequired": true
        }
    ],
    "actions": [
        {
            "type": "Action.Submit",
            "title": "Submit"
        },
        {
            "type": "Action.Submit",
            "title": "Cancel",
            "associatedInputs": "none"
        }
    ]
}
```

--------------------------------

### init

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.textrun.md

Initializes the TextRun with a given text definition.

```APIDOC
## init

### Description
Initializes the TextRun with a given text definition.

### Parameters
#### Parameters
- **textDefinition** (*BaseTextDefinition*): The text definition to initialize with.

### Returns
*void*

### Inherited From
[BaseTextBlock](card_elements.ts)
```

--------------------------------

### Run AdaptiveCards Site

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-site/README.md

Command to start the local development server for the AdaptiveCards site. Access the site via the provided localhost URL.

```bash
1. npm start
2. Open up the browser to point to: localhost:[portnumber] printed after the command above returns under "Hexo is running at".

```

--------------------------------

### ShowCardActionConfig Constructor

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.showcardactionconfig.md

Initializes a new instance of the ShowCardActionConfig class.

```APIDOC
## new ShowCardActionConfig()

### Description
Initializes a new instance of the ShowCardActionConfig class.

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* None

### Request Example
```json
{}
```

### Response
#### Success Response
- **Instance** (*ShowCardActionConfig*) - A new instance of ShowCardActionConfig.

#### Response Example
```json
{
  "instance": "ShowCardActionConfig"
}
```
```

--------------------------------

### Build and Generate AdaptiveCards Site

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-site/README.md

Commands to build and generate the AdaptiveCards site. Ensure you have bootstrapped the repository first.

```bash
1. cd adaptivecards-site
2. npx lerna run release

```

--------------------------------

### Template JSON Example

Source: https://github.com/microsoft/adaptivecards/blob/main/specs/DesignDiscussions/ConsistentCards.md

This is an example of a basic Adaptive Card template JSON structure. It defines the card's type, version, and body content, including a TextBlock with a placeholder for dynamic data.

```json
{
    "type": "AdaptiveCard", 
    "version": "1.0", 
    "body": [
        {
            "type": "TextBlock", 
            "text": "Hello ${name}!"
        }
    ]
}
```

--------------------------------

### MediaConfig Constructor

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.mediaconfig.md

Initializes a new instance of the MediaConfig class.

```APIDOC
## new MediaConfig

### Description

Initializes a new instance of the MediaConfig class.

### Parameters

#### Parameters

- **obj?** (any) - Optional. An object to initialize the MediaConfig with.

### Returns

- MediaConfig - A new instance of the MediaConfig class.
```

--------------------------------

### Adaptive Card with TextRun Underline Examples

Source: https://github.com/microsoft/adaptivecards/blob/main/specs/DesignDiscussions/TextRun.Underline.md

This JSON snippet demonstrates the usage of the 'underline' property within TextRun elements in a RichTextBlock. It shows examples of default underline, forced underline, and disabled underline.

```json
{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.3",
	"body": [
		{
			"type": "RichTextBlock",
			"inlines": [
				"This is the first inline. ",
				{
					"type": "TextRun",
					"text": "This inline has default underline value. "
				},
				{
					"type": "TextRun",
					"text": "This inline must have underline. ",
					"underline": true
				},
				{
					"type": "TextRun",
					"text": "This inline must not have underline. ",
					"underline": false
				}
			]
		}
	]
}

```

--------------------------------

### parent

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/container.md

Gets the parent of the container.

```APIDOC
## get parent

### Description
Gets the parent of the container.

### Returns
- [CardElement](cardelement.md) | undefined: The parent element or undefined if it has no parent.

### Inheritance
Inherited from [CardElement](cardelement.md).[parent](cardelement.md#parent)
*Overrides [CardObject](cardobject.md).[parent](cardobject.md#parent)
```

--------------------------------

### init

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.basetextblock.md

Initializes the text block with provided text definition properties.

```APIDOC
## init

▸ **init**(`textDefinition`: [*BaseTextDefinition*](host_config.basetextdefinition.md)): *void*

#### Parameters:

Name | Type |
:------ | :------:|
`textDefinition` | [*BaseTextDefinition*](host_config.basetextdefinition.md) |

**Returns:** *void*

Defined in: [card-elements.ts:754](https://github.com/microsoft/AdaptiveCards/blob/0938a1f10/source/nodejs/adaptivecards/src/card-elements.ts#L754)
```

--------------------------------

### index

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/card_elements.container.md

Gets the index of the container.

```APIDOC
## index

### Description
Gets the index of the container.

### Returns
*number*

### Defined in
[card-elements.ts:575](https://github.com/microsoft/AdaptiveCards/blob/0938a1f10/source/nodejs/adaptivecards/src/card-elements.ts#L575)
```

--------------------------------

### ShowCardConfig Constructor

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Library/AdaptiveCards/docs/AdaptiveCards.md

Initializes a new instance of the ShowCardConfig class with default settings.

```APIDOC
## #ctor()

### Description
Initializes a default [ShowCardConfig](#T-AdaptiveCards-Rendering-ShowCardConfig 'AdaptiveCards.Rendering.ShowCardConfig').

### Method
`constructor`

### Parameters
This constructor has no parameters.
```

--------------------------------

### AdaptiveTableRow.Type

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Library/AdaptiveCards/docs/AdaptiveCards.md

Gets the type of the AdaptiveTableRow.

```APIDOC
## Type `property`

### Summary

*Inherit from parent.*
```

--------------------------------

### Build and Test Project

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/ac-typed-schema/README.md

Combines building the project and running tests in a single command.

```bash
npm run build-and-test
```

--------------------------------

### parent

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.richtextblock.md

Gets the parent of the RichTextBlock.

```APIDOC
## parent

### Description
Gets the parent of the RichTextBlock.

### Method
GET

### Endpoint
/parent

### Returns
*CardElement | undefined* - The parent CardElement, or undefined if it has no parent.
```

--------------------------------

### Basic CLI Usage

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Samples/AdaptiveCards.Core.Sample.ImageRender/README.md

Run the image renderer tool to process JSON card payloads from the default directory.

```console
dotnet run
```

--------------------------------

### index

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.choicesetinput.md

Gets the index of the ChoiceSetInput.

```APIDOC
## index

### Description
Gets the index of the ChoiceSetInput.

### Method
GET

### Endpoint
N/A (Class property)

### Returns
- **number** - The index of the ChoiceSetInput.
```

--------------------------------

### Run UI Tests

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/README.md

Build and run UI tests. Ensure the UI test app and web drivers are running. Navigate to the tests/ui-tests directory.

```bash
cd tests/ui-tests
npm run build
npm run test
```

--------------------------------

### label Accessor

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/serialization.version.md

Gets the label of the version.

```APIDOC
## label

### Description
Gets the label of the version.

### Signature
`get label(): string`

### Returns
- *string*
```

--------------------------------

### lang

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/card_elements.container.md

Gets or sets the language of the container.

```APIDOC
## lang

### Description
Gets or sets the language of the container.

### Getter
Gets the language of the container.

### Returns
*undefined* | *string*

### Setter
Sets the language of the container.

#### Parameters:

Name | Type |
:------ | :------ |
`value` | *undefined* | *string* |

### Defined in
[card-elements.ts:56](https://github.com/microsoft/AdaptiveCards/blob/0938a1f10/source/nodejs/adaptivecards/src/card-elements.ts#L56)
[card-elements.ts:72](https://github.com/microsoft/AdaptiveCards/blob/0938a1f10/source/nodejs/adaptivecards/src/card-elements.ts#L72)
```

--------------------------------

### Add SafariServices.framework

Source: https://github.com/microsoft/adaptivecards/blob/main/source/ios/README.md

Link the SafariServices.framework to your project to enable opening web pages.

```text
project file -> Targets -> Linked Frameworks and Libraries -> add
```

--------------------------------

### Initialize Adaptive Cards Designer from CDN

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-designer/cdn.html

This snippet shows the basic HTML and JavaScript required to load the Adaptive Cards Designer from a CDN. It initializes the designer, sets the asset path, and attaches it to a specified host element. It also includes the necessary configuration to load the Monaco editor.

```html
<!DOCTYPE html>
<html>
<head>
    <title>Adaptive Cards Designer</title>
    <style>
        * { box-sizing: border-box; }
        html { overflow: hidden !important; }
        body { font-family: 'Segoe UI', sans-serif; font-size: 14px; font-weight: normal; height: 100vh; margin: 0; padding: 0; }
        #designerRootHost { height: 100vh; }
    </style>
</head>
<body>
    <div id="designerRootHost"></div>
    <script src="https://unpkg.com/adaptivecards-designer@latest/dist/adaptivecards-designer.min.js"></script>
    <script>
        window.onload = function () {
            if (!ACDesigner.SettingsManager.isLocalStorageAvailable) {
                console.log("Local storage is not available.");
            }
            let designer = new ACDesigner.CardDesigner(ACDesigner.defaultMicrosoftHosts);
            designer.assetPath = "https://unpkg.com/adaptivecards-designer@latest/dist";
            designer.attachTo(document.getElementById("designerRootHost"));

            // initialize monaco editor and tell the Designer when it's been loaded
            require.config({
                paths: {
                    'vs': 'https://unpkg.com/monaco-editor@0.17.1/min/vs'
                }
            });
            require(['vs/editor/editor.main'], function () {
                designer.monacoModuleLoaded();
            });
        };
    </script>
</body>
</html>
```

--------------------------------

### backgroundImage

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/card_elements.container.md

Gets the background image for the container.

```APIDOC
## backgroundImage

### Description
Gets the background image for the container.

### Returns
[*BackgroundImage*](card_elements.backgroundimage.md)

### Defined in
[card-elements.ts:5326](https://github.com/microsoft/AdaptiveCards/blob/0938a1f10/source/nodejs/adaptivecards/src/card-elements.ts#L5326)
```

--------------------------------

### Format Source Code with npm

Source: https://github.com/microsoft/adaptivecards/blob/main/README.md

Execute this command in the source/nodejs directory to format code using the npm package. Ensure 'npm install' has been run first.

```bash
npm run format
```

--------------------------------

### AdaptiveCard.Actions

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Library/AdaptiveCards.Net6/docs/AdaptiveCards.md

Gets or sets the actions for the card.

```APIDOC
## Actions `property`

### Description
Gets or sets the Actions for this card.

### Summary
The Actions for this card.
```

--------------------------------

### parent

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.stylablecardelementcontainer.md

Gets the parent card element.

```APIDOC
## parent

### Description
Gets the parent card element.

### Method
GET

### Endpoint
/parent

### Returns
- **CardElement | undefined**: The parent card element, or undefined if it has no parent.
```

--------------------------------

### Basic CLI Usage

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Samples/AdaptiveCards.Sample.ImageRender/README.md

Run the CLI tool to process JSON card payloads from the current directory.

```console
Usage: dotnet run [payload-path] [options]
```

```console
$ dotnet run
```

--------------------------------

### prepareForExecution

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/showcardaction.md

Prepares the ShowCardAction for execution. This method is inherited from Action.

```APIDOC
## prepareForExecution

### Description
Prepares the ShowCardAction for execution. This method is inherited from Action.

### Method
prepareForExecution

### Returns
- boolean
```

--------------------------------

### AdaptiveTable.Type

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Library/AdaptiveCards/docs/AdaptiveCards.md

Gets the type name of the AdaptiveTable.

```APIDOC
## AdaptiveTable.Type `property`

### Summary

type name
```

--------------------------------

### separatorOrientation

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.richtextblock.md

Gets the orientation of the separator for the RichTextBlock.

```APIDOC
## separatorOrientation

### Description
Gets the orientation of the separator for the RichTextBlock.

### Method
GET

### Endpoint
/separatorOrientation

### Returns
*Orientation* - The Orientation enum value.
```

--------------------------------

### Run Tests

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/ac-typed-schema/README.md

Executes the project's test suite. Ensure the project is built first.

```bash
npm run test
```

--------------------------------

### lang

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.richtextblock.md

Gets or sets the language of the RichTextBlock.

```APIDOC
## lang

### Description
Gets or sets the language of the RichTextBlock.

### Method
GET / SET

### Endpoint
/lang

### Parameters
#### Request Body (SET)
- **value** (string | undefined) - Required - The language code to set.

### Returns
*string | undefined* - The current language code.
*void* - When setting the language.
```

--------------------------------

### init

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/basetextblock.md

Initializes the text block with the provided text definition.

```APIDOC
## init

### Description
Initializes the text block with the provided text definition.

### Method
(Implicitly called)

### Parameters
#### Path Parameters
- **textDefinition** ([BaseTextDefinition](basetextdefinition.md)) - Required - The definition for the text block.

### Returns
*void*
```

--------------------------------

### isVisible

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.richtextblock.md

Gets or sets the visibility of the RichTextBlock.

```APIDOC
## isVisible

### Description
Gets or sets the visibility of the RichTextBlock.

### Method
GET / SET

### Endpoint
/isVisible

### Parameters
#### Request Body (SET)
- **value** (boolean) - Required - The visibility state to set.

### Returns
*boolean* - True if the RichTextBlock is visible, false otherwise.
*void* - When setting the visibility.
```

--------------------------------

### Setup Git Pre-commit Hook (Copy Method)

Source: https://github.com/microsoft/adaptivecards/blob/main/README.md

Manually copy the pre-commit hook script to the .git/hooks directory to enable automatic formatting checks on commit.

```bash
cp scripts/hooks/pre-commit .git/hooks
```

--------------------------------

### hostConfig

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.richtextblock.md

Gets or sets the HostConfig for the RichTextBlock.

```APIDOC
## hostConfig

### Description
Gets or sets the HostConfig for the RichTextBlock.

### Method
GET / SET

### Endpoint
/hostConfig

### Parameters
#### Request Body (SET)
- **value** (HostConfig) - Required - The HostConfig object to set.

### Returns
*HostConfig* - The current HostConfig object.
*void* - When setting the HostConfig.
```

--------------------------------

### CLI Usage with Host Config

Source: https://github.com/microsoft/adaptivecards/blob/main/source/dotnet/Samples/AdaptiveCards.Core.Sample.ImageRender/README.md

Use the image renderer with a specific host configuration file, such as for Windows Notifications. This example also includes recursive searching and interactivity support.

```console
dotnet run -- ../../../../samples -r -i -o ./out --host-config ../../../../samples/hostconfig/windows-notification.json
```

--------------------------------

### parent

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.choicesetinput.md

Gets the parent CardElement of the ChoiceSetInput.

```APIDOC
## parent

### Description
Gets the parent CardElement of the ChoiceSetInput.

### Method
GET

### Endpoint
N/A (Class property)

### Returns
- **undefined** | **CardElement** - The parent CardElement, or undefined if it has no parent.
```

--------------------------------

### Build Appx Package

Source: https://github.com/microsoft/adaptivecards/blob/main/source/uwp/UWPUITests/README.md

Build the appx package for the UWPUITestApp project. This command is executed from the AdaptiveCards repository root.

```bash
cd source\uwp\UWPUITestApp
msbuild .\UWPUITestApp.csproj /p:DeployOnBuild=true
```

--------------------------------

### lang

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.choicesetinput.md

Gets or sets the language of the ChoiceSetInput.

```APIDOC
## lang

### Description
Gets or sets the language of the ChoiceSetInput.

### Method
GET/SET

### Endpoint
N/A (Class property)

### Parameters
#### Set Parameters
- **value** (*undefined* | *string*) - Required - The language code (e.g., 'en-US') or undefined to unset.

### Returns
- **undefined** | **string** (GET) - The current language of the ChoiceSetInput.
- **void** (SET) - This method does not return a value.
```

--------------------------------

### Initialize Adaptive Cards Designer with Custom Host Configurations

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards-designer/README.md

Instantiate the Adaptive Cards Designer with a specific selection of built-in host applications and/or custom host applications. This provides flexibility in defining the target environments for card design.

```javascript
let hostContainers: ACDesigner.HostContainer[] = [
  new ACDesigner.WebChatContainer("Bot Framework WebChat", "containers/webchat-container.css"),
  new ACDesigner.OutlookContainer("Outlook Actionable Messages", "containers/outlook-container.css"),
  new MyCustomContainerClass("My Custom Container", "path-to-my-custom-container-stylesheet.css")
];
let designer = new ACDesigner.CardDesigner(hostContainers);
```

--------------------------------

### defaultStyle

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/adaptivecards.choicesetinput.md

Gets the default style for the ChoiceSetInput.

```APIDOC
## defaultStyle

### Description
Gets the default style for the ChoiceSetInput.

### Method
GET

### Endpoint
N/A (Class property)

### Returns
- **string** - The default style of the ChoiceSetInput.
```

--------------------------------

### lang

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/textblock.md

Gets or sets the language of the TextBlock element.

```APIDOC
## lang

### Description
Gets or sets the language of the TextBlock element.

### Getter
- **lang**(): *string | undefined*
  *Inherited from [CardElement](cardelement.md).[lang](cardelement.md#lang)*

### Setter
- **set lang**(`value`: string | undefined): *void*
  *Inherited from [CardElement](cardelement.md).[lang](cardelement.md#lang)*

#### Parameters
- **value** (string | undefined) - The language code to set.
```

--------------------------------

### Swift Bridging Header Setup

Source: https://github.com/microsoft/adaptivecards/blob/main/source/ios/README.md

Instructions for setting up a bridging header in Swift projects to import Objective-C code, including the AdaptiveCards pod.

```text
Add AdaptiveCards pod to Podfile
Create and add a bridge header 
Helpful guide: https://mycodetips.com/ios/manually-adding-swift-bridging-header-1290.html
```

--------------------------------

### SerializableObject.getSchemaKey Method

Source: https://github.com/microsoft/adaptivecards/blob/main/source/nodejs/adaptivecards/docs/classes/serialization.serializableobject.md

Gets the schema key for the SerializableObject.

```APIDOC
## getSchemaKey()

### Description
Gets the schema key for the SerializableObject.

### Returns
- `string` - The schema key.

### Protected
- Yes

### Abstract
- Yes

### Defined in
- serialization.ts:782
```