Block: Popup

A Popup block for configuring a modal dialog box containing a form. This block has been deprecated. Please use the PopupOutlet block instead.
Tags:

Overview

The Popup block is used for configuring a modal dialog box containing a form. This block has been deprecated. Please use the PopupOutlet block instead.

PopupConfig

Name Type Required Description
kind "PopupForm" Yes
inputs Dictionary<string, PopupInputsConfig> Yes Items to be induced in the popup
subscribe List<ButtonSubscribeConfig | ModelSubscribeConfig> No A list of objects for subscribing the Popup block to other blocks. popup

ButtonSubscribeConfig

An object for configuring a subscription from a Popup block to a Button block. The subscription allows a popup to be opened or closed by clicking a button.

Name Type Required Description
kind "Button" Yes A constant, Button.
frame string Yes A string specifying the name of the frame in which the Button is located.
source string Yes A string specifying the name of the Button.

ModelSubscribeConfig

An object for configuring a subscription from a Popup block to a Model block. The subscription allows the inputs of a Grasshopper model to be set based on the name-value pairs in a popup form.

Name Type Required Description
kind "Model" Yes A constant, Model.
frame string Yes A string specifying the name of the frame in which the Model is located.
source string Yes A string specifying the name of the Model.
setMessageOnSuccess string No A string specifying the message to display upon the successful solving of the model.
setMessageOnFailure string No A string specifying the message to display upon the failure to solve a model.

PopupInputsConfig

PopupButtonSubmitConfig

Name Type Required Description
kind "SubmitButton" Yes Popup values are only submitted when the button is clicked
text string Yes Text displayed in the button

PopupButtonCancelConfig

Name Type Required Description
kind "CancelButton" Yes The popup will be closed on the click of the button
text string Yes Text displayed in the button

PopupTextConfig

Name Type Required Description
kind "Text" Yes Text is used to input text
text string Yes The text of the text input
type TextType No

TextType

  • "lead"
  • "h1"
  • "h2"
  • "h3"
  • "h4"
  • "h5"
  • "h6"
  • "display-1"
  • "display-2"
  • "display-3"
  • "display-4"

PopupTextAreaConfig

Name Type Required Description
kind "TextArea" Yes TextArea is used to input text
label string Yes The label of the text input
required boolean No Optionally define if the input is required
placeholder string No Optionally display a placeholder when the value is empty

PopupTextInputConfig

Name Type Required Description
kind "TextInput" Yes TextInput is used to input text
label string No The label of the text input
required boolean No Optionally define if the input is required
placeholder string No Optionally display a placeholder when the value is empty

PopupEmailInputConfig

Name Type Required Description
kind "EmailInput" Yes EmailInput is used to input email
label string Yes The label of the input
required boolean No Optionally define if the input is required
placeholder string No Optionally display a placeholder when the value is empty