#[non_exhaustive]pub struct Component {Show 17 fields
pub app_id: String,
pub environment_name: String,
pub source_id: Option<String>,
pub id: String,
pub name: String,
pub component_type: String,
pub properties: HashMap<String, ComponentProperty>,
pub children: Option<Vec<ComponentChild>>,
pub variants: Vec<ComponentVariant>,
pub overrides: HashMap<String, HashMap<String, String>>,
pub binding_properties: HashMap<String, ComponentBindingPropertiesValue>,
pub collection_properties: Option<HashMap<String, ComponentDataConfiguration>>,
pub created_at: DateTime,
pub modified_at: Option<DateTime>,
pub tags: Option<HashMap<String, String>>,
pub events: Option<HashMap<String, ComponentEvent>>,
pub schema_version: Option<String>,
}Expand description
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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.app_id: StringThe unique ID of the Amplify app associated with the component.
environment_name: StringThe name of the backend environment that is a part of the Amplify app.
source_id: Option<String>The unique ID of the component in its original source system, such as Figma.
id: StringThe unique ID of the component.
name: StringThe name of the component.
component_type: StringThe type of the component. This can be an Amplify custom UI component or another custom component.
properties: HashMap<String, ComponentProperty>Describes the component's properties. You can't specify tags as a valid property for properties.
children: Option<Vec<ComponentChild>>A list of the component's ComponentChild instances.
variants: Vec<ComponentVariant>A list of the component's variants. A variant is a unique style configuration of a main component.
overrides: HashMap<String, HashMap<String, String>>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.
binding_properties: HashMap<String, ComponentBindingPropertiesValue>The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.
collection_properties: Option<HashMap<String, ComponentDataConfiguration>>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.
created_at: DateTimeThe time that the component was created.
modified_at: Option<DateTime>The time that the component was modified.
One or more key-value pairs to use when tagging the component.
events: Option<HashMap<String, ComponentEvent>>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.
schema_version: Option<String>The schema version of the component when it was imported.
Implementations§
Source§impl Component
impl Component
Sourcepub fn environment_name(&self) -> &str
pub fn environment_name(&self) -> &str
The name of the backend environment that is a part of the Amplify app.
Sourcepub fn source_id(&self) -> Option<&str>
pub fn source_id(&self) -> Option<&str>
The unique ID of the component in its original source system, such as Figma.
Sourcepub fn component_type(&self) -> &str
pub fn component_type(&self) -> &str
The type of the component. This can be an Amplify custom UI component or another custom component.
Sourcepub fn properties(&self) -> &HashMap<String, ComponentProperty>
pub fn properties(&self) -> &HashMap<String, ComponentProperty>
Describes the component's properties. You can't specify tags as a valid property for properties.
Sourcepub fn children(&self) -> &[ComponentChild]
pub fn children(&self) -> &[ComponentChild]
A list of the component's ComponentChild instances.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .children.is_none().
Sourcepub fn variants(&self) -> &[ComponentVariant]
pub fn variants(&self) -> &[ComponentVariant]
A list of the component's variants. A variant is a unique style configuration of a main component.
Sourcepub fn overrides(&self) -> &HashMap<String, HashMap<String, String>>
pub fn overrides(&self) -> &HashMap<String, HashMap<String, String>>
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.
Sourcepub fn binding_properties(
&self,
) -> &HashMap<String, ComponentBindingPropertiesValue>
pub fn binding_properties( &self, ) -> &HashMap<String, ComponentBindingPropertiesValue>
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.
Sourcepub fn collection_properties(
&self,
) -> Option<&HashMap<String, ComponentDataConfiguration>>
pub fn collection_properties( &self, ) -> Option<&HashMap<String, ComponentDataConfiguration>>
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.
Sourcepub fn created_at(&self) -> &DateTime
pub fn created_at(&self) -> &DateTime
The time that the component was created.
Sourcepub fn modified_at(&self) -> Option<&DateTime>
pub fn modified_at(&self) -> Option<&DateTime>
The time that the component was modified.
One or more key-value pairs to use when tagging the component.
Sourcepub fn events(&self) -> Option<&HashMap<String, ComponentEvent>>
pub fn events(&self) -> Option<&HashMap<String, ComponentEvent>>
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.
Sourcepub fn schema_version(&self) -> Option<&str>
pub fn schema_version(&self) -> Option<&str>
The schema version of the component when it was imported.
Trait Implementations§
impl StructuralPartialEq for Component
Auto Trait Implementations§
impl Freeze for Component
impl RefUnwindSafe for Component
impl Send for Component
impl Sync for Component
impl Unpin for Component
impl UnwindSafe for Component
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);