--- schema_version: "1" id: 319e181894bbf936b83e691b2e84c9d215e8ee974e1ad6c9e8454aaca7aab540 title: Composition Objects collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/salesforce-slack-sdk/apex-slack-sdk/guides/components/composition.md canonical_url: https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/composition.html source_site: developer.salesforce.com content_type: documentation content_hash: b940d2b33a861f822f7544a1415ac2d56e1cc8f32f9c8daa80e9ed2aa30ef83c products: - Apex SDK for Slack (Beta) --- # Composition Objects Some components accept complex property values that must take a certain shape. ## Confirm A dialog that provides a confirmation step. This dialog asks the user to confirm their action via confirm and deny buttons. ![Confirm Example](https://developer.salesforce.com/media/confirm_standard.png) **Example** ```yaml confirm: title: "Confirm desired selection" text: "Please confirm your selection" confirm: "Confirm" deny: "Cancel" style: "primary" ``` | Key | Type | Required | Description | | ----------------- | -------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `confirm` | Object | Yes | An object describing a dialog that provides a confirmation step. | | `confirm.title` | String, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md), [Plain Text](#plain-text) | Yes | The title of the confirmation dialog. | | `confirm.text` | String, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md), [Plain Text](#plain-text) | Yes | Explanatory text to display to the user in the confirmation dialog. | | `confirm.confirm` | String, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md), [Plain Text](#plain-text) | Yes | The text of the confirm button. | | `confirm.deny` | String, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md), [Plain Text](#plain-text) | Yes | The text of the cancel button. | | `confirm.style` | String, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | No | Defines the color scheme applied to the confirm button. The value `danger` displays the button with a red background on desktop, or red text on mobile. The value `primary` displays the button with a green background on desktop, or blue text on mobile. The default value is `primary`. | ## Datasource Identifies the data provider for an [external select](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#external-select) component. **Example** ```yaml datasource: definition: "example__dataprovider" properties: objectApiName: "Opportunity" ``` | Key | Type | Required | Description | | ----------------------- | ----------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `datasource` | String, Object, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | Yes | A valid data provider identifier string or object containing an identifier and properties to be passed into a data provider. | | `datasource.definition` | String, Object, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | Yes | A valid data provider identifier is required to be present within the `datasource` if the `datasource` takes the form of an Object. Use the format `namespace__dataproviderName`. | | `datasource.properties` | Object, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | No | Contains any parameters to be passed into the option data provider. | ## Filter Used in the [conversations select](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#conversations-select) component to filter which conversations are shown in the picker. **Example** ```yaml filter: include: [ "public", "private", "im", "mpim" ], excludeExternalShared: true, excludeBotUsers: true ``` | Key | Type | Required | Description | | ------------------------------ | ------------------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `filter` | Object | Yes | Used in the [conversations select](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#conversations-select) component to filter which conversations are shown in the picker. | | `filter.include` | Array | Yes | List of conversation types to include. Possible values: `public`—public channels, `private`—private channels, `im`—direct messages, `mpim`—multi-party direct messages. | | `filter.excludeExternalShared` | Boolean, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | No | Exclude external shared channels from the conversation list. The default value is `false`. | | `filter.excludeBotUsers` | Boolean, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | No | Exclude bot users from the conversation list. The default value is `false`. | ## Options Available in: [Checkbox Group](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#checkbox-group) | [Overflow](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#overflow) | [Radio Group](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#radio-group) | [Select](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#select) An object that represents a single selectable item. **Example** ```yaml options: - identifier: "option_1" label: "Option 1" value: true description: "This is option 1" - identifier: "option_2" label: "Option 2" value: false ``` | Key | Type | Required | Description | | --------------------- | --------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `options` | Array, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | Yes | A list of options. | | `options.identifier` | String | Yes | A string used to identify the option. | | `options.label` | String, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md), [Plain Text](#plain-text), [Mrkdwn](#mrkdwn) | Yes | A label for the option on a [checkbox group](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#checkbox-group) or [radio group](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#radio-group) | | | String, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md), [Plain Text](#plain-text) | Yes | A label for the option on [overflow](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#overflow) or [select](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#select). | | `options.value` | Boolean | No | The value of the option. **The `value` key is only available in [checkbox groups](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#checkbox-group).** | | `options.description` | String, [Plain Text](#plain-text), [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | No | The description of the option. | | `options.url` | String | No | A URL to load in the user's browser when the option is selected. **The `url` key is available only in [overflow menus](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#overflow).** | ## Option Groups Available in: [Select](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#select) Provides a way to group options in a [select](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/elements.md#select) component. **Example** ```yaml optionGroups: - label: "Option Group 1" options: - identifier: "option_1" label: "Option 1" description: "This is option 1" - identifier: "option_2" label: "Option 2" description: "This is option 2" - label: "Option Group 2" options: - identifier: "option_3" label: "Option 3" description: "This is option 3" - identifier: "option_3" label: "Option 4" description: "This is option 4" ``` | Key | Type | Required | Description | | ---------------------- | -------------------------------------------------------------------------- | -------- | -------------------------------------- | | `optionGroups` | Array, [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | Yes | A list of option groups. | | `optionGroups.label` | String, [Plain Text](#plain-text), [Expression](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/build/expressions.md) | Yes | A label for the group. | | `optionGroups.options` | Array of [Options](#options) | Yes | Selectable items in the options group. | ## Text Object Many properties accept a string, mrkdwn, or plain text. For these properties, if the value is a string, the component renders plain text. If the value is an object it must be a [Mrkdwn](#mrkdwn) or [Plain Text](#plain-text) object. - [Mrkdwn](#mrkdwn) - [Plain Text](#plain-text) ### Mrkdwn Slack's implementation of markdown is called **mrkdwn**. For more details on formatting with mrkdwn, see [Slack's formatting documentation](https://api.slack.com/reference/surfaces/formatting#basics). **Examples** This example creates mrkdwn text with simple formatting and an emoji. ```yaml text: type: "mrkdwn" text: "This label contains *bold text* and an emoji :smile:." ``` By default, control characters in markdown are encoded, including the `<`, `>`, and `&` characters. To use control characters in `mrkdwn` to tag users or denote links, set the `disableEncoding` property to `true`. This example creates mrkdwn text with a link and an emoji. If `disableEncoding` is `false` (default), the angular brackets are rendered as they are. ```yaml label: type: "mrkdwn" text: "This label contains a link and an emoji :smile:." disableEncoding: true ``` This example renders the text `http://salesforce.com` with a link. The link is automatically parsed because `verbatim` is set to `false`. If `verbatim` is `true` (default), the text renders without a link. ```yaml components: - definition: section properties: text: type: "mrkdwn" text: "http://salesforce.com " verbatim: false ``` This example creates mrkdwn text in a [section](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/layout.md#section) and [field](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/uisf.md#field) component. ```yaml description: "Markdown Support Example" schema: properties: boolean_true: # provided as a view property to pass a boolean value instead of a string into the component type: boolean defaultValue: true boolean_false: # provided as a view property to pass a boolean value instead of a string into the component type: boolean defaultValue: false components: - definition: modal properties: title: text: "Markdown Example :smile:" emoji: true submitLabel: text: "My Submit" emoji: false closeLabel: text: "My Close :x:" emoji: true components: - definition: header properties: text: "This is a plain_text header." - definition: section properties: text: text: "This is a plain_text section block without emoji support :smile:." emoji: false - definition: section properties: text: text: "This is a plain_text section block with emoji support :smile:." emoji: true - definition: section properties: text: type: "mrkdwn" text: "This is a mrkdwn section block with a link https://salesforce.com and an emoji :smile:. The link is automatically parsed because verbatim is set to false." verbatim: false - definition: section properties: text: type: "mrkdwn" text: "This is a mrkdwn section block with a link https://salesforce.com that will not be automatically parsed because verbatim defaults to true." - definition: section properties: text: text: "*Record:* This field value contains a link https://salesforce.com" type: mrkdwn - definition: section properties: text: text: "*Record:* This field value contains a " type: mrkdwn disableEncoding: true - definition: section properties: text: text: "*Record:* This field value contains a link with encoded control characters: " type: mrkdwn - definition: section properties: text: text: "*A true boolean is rendered as:* {!view.properties.boolean_true}" type: mrkdwn - definition: section properties: text: text: "*A false boolean is rendered as:* {!view.properties.boolean_false}" type: mrkdwn ``` **Keys** | Key | Type | Required | Description | | ----------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `text` | Object | Yes | A text object. | | `type` | String | Yes | The value must be `mrkdwn`. | | `text` | String | Yes | The text. | | `verbatim` | Boolean | No | When set to `false`, Slack detects and parses certain values like links in markdown. The default value is `true`. To turn on automatic parsing, set this key to `false`. For more information, see [Slack's text object documentation](https://api.slack.com/reference/block-kit/composition-objects#text). | | `disableEncoding` | Boolean | No | By default (`false`), control characters are encoded within markdown. To turn off automatic encoding, set this key to `true`. | ### Plain Text Renders a plain text value with optional support for emojis. **Example** ```yaml text: text: "This label can include emojis :smile:." emoji: true ``` **Keys** | Key | Type | Required | Description | | ------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `text` | Object | Yes | A text object. | | `type` | String | No | The default value is `plain_text`. | | `text` | String | Yes | The text. | | `emoji` | Boolean | No | Slack doesn't support emojis in plain text. To turn on emoji support, set this key to `true`. For more information, see [Slack's text object documentation](https://api.slack.com/reference/block-kit/composition-objects). |