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 Component = Component' {
- children :: Maybe [ComponentChild]
- collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
- events :: Maybe (HashMap Text ComponentEvent)
- modifiedAt :: Maybe ISO8601
- schemaVersion :: Maybe Text
- sourceId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- appId :: Text
- bindingProperties :: HashMap Text ComponentBindingPropertiesValue
- componentType :: Text
- createdAt :: ISO8601
- environmentName :: Text
- id :: Text
- name :: Text
- overrides :: HashMap Text (HashMap Text Text)
- properties :: HashMap Text ComponentProperty
- variants :: [ComponentVariant]
- newComponent :: Text -> Text -> UTCTime -> Text -> Text -> Text -> Component
- component_children :: Lens' Component (Maybe [ComponentChild])
- component_collectionProperties :: Lens' Component (Maybe (HashMap Text ComponentDataConfiguration))
- component_events :: Lens' Component (Maybe (HashMap Text ComponentEvent))
- component_modifiedAt :: Lens' Component (Maybe UTCTime)
- component_schemaVersion :: Lens' Component (Maybe Text)
- component_sourceId :: Lens' Component (Maybe Text)
- component_tags :: Lens' Component (Maybe (HashMap Text Text))
- component_appId :: Lens' Component Text
- component_bindingProperties :: Lens' Component (HashMap Text ComponentBindingPropertiesValue)
- component_componentType :: Lens' Component Text
- component_createdAt :: Lens' Component UTCTime
- component_environmentName :: Lens' Component Text
- component_id :: Lens' Component Text
- component_name :: Lens' Component Text
- component_overrides :: Lens' Component (HashMap Text (HashMap Text Text))
- component_properties :: Lens' Component (HashMap Text ComponentProperty)
- component_variants :: Lens' Component [ComponentVariant]
Documentation
Contains the configuration settings for a user interface (UI) element
for an Amplify app. A component is configured as a primary, stand-alone
UI element. Use ComponentChild
to configure an instance of a
Component
. A ComponentChild
instance inherits the configuration of
the main Component
.
See: newComponent
smart constructor.
Component' | |
|
Instances
Create a value of Component
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:
Component
, component_children
- A list of the component's ComponentChild
instances.
$sel:collectionProperties:Component'
, component_collectionProperties
- The data binding configuration for the component's properties. Use this
for a collection component. You can't specify tags
as a valid
property for collectionProperties
.
Component
, component_events
- Describes the events that can be raised on the component. Use for the
workflow feature in Amplify Studio that allows you to bind events and
actions to components.
$sel:modifiedAt:Component'
, component_modifiedAt
- The time that the component was modified.
$sel:schemaVersion:Component'
, component_schemaVersion
- The schema version of the component when it was imported.
Component
, component_sourceId
- The unique ID of the component in its original source system, such as
Figma.
$sel:tags:Component'
, component_tags
- One or more key-value pairs to use when tagging the component.
$sel:appId:Component'
, component_appId
- The unique ID of the Amplify app associated with the component.
Component
, component_bindingProperties
- The information to connect a component's properties to data at runtime.
You can't specify tags
as a valid property for bindingProperties
.
Component
, component_componentType
- The type of the component. This can be an Amplify custom UI component or
another custom component.
$sel:createdAt:Component'
, component_createdAt
- The time that the component was created.
$sel:environmentName:Component'
, component_environmentName
- The name of the backend environment that is a part of the Amplify app.
$sel:id:Component'
, component_id
- The unique ID of the component.
Component
, component_name
- The name of the component.
Component
, component_overrides
- Describes the component's properties that can be overriden in a
customized instance of the component. You can't specify tags
as a
valid property for overrides
.
Component
, component_properties
- Describes the component's properties. You can't specify tags
as a
valid property for properties
.
$sel:variants:Component'
, component_variants
- A list of the component's variants. A variant is a unique style
configuration of a main component.
component_children :: Lens' Component (Maybe [ComponentChild]) Source #
A list of the component's ComponentChild
instances.
component_collectionProperties :: Lens' Component (Maybe (HashMap Text ComponentDataConfiguration)) Source #
The data binding configuration for the component's properties. Use this
for a collection component. You can't specify tags
as a valid
property for collectionProperties
.
component_events :: Lens' Component (Maybe (HashMap Text ComponentEvent)) Source #
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
component_modifiedAt :: Lens' Component (Maybe UTCTime) Source #
The time that the component was modified.
component_schemaVersion :: Lens' Component (Maybe Text) Source #
The schema version of the component when it was imported.
component_sourceId :: Lens' Component (Maybe Text) Source #
The unique ID of the component in its original source system, such as Figma.
component_tags :: Lens' Component (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the component.
component_appId :: Lens' Component Text Source #
The unique ID of the Amplify app associated with the component.
component_bindingProperties :: Lens' Component (HashMap Text ComponentBindingPropertiesValue) Source #
The information to connect a component's properties to data at runtime.
You can't specify tags
as a valid property for bindingProperties
.
component_componentType :: Lens' Component Text Source #
The type of the component. This can be an Amplify custom UI component or another custom component.
component_environmentName :: Lens' Component Text Source #
The name of the backend environment that is a part of the Amplify app.
component_overrides :: Lens' Component (HashMap Text (HashMap Text Text)) Source #
Describes the component's properties that can be overriden in a
customized instance of the component. You can't specify tags
as a
valid property for overrides
.
component_properties :: Lens' Component (HashMap Text ComponentProperty) Source #
Describes the component's properties. You can't specify tags
as a
valid property for properties
.
component_variants :: Lens' Component [ComponentVariant] Source #
A list of the component's variants. A variant is a unique style configuration of a main component.