Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ActionParameters = ActionParameters' {
- anchor :: Maybe ComponentProperty
- fields :: Maybe (HashMap Text ComponentProperty)
- global :: Maybe ComponentProperty
- id :: Maybe ComponentProperty
- model :: Maybe Text
- state :: Maybe MutationActionSetStateParameter
- target :: Maybe ComponentProperty
- type' :: Maybe ComponentProperty
- url :: Maybe ComponentProperty
- newActionParameters :: ActionParameters
- actionParameters_anchor :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_fields :: Lens' ActionParameters (Maybe (HashMap Text ComponentProperty))
- actionParameters_global :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_id :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_model :: Lens' ActionParameters (Maybe Text)
- actionParameters_state :: Lens' ActionParameters (Maybe MutationActionSetStateParameter)
- actionParameters_target :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_type :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_url :: Lens' ActionParameters (Maybe ComponentProperty)
Documentation
data ActionParameters Source #
Represents the event action configuration for an element of a
Component
or ComponentChild
. Use for the workflow feature in Amplify
Studio that allows you to bind events and actions to components.
ActionParameters
defines the action that is performed when an event
occurs on the component.
See: newActionParameters
smart constructor.
ActionParameters' | |
|
Instances
newActionParameters :: ActionParameters Source #
Create a value of ActionParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:anchor:ActionParameters'
, actionParameters_anchor
- The HTML anchor link to the location to open. Specify this value for a
navigation action.
$sel:fields:ActionParameters'
, actionParameters_fields
- A dictionary of key-value pairs mapping Amplify Studio properties to
fields in a data model. Use when the action performs an operation on an
Amplify DataStore model.
$sel:global:ActionParameters'
, actionParameters_global
- Specifies whether the user should be signed out globally. Specify this
value for an auth sign out action.
$sel:id:ActionParameters'
, actionParameters_id
- The unique ID of the component that the ActionParameters
apply to.
ActionParameters
, actionParameters_model
- The name of the data model. Use when the action performs an operation on
an Amplify DataStore model.
$sel:state:ActionParameters'
, actionParameters_state
- A key-value pair that specifies the state property name and its initial
value.
$sel:target:ActionParameters'
, actionParameters_target
- The element within the same component to modify when the action occurs.
ActionParameters
, actionParameters_type
- The type of navigation action. Valid values are url
and anchor
. This
value is required for a navigation action.
$sel:url:ActionParameters'
, actionParameters_url
- The URL to the location to open. Specify this value for a navigation
action.
actionParameters_anchor :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The HTML anchor link to the location to open. Specify this value for a navigation action.
actionParameters_fields :: Lens' ActionParameters (Maybe (HashMap Text ComponentProperty)) Source #
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
actionParameters_global :: Lens' ActionParameters (Maybe ComponentProperty) Source #
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
actionParameters_id :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The unique ID of the component that the ActionParameters
apply to.
actionParameters_model :: Lens' ActionParameters (Maybe Text) Source #
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
actionParameters_state :: Lens' ActionParameters (Maybe MutationActionSetStateParameter) Source #
A key-value pair that specifies the state property name and its initial value.
actionParameters_target :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The element within the same component to modify when the action occurs.
actionParameters_type :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The type of navigation action. Valid values are url
and anchor
. This
value is required for a navigation action.
actionParameters_url :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The URL to the location to open. Specify this value for a navigation action.