platform_theming_api_common_attributes/com.tomtom.ivi.platform.theming.api.common.attributes/createComponent

createComponent

@IviExperimental(reasons = [])
fun IviThemeCategory.createComponent(id: String, label: StringResolver): IviThemeComponent.WithoutStylingFlavorType
@IviExperimental(reasons = [])
fun IviThemeCategory.createComponent(id: String, label: String): IviThemeComponent.WithoutStylingFlavorType

Creates an IviThemeComponent for theming the IviThemeCategory receiver instance.

The returned IviThemeComponent is not parameterized by an IviThemeCategoryStylingFlavor type. Use this method when additional type-safety checks are not necessary. Use createComponent with the stylingFlavor argument to create an IviThemeComponent which is parameterized by an IviThemeCategoryStylingFlavor enum class for additional type-safety and compile-time verification. See IviThemeCategoryStylingFlavor for more information and an example.

Parameters

id

The unique identifier for the created IviThemeComponent. The following naming convention is applicable: <company>.<product>.themecomponent.<category>.<id>. For example: com.tomtom.ivi.themecomponent.color.dark.

label

The label of the theme component.

@IviExperimental(reasons = [])
fun <SF : Enum<SF>, IviThemeCategoryStylingFlavor> IviThemeCategory.createComponent(id: String, stylingFlavor: SF): IviThemeComponent.WithStylingFlavorType<SF>

Creates an IviThemeComponent for theming the IviThemeCategory receiver instance.

The returned IviThemeComponent is parameterized by an IviThemeCategoryStylingFlavor enum type SF. Use this method when additional type-safety and compile-time checks are desired. Use createComponent without the stylingFlavor argument to create an IviThemeComponent without the additional type-safety. See IviThemeCategoryStylingFlavor for more information and an example.

The IviThemeComponent.label value of the returned instance is set to IviThemeCategoryStylingFlavor.label from stylingFlavor. The IviThemeComponent.id value of the returned instance is set to id.

Parameters

id

The unique identifier for the created IviThemeComponent. The following naming convention is applicable: <company>.<product>.themecomponent.<category>.<id>. For example: com.tomtom.ivi.themecomponent.color.dark.

stylingFlavor

One of the enum class values of enum type SF.

SF

The enum class type that defines a set of IviThemeCategory styling flavors. This type provides type-safety and allows for checking at compile time if all styling flavors are exhausted. See IviThemeCategoryStylingFlavor for more information and an example.