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 CreateComponentData = CreateComponentData' {
- children :: Maybe [ComponentChild]
- collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
- events :: Maybe (HashMap Text ComponentEvent)
- schemaVersion :: Maybe Text
- sourceId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- bindingProperties :: HashMap Text ComponentBindingPropertiesValue
- componentType :: Text
- name :: Text
- overrides :: HashMap Text (HashMap Text Text)
- properties :: HashMap Text ComponentProperty
- variants :: [ComponentVariant]
- newCreateComponentData :: Text -> Text -> CreateComponentData
- createComponentData_children :: Lens' CreateComponentData (Maybe [ComponentChild])
- createComponentData_collectionProperties :: Lens' CreateComponentData (Maybe (HashMap Text ComponentDataConfiguration))
- createComponentData_events :: Lens' CreateComponentData (Maybe (HashMap Text ComponentEvent))
- createComponentData_schemaVersion :: Lens' CreateComponentData (Maybe Text)
- createComponentData_sourceId :: Lens' CreateComponentData (Maybe Text)
- createComponentData_tags :: Lens' CreateComponentData (Maybe (HashMap Text Text))
- createComponentData_bindingProperties :: Lens' CreateComponentData (HashMap Text ComponentBindingPropertiesValue)
- createComponentData_componentType :: Lens' CreateComponentData Text
- createComponentData_name :: Lens' CreateComponentData Text
- createComponentData_overrides :: Lens' CreateComponentData (HashMap Text (HashMap Text Text))
- createComponentData_properties :: Lens' CreateComponentData (HashMap Text ComponentProperty)
- createComponentData_variants :: Lens' CreateComponentData [ComponentVariant]
Documentation
data CreateComponentData Source #
Represents all of the information that is required to create a component.
See: newCreateComponentData
smart constructor.
CreateComponentData' | |
|
Instances
newCreateComponentData Source #
Create a value of CreateComponentData
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:
CreateComponentData
, createComponentData_children
- A list of child components that are instances of the main component.
$sel:collectionProperties:CreateComponentData'
, createComponentData_collectionProperties
- The data binding configuration for customizing a component's
properties. Use this for a collection component.
CreateComponentData
, createComponentData_events
- The event configuration for the component. Use for the workflow feature
in Amplify Studio that allows you to bind events and actions to
components.
$sel:schemaVersion:CreateComponentData'
, createComponentData_schemaVersion
- The schema version of the component when it was imported.
CreateComponentData
, createComponentData_sourceId
- The unique ID of the component in its original source system, such as
Figma.
$sel:tags:CreateComponentData'
, createComponentData_tags
- One or more key-value pairs to use when tagging the component data.
CreateComponentData
, createComponentData_bindingProperties
- The data binding information for the component's properties.
CreateComponentData
, createComponentData_componentType
- The component type. This can be an Amplify custom UI component or
another custom component.
CreateComponentData
, createComponentData_name
- The name of the component
CreateComponentData
, createComponentData_overrides
- Describes the component properties that can be overriden to customize an
instance of the component.
CreateComponentData
, createComponentData_properties
- Describes the component's properties.
$sel:variants:CreateComponentData'
, createComponentData_variants
- A list of the unique variants of this component.
createComponentData_children :: Lens' CreateComponentData (Maybe [ComponentChild]) Source #
A list of child components that are instances of the main component.
createComponentData_collectionProperties :: Lens' CreateComponentData (Maybe (HashMap Text ComponentDataConfiguration)) Source #
The data binding configuration for customizing a component's properties. Use this for a collection component.
createComponentData_events :: Lens' CreateComponentData (Maybe (HashMap Text ComponentEvent)) Source #
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
createComponentData_schemaVersion :: Lens' CreateComponentData (Maybe Text) Source #
The schema version of the component when it was imported.
createComponentData_sourceId :: Lens' CreateComponentData (Maybe Text) Source #
The unique ID of the component in its original source system, such as Figma.
createComponentData_tags :: Lens' CreateComponentData (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the component data.
createComponentData_bindingProperties :: Lens' CreateComponentData (HashMap Text ComponentBindingPropertiesValue) Source #
The data binding information for the component's properties.
createComponentData_componentType :: Lens' CreateComponentData Text Source #
The component type. This can be an Amplify custom UI component or another custom component.
createComponentData_name :: Lens' CreateComponentData Text Source #
The name of the component
createComponentData_overrides :: Lens' CreateComponentData (HashMap Text (HashMap Text Text)) Source #
Describes the component properties that can be overriden to customize an instance of the component.
createComponentData_properties :: Lens' CreateComponentData (HashMap Text ComponentProperty) Source #
Describes the component's properties.
createComponentData_variants :: Lens' CreateComponentData [ComponentVariant] Source #
A list of the unique variants of this component.