class Aws::AmplifyUIBuilder::Types::ComponentEvent
Describes the configuration of an event. You can bind an event and a corresponding action to a ‘Component` or a `ComponentChild`. A button click is an example of an event.
@note When making an API call, you may pass ComponentEvent
data as a hash: { action: "String", binding_event: "String", parameters: { anchor: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, fields: { "String" => { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, }, global: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, id: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, model: "String", state: { component_name: "String", # required property: "String", # required set: { # required binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, }, target: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, type: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, url: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, }, }
@!attribute [rw] action
The action to perform when a specific event is raised. @return [String]
@!attribute [rw] binding_event
Binds an event to an action on a component. When you specify a `bindingEvent`, the event is called when the action is performed. @return [String]
@!attribute [rw] parameters
Describes information about the action. @return [Types::ActionParameters]
@see docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentEvent AWS API Documentation
Constants
- SENSITIVE