divkit.dsl.NeighbourPageSize.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.19.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 width value of the visible part of a neighbouring page.
 * 
 * Can be created using the method [neighbourPageSize].
 * 
 * Required parameters: `type, neighbour_page_width`.
 */
@Generated
class NeighbourPageSize internal constructor(
    @JsonIgnore
    val properties: Properties,
) : PagerLayoutMode {
    @JsonAnyGetter
    internal fun getJsonProperties(): Map = properties.mergeWith(
        mapOf("type" to "fixed")
    )

    operator fun plus(additive: Properties): NeighbourPageSize = NeighbourPageSize(
        Properties(
            neighbourPageWidth = additive.neighbourPageWidth ?: properties.neighbourPageWidth,
        )
    )

    class Properties internal constructor(
        /**
         * Width of the visible part of a neighbouring page.
         */
        val neighbourPageWidth: Property?,
    ) {
        internal fun mergeWith(properties: Map): Map {
            val result = mutableMapOf()
            result.putAll(properties)
            result.tryPutProperty("neighbour_page_width", neighbourPageWidth)
            return result
        }
    }
}

/**
 * @param neighbourPageWidth Width of the visible part of a neighbouring page.
 */
@Generated
fun DivScope.neighbourPageSize(
    `use named arguments`: Guard = Guard.instance,
    neighbourPageWidth: FixedSize? = null,
): NeighbourPageSize = NeighbourPageSize(
    NeighbourPageSize.Properties(
        neighbourPageWidth = valueOrNull(neighbourPageWidth),
    )
)

/**
 * @param neighbourPageWidth Width of the visible part of a neighbouring page.
 */
@Generated
fun DivScope.neighbourPageSizeProps(
    `use named arguments`: Guard = Guard.instance,
    neighbourPageWidth: FixedSize? = null,
) = NeighbourPageSize.Properties(
    neighbourPageWidth = valueOrNull(neighbourPageWidth),
)

/**
 * @param neighbourPageWidth Width of the visible part of a neighbouring page.
 */
@Generated
fun TemplateScope.neighbourPageSizeRefs(
    `use named arguments`: Guard = Guard.instance,
    neighbourPageWidth: ReferenceProperty? = null,
) = NeighbourPageSize.Properties(
    neighbourPageWidth = neighbourPageWidth,
)

/**
 * @param neighbourPageWidth Width of the visible part of a neighbouring page.
 */
@Generated
fun NeighbourPageSize.override(
    `use named arguments`: Guard = Guard.instance,
    neighbourPageWidth: FixedSize? = null,
): NeighbourPageSize = NeighbourPageSize(
    NeighbourPageSize.Properties(
        neighbourPageWidth = valueOrNull(neighbourPageWidth) ?: properties.neighbourPageWidth,
    )
)

/**
 * @param neighbourPageWidth Width of the visible part of a neighbouring page.
 */
@Generated
fun NeighbourPageSize.defer(
    `use named arguments`: Guard = Guard.instance,
    neighbourPageWidth: ReferenceProperty? = null,
): NeighbourPageSize = NeighbourPageSize(
    NeighbourPageSize.Properties(
        neighbourPageWidth = neighbourPageWidth ?: properties.neighbourPageWidth,
    )
)

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