string type

This reference documents the Slack types at the platform level. Their availability and structure may differ in each SDK

Type: string

Property	Type	Description
`default`	The type that is being described.	An optional parameter default value.
`description`	string	An optional parameter description.
`examples`	An array of the type being described.	An optional list of examples.
`hint`	string	An optional parameter hint.
`title`	string	An optional parameter title.
`type`	string	String that defines the parameter type.
`minLength`	number	Minimum number of characters comprising the string.
`maxLength`	number	Maximum number of characters comprising the string.
`enum`	string[]	Constrain the available string options to just the list of strings denoted in the `enum` property. Usage of `enum` also instructs any UI that collects a value for this parameter to render a dropdown select input rather than a free-form text input.
`choices`	EnumChoice[]	Defines labels that correspond to the `enum` values. See below.
`format`	string	Define accepted format of the string. Valid options include `url` or `email`.

The `choices` property

The choices property is an array of EnumChoice objects. Here is a closer look at the properties of the EnumChoice object:

Property	Type	Description
`default`	The type that is being described. For example, the default for a `boolean` would be `true` or `false`.	An optional parameter default value.
`description`	string	An optional parameter description.
`examples`	An array of the type being described.	An optional list of examples.
`hint`	string	An optional parameter hint.
`title`	string	An optional parameter title.
`type`	string	String that defines the parameter type.
`value`	The type that the `EnumChoice` object corresponds to; in the example below, it is `string`	The value of the corresponding choice, which must map to the values present in the sibling `enum` property.
`title`	string	The label to display for this `EnumChoice`.
`description`	string	An optional description for this `EnumChoice`.

A choices example using the string Slack type,

In the following example for the string Slack type, defining the choices property allows us to have the label on the input form be capitalized, but the data we're going to save be lowercase.

import { DefineWorkflow, Schema } from "deno-slack-sdk/mod.ts";

// ...

const inputForm = LogFruitWorkflow.addStep(
  Schema.slack.functions.OpenForm,
  {
    title: "Tell us your favorite fruit",
    interactivity: LogFruitWorkflow.inputs.interactivity,
    submit_label: "Submit",
    fields: {
      elements: [{
          name: "Fruit",
          title: "The three best fruits",
          type: Schema.types.string,
          enum: ['mango', 'strawberry', 'plum'],
          choices: [
            {value: 'mango', title: 'Mango!', description: 'Wonderfully tropical'},
            {value: 'strawberry', title: 'Strawberry!', description: 'Absolutely fantastic'},
            {value: 'plum', title: 'Plum!', description: 'Tart, just the way I like em'},
          ]
      }]
      required: ["Fruit"],
    },
  },
);

// ...

Declare a string type:

JSON manifest
Deno Slack SDK

// ...
"notes": {
  "type": "string",
  "title": "notes"
}
// ...

// ...
{
  name: "notes",
  title: "Notes",
  type: Schema.types.string,
},
// ...

String example

In this example workflow, we use a string type to allow a user to add notes about their time off request.

import { Schema } from "deno-slack-sdk/mod.ts";
import { CreateFTOWorkflow } from "../workflows/create_fto_workflow.ts";

const ftoRequestData = CreateFTOWorkflow.addStep(
  Schema.slack.functions.OpenForm,
  {
    title: "Request dates off",
    description: "Hooray for vacay!",
    interactivity: CreateFTOWorkflow.inputs.interactivity,
    submit_label: "Submit request",
    fields: {
      elements: [
        {
          name: "start_date",
          title: "Start date",
          type: Schema.slack.types.date,
        },
        {
          name: "end_date",
          title: "End date",
          type: Schema.slack.types.date,
        },
        {
          name: "notes",
          title: "Notes",
          description: "Anything to note?",
          type: Schema.types.string,
          long: true, // renders the input box as a multi-line text box on the form
        },
      ],
      required: ["start_date", "end_date"],
    },
  },
);

The choices property​

The `choices` property