ActionParameters

import type { ActionParameters } from "https://aws-api.deno.dev/v0.4/services/amplifyuibuilder.ts?docs=full";

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.

interface ActionParameters {

anchor?: ComponentProperty | null;

fields?: {

[key: string]: ComponentProperty | null | undefined;

} | null;

global?: ComponentProperty | null;

id?: ComponentProperty | null;

model?: string | null;

state?: MutationActionSetStateParameter | null;

target?: ComponentProperty | null;

type?: ComponentProperty | null;

url?: ComponentProperty | null;

}

§Properties

anchor?: ComponentProperty | null

[src]

The HTML anchor link to the location to open. Specify this value for a navigation action.

fields?: {

[key: string]: ComponentProperty | null | undefined;

} | null

[src]

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.

global?: ComponentProperty | null

[src]

Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

id?: ComponentProperty | null

[src]

The unique ID of the component that the ActionParameters apply to.

model?: string | null

[src]

The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

state?: MutationActionSetStateParameter | null

[src]

A key-value pair that specifies the state property name and its initial value.