option_object: Option Object

View source: R/composition_objects.R

option_objectR Documentation

Option Object


An object that represents a single selectable item in a select menu, multi-select menu, checkbox group, radio button group, or overflow menu.


option_object(text, value, description = NULL, url = NULL)



A text_object that defines the text shown in the option on the menu. Overflow, select, and multi-select menus can only use plain_text objects, while radio buttons and checkboxes can use mrkdwn text objects. Maximum length for the text in this field is 75 characters.


The string value that will be passed to your app when this option is chosen. Maximum length for this field is 75 characters.


A plain_text only text object that defines a line of descriptive text shown below the text field beside the radio button. Maximum length for the text object within this field is 75 characters.


A URL to load in the user's browser when the option is clicked. The url attribute is only available in overflow menus. Maximum length for this field is 3000 characters. If you're using url, you'll still receive an interaction payload and will need to send an acknowledgement response.

See Also


Other Composition: confirm_object(), conversation_list_filter(), dispaction_action_configuration(), option_group(), text_object()

samterfa/slackme documentation built on April 11, 2022, 3:29 a.m.