1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
//! # Button //! [slack api docs 🔗] //! //! Works with block types: //! - [Section 🔗] //! - [Actions 🔗] //! //! An interactive component that inserts a button. //! The button can be a trigger for anything from opening //! a simple link to starting a complex workflow. //! //! To use interactive components, //! you will need to make some changes //! to prepare your app. //! //! Read our [guide to enabling interactivity 🔗]. //! //! [slack api docs 🔗]: https://api.slack.com/reference/block-kit/block-elements#button //! [Section 🔗]: https://api.slack.com/reference/block-kit/blocks#section //! [Actions 🔗]: https://api.slack.com/reference/block-kit/blocks#actions //! [guide to enabling interactivity 🔗]: https://api.slack.com/interactivity/handling use std::borrow::Cow; use serde::{Deserialize, Serialize}; use validator::Validate; use crate::{compose::Confirm, text, val_helpr::ValidationResult}; /// # Button /// [slack api docs 🔗] /// /// Works with block types: /// - [Section 🔗] /// - [Actions 🔗] /// /// An interactive component that inserts a button. /// The button can be a trigger for anything from opening /// a simple link to starting a complex workflow. /// /// To use interactive components, /// you will need to make some changes /// to prepare your app. /// /// Read our [guide to enabling interactivity 🔗]. /// /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/block-elements#button /// [Section 🔗]: https://api.slack.com/reference/block-kit/blocks#section /// [Actions 🔗]: https://api.slack.com/reference/block-kit/blocks#actions /// [guide to enabling interactivity 🔗]: https://api.slack.com/interactivity/handling #[derive(Validate, Clone, Debug, Deserialize, Hash, PartialEq, Serialize)] pub struct Button<'a> { #[validate(custom = "validate::text")] text: text::Text, #[validate(length(max = 255))] action_id: Cow<'a, str>, #[serde(skip_serializing_if = "Option::is_none")] #[validate(custom = "validate::url")] url: Option<Cow<'a, str>>, #[serde(skip_serializing_if = "Option::is_none")] #[validate(custom = "validate::value")] value: Option<Cow<'a, str>>, #[serde(skip_serializing_if = "Option::is_none")] style: Option<Style>, #[serde(skip_serializing_if = "Option::is_none")] confirm: Option<Confirm>, } impl<'a> Button<'a> { /// Build a button! /// /// see build::ButtonBuilder for example. pub fn builder() -> build::ButtonBuilderInit<'a> { build::ButtonBuilderInit::new() } /// Create a `Button` from a text label and ID for your app /// to be able to identify what was pressed. /// /// # Arguments /// - `text` - A [text object 🔗] that defines the button's text. /// Can only be of type: `plain_text`. /// Maximum length for the text in this field is 75 characters. /// - `action_id` - An identifier for this action. /// You can use this when you receive an interaction payload to [identify the source of the action 🔗]. /// Should be unique among all other `action_id`s used elsewhere by your app. /// Maximum length for this field is 255 characters. /// /// [identify the source of the action 🔗]: https://api.slack.com/interactivity/handling#payloads /// /// [text object 🔗]: https://api.slack.com/reference/block-kit/composition-objects#text /// /// # Example /// ``` /// use slack_blocks::{blocks::{Actions, Block}, /// elems}; /// /// let btn = elems::Button::from_text_and_action_id("Button", "123"); /// let actions_block: Block = /// Actions::from_action_elements(vec![btn.into()]).into(); /// // < send block to slack's API > /// ``` #[deprecated(since = "0.17.3", note = "use Button::builder instead")] pub fn from_text_and_action_id(text: impl Into<text::Plain>, action_id: impl Into<Cow<'a, str>>) -> Self { Self { text: text.into().into(), action_id: action_id.into(), url: None, value: None, style: None, confirm: None } } /// Configure a button to be a link to an external URL to load /// in the user's browser on click. /// /// # Arguments /// - `url` - A URL to load in the user's browser when the button is clicked. /// 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 🔗]. /// /// [interaction payload 🔗]: https://api.slack.com/interactivity/handling#payloads /// [acknowledgement response 🔗]: https://api.slack.com/interactivity/handling#acknowledgment_response /// /// # Example /// ``` /// use slack_blocks::blocks::{Block, Actions}; /// use slack_blocks::elems; /// /// let btn = elems::Button::from_text_and_action_id("Go to cheese!", "123").with_url("https://www.cheese.com/"); /// let actions_block: Block = Actions::from_action_elements(vec![btn.into()]).into(); /// // < send block to slack's API > /// ``` #[deprecated(since = "0.17.3", note = "use Button::builder instead")] pub fn with_url(mut self, url: impl Into<Cow<'a, str>>) -> Self { self.url = Some(url.into()); self } /// Add a meaningful value to send back to your app when this button is clicked. /// /// # Arguments /// - `value` - The value to send along with the interaction payload. /// Maximum length for this field is 2000 characters. /// /// # Example /// ``` /// use slack_blocks::blocks::{Block, Actions}; /// use slack_blocks::elems; /// /// let btn = elems::Button::from_text_and_action_id("Click me!", "123") /// .with_value("<something that will help your system better act on the interaction>"); /// let actions_block: Block = Actions::from_action_elements(vec![btn.into()]).into(); /// // < send block to slack's API > /// ``` #[deprecated(since = "0.17.3", note = "use Button::builder instead")] pub fn with_value(mut self, value: impl Into<Cow<'a, str>>) -> Self { self.value = Some(value.into()); self } /// Decorates buttons with alternative visual color schemes. /// Use this option with restraint. /// /// If this method is not called, /// the default button style will be used. /// /// # Arguments /// - `style` - The style to decorate your button with. /// /// # Example /// ``` /// use slack_blocks::blocks::{Block, Actions}; /// use slack_blocks::elems::{Button, button::Style}; /// /// let confirm_btn = Button::from_text_and_action_id("Confirm!", "123") /// .with_style(Style::Primary); /// /// let deny_btn = Button::from_text_and_action_id("Deny!", "123") /// .with_style(Style::Danger); /// /// let actions_block: Block = Actions::from_action_elements( /// vec![confirm_btn.into(), deny_btn.into()] /// ).into(); /// // < send block to slack's API > /// ``` #[deprecated(since = "0.17.3", note = "use Button::builder instead")] pub fn with_style(mut self, style: Style) -> Self { self.style = Some(style); self } #[allow(dead_code)] fn with_confirm(_confirm: ()) -> Self { todo!() } // FIX: private until usable /// Validate that this Button element agrees with Slack's model requirements /// /// # Errors /// - If `from_text_and_action_id` was called with an action_id longer /// than 255 chars /// - If `from_text_and_action_id` was called with text longer /// than 75 chars /// - If `with_url` was called with url longer than 3000 chars /// - If `with_value` was called with url longer than 2000 chars /// /// # Example /// ``` /// use slack_blocks::elems::Button; /// /// let long_string = std::iter::repeat(' ').take(256).collect::<String>(); /// /// let btn = Button::from_text_and_action_id("Button", long_string); /// /// assert_eq!(true, matches!(btn.validate(), Err(_))); /// ``` pub fn validate(&self) -> ValidationResult { Validate::validate(self) } } /// Style to optionally decorate buttons with #[derive(Copy, Clone, Debug, Deserialize, Hash, PartialEq, Serialize)] #[serde(rename_all = "snake_case")] pub enum Style { /// Gives buttons a green outline and text, ideal for affirmation or confirmation actions. /// This should only be used for one button within a set. Primary, /// Gives buttons a red outline and text, and should be used when the action is destructive. /// Use this even more sparingly than Primary. Danger, } /// Button builder pub mod build { use std::marker::PhantomData; use super::*; use crate::build::*; /// Required builder methods #[allow(non_camel_case_types)] pub mod method { /// ButtonBuilder.text #[derive(Copy, Clone, Debug)] pub struct text; /// ButtonBuilder.action_id #[derive(Copy, Clone, Debug)] pub struct action_id; } /// Initial state for ButtonBuilder pub type ButtonBuilderInit<'a> = ButtonBuilder<'a, RequiredMethodNotCalled<method::text>, RequiredMethodNotCalled<method::action_id>>; /// # Button Builder /// /// Allows you to construct safely, with compile-time checks /// on required setter methods. /// /// # Required Methods /// `ButtonBuilder::build()` is only available if these methods have been called: /// - `action_id` /// - `text` /// /// ``` /// use std::convert::TryFrom; /// /// use slack_blocks::{blocks, elems}; /// /// let button: elems::BlockElement = elems::Button::builder().text("do stuff!") /// .action_id("stuff") /// .build() /// .into(); /// let block: blocks::Block = /// blocks::Actions::try_from(button).expect("Actions block supports buttons") /// .into(); /// ``` #[derive(Debug)] pub struct ButtonBuilder<'a, Text, ActionId> { text: Option<text::Text>, action_id: Option<Cow<'a, str>>, url: Option<Cow<'a, str>>, value: Option<Cow<'a, str>>, style: Option<Style>, confirm: Option<Confirm>, state: PhantomData<(Text, ActionId)>, } impl<'a, T, A> ButtonBuilder<'a, T, A> { /// Construct a new button builder pub fn new() -> Self { Self { text: None, action_id: None, url: None, value: None, style: None, confirm: None, state: PhantomData::<_> } } /// Set `style` (Optional) /// /// Decorates buttons with alternative visual color schemes. /// /// Use this option with restraint. /// /// If this method is not called, /// the default button style will be used. pub fn style(mut self, style: Style) -> Self { self.style = Some(style); self } /// Set `confirm` (Optional) /// /// A [confirm object 🔗] that defines an optional confirmation dialog after the button is clicked. /// /// [confirm object 🔗]: https://api.slack.com/reference/block-kit/composition-objects#confirm pub fn confirm(mut self, confirm: Confirm) -> Self { self.confirm = Some(confirm); self } /// Set `value` (Optional) /// /// Add a meaningful value to send back to your app when this button is clicked. /// /// Maximum length for this field is 2000 characters. pub fn value(mut self, value: impl Into<Cow<'a, str>>) -> Self { self.value = Some(value.into()); self } /// Set `action_id` (**Required**) /// /// An identifier for this action. /// /// You can use this when you receive an interaction payload to [identify the source of the action 🔗]. /// /// Should be unique among all other `action_id`s used elsewhere by your app. /// /// Maximum length for this field is 255 characters. /// /// [identify the source of the action 🔗]: https://api.slack.com/interactivity/handling#payloads pub fn action_id(self, action_id: impl Into<Cow<'a, str>>) -> ButtonBuilder<'a, T, Set<method::action_id>> { ButtonBuilder { text: self.text, action_id: Some(action_id.into()), url: self.url, value: self.value, style: self.style, confirm: self.confirm, state: PhantomData::<_> } } /// Set `text` (**Required**) /// /// A plain [text object 🔗] that defines the button's text. /// /// Maximum length for the text in this field is 75 characters. /// /// [text object 🔗]: https://api.slack.com/reference/block-kit/composition-objects#text pub fn text(self, text: impl Into<text::Plain>) -> ButtonBuilder<'a, Set<method::text>, A> { ButtonBuilder { text: Some(text.into().into()), action_id: self.action_id, url: self.url, value: self.value, style: self.style, confirm: self.confirm, state: PhantomData::<_> } } } impl<'a> ButtonBuilder<'a, Set<method::text>, Set<method::action_id>> { /// All done building, now give me a darn button! /// /// > `no method name 'build' found for struct 'ButtonBuilder<...>'`? /// Make sure all required setter methods have been called. See docs for `ButtonBuilder`. /// /// ```compile_fail /// use slack_blocks::elems::Button; /// /// let foo = Button::builder().build(); // Won't compile! /// ``` /// /// ``` /// use slack_blocks::{compose::Opt, elems::Button}; /// /// let foo = Button::builder().action_id("foo").text("Do foo").build(); /// ``` pub fn build(self) -> Button<'a> { Button { text: self.text.unwrap(), action_id: self.action_id.unwrap(), url: self.url, confirm: self.confirm, style: self.style, value: self.value } } } } mod validate { use super::*; use crate::{text, val_helpr::{below_len, ValidatorResult}}; pub(super) fn text(text: &text::Text) -> ValidatorResult { below_len("Button Text", 75, text.as_ref()) } pub(super) fn url(url: &Cow<str>) -> ValidatorResult { below_len("Button.url", 3000, url) } pub(super) fn value(value: &Cow<str>) -> ValidatorResult { below_len("Button.text", 2000, value) } }