divkit.dsl.Aspect.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-json-builder Show documentation

DivKit is an open source Server-Driven UI (SDUI) framework. SDUI is a an emerging technique that leverage the server to build the user interfaces of their mobile app.

There is a newer version: 30.28.0

Show newest version

@file:Suppress(
    "unused",
    "UNUSED_PARAMETER",
)

package divkit.dsl

import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonValue
import divkit.dsl.annotation.*
import divkit.dsl.core.*
import divkit.dsl.scope.*
import kotlin.Any
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map

/**
 * Fixed aspect ratio. The element's height is calculated based on the width, ignoring the `height` value.
 * 
 * Can be created using the method [aspect].
 * 
 * Required parameters: `ratio`.
 */
@Generated
class Aspect internal constructor(
    @JsonIgnore
    val properties: Properties,
) {
    @JsonAnyGetter
    internal fun getJsonProperties(): Map = properties.mergeWith(emptyMap())

    operator fun plus(additive: Properties): Aspect = Aspect(
        Properties(
            ratio = additive.ratio ?: properties.ratio,
        )
    )

    class Properties internal constructor(
        /**
         * `height = width / ratio`.
         */
        val ratio: Property?,
    ) {
        internal fun mergeWith(properties: Map): Map {
            val result = mutableMapOf()
            result.putAll(properties)
            result.tryPutProperty("ratio", ratio)
            return result
        }
    }
}

/**
 * @param ratio `height = width / ratio`.
 */
@Generated
fun DivScope.aspect(
    `use named arguments`: Guard = Guard.instance,
    ratio: Double? = null,
): Aspect = Aspect(
    Aspect.Properties(
        ratio = valueOrNull(ratio),
    )
)

/**
 * @param ratio `height = width / ratio`.
 */
@Generated
fun DivScope.aspectProps(
    `use named arguments`: Guard = Guard.instance,
    ratio: Double? = null,
) = Aspect.Properties(
    ratio = valueOrNull(ratio),
)

/**
 * @param ratio `height = width / ratio`.
 */
@Generated
fun TemplateScope.aspectRefs(
    `use named arguments`: Guard = Guard.instance,
    ratio: ReferenceProperty? = null,
) = Aspect.Properties(
    ratio = ratio,
)

/**
 * @param ratio `height = width / ratio`.
 */
@Generated
fun Aspect.override(
    `use named arguments`: Guard = Guard.instance,
    ratio: Double? = null,
): Aspect = Aspect(
    Aspect.Properties(
        ratio = valueOrNull(ratio) ?: properties.ratio,
    )
)

/**
 * @param ratio `height = width / ratio`.
 */
@Generated
fun Aspect.defer(
    `use named arguments`: Guard = Guard.instance,
    ratio: ReferenceProperty? = null,
): Aspect = Aspect(
    Aspect.Properties(
        ratio = ratio ?: properties.ratio,
    )
)

/**
 * @param ratio `height = width / ratio`.
 */
@Generated
fun Aspect.evaluate(
    `use named arguments`: Guard = Guard.instance,
    ratio: ExpressionProperty? = null,
): Aspect = Aspect(
    Aspect.Properties(
        ratio = ratio ?: properties.ratio,
    )
)

@Generated
fun Aspect.asList() = listOf(this)