admob-cmp-compose/dev.avinya.ads.nativead.layout/AdModifier

AdModifier

data class AdModifier(val width: AdLayoutSize = AdLayoutSize.Wrap, val height: AdLayoutSize = AdLayoutSize.Wrap, val minWidthDp: Float? = null, val minHeightDp: Float? = null, val padding: AdInsets = AdInsets(), val margin: AdInsets = AdInsets(), val weight: Float? = null, val aspectRatio: Float? = null, val backgroundArgb: Long? = null, val borderWidthDp: Float? = null, val borderColorArgb: Long? = null, val borderRadiusDp: Float? = null, val cornerRadiusDp: Float? = null, val alpha: Float = 1.0f, val maxWidthDp: Float? = null, val maxHeightDp: Float? = null, val offsetXDp: Float = 0.0f, val offsetYDp: Float = 0.0f, val zIndex: Float = 0.0f, val elevationDp: Float = 0.0f, val clipShape: AdClip = AdClip.None, val display: AdDisplay = AdDisplay.Visible)(source)

A serialisable, platform-agnostic analogue of Compose Modifier for native ad layout nodes. Immutable value object — chaining methods return new copies with the applied change.

Parameters

width

Width sizing policy (Wrap, Match, or Fixed).

height

Height sizing policy (Wrap, Match, or Fixed).

minWidthDp

Minimum width in dp.

minHeightDp

Minimum height in dp.

padding

Inner padding insets.

margin

Outer margin insets.

weight

Flex weight for linear layouts.

aspectRatio

Width/height aspect ratio.

backgroundArgb

Background colour as ARGB long.

borderWidthDp

Border stroke width in dp.

borderColorArgb

Border colour as ARGB long.

borderRadiusDp

Border corner radius in dp.

cornerRadiusDp

Corner radius in dp (also sets clip shape).

alpha

Opacity (0f–1f).

maxWidthDp

Maximum width constraint in dp.

maxHeightDp

Maximum height constraint in dp.

offsetXDp

Horizontal offset in dp.

offsetYDp

Vertical offset in dp.

zIndex

Stacking order.

elevationDp

Shadow elevation in dp.

clipShape

Clipping shape (None, Bounds, Circle, RoundedCorner).

display

Visibility mode (Visible, Invisible, Gone).

Constructors

constructor(width: AdLayoutSize = AdLayoutSize.Wrap, height: AdLayoutSize = AdLayoutSize.Wrap, minWidthDp: Float? = null, minHeightDp: Float? = null, padding: AdInsets = AdInsets(), margin: AdInsets = AdInsets(), weight: Float? = null, aspectRatio: Float? = null, backgroundArgb: Long? = null, borderWidthDp: Float? = null, borderColorArgb: Long? = null, borderRadiusDp: Float? = null, cornerRadiusDp: Float? = null, alpha: Float = 1.0f, maxWidthDp: Float? = null, maxHeightDp: Float? = null, offsetXDp: Float = 0.0f, offsetYDp: Float = 0.0f, zIndex: Float = 0.0f, elevationDp: Float = 0.0f, clipShape: AdClip = AdClip.None, display: AdDisplay = AdDisplay.Visible)

Types

object Companion

Companion with factory functions that start from an empty AdModifier.

Properties

val alpha: Float

val aspectRatio: Float?

val backgroundArgb: Long?

borderColorArgb

val borderColorArgb: Long?

val borderRadiusDp: Float?

val borderWidthDp: Float?

val clipShape: AdClip

val cornerRadiusDp: Float?

val display: AdDisplay

val elevationDp: Float

val height: AdLayoutSize

val margin: AdInsets

val maxHeightDp: Float?

val maxWidthDp: Float?

val minHeightDp: Float?

val minWidthDp: Float?

val offsetXDp: Float

val offsetYDp: Float

val padding: AdInsets

val weight: Float?

val width: AdLayoutSize

val zIndex: Float

Functions

fun alpha(alpha: Float): AdModifier

Sets opacity (0f–1f).

fun aspectRatio(ratio: Float): AdModifier

Sets aspect ratio (must be > 0).

fun background(color: Color): AdModifier

Sets a background colour.

fun border(width: Dp, color: Color, radius: Dp = 0.dp): AdModifier

Draws a border with optional corner radius.

fun clipCircle(): AdModifier

Clips content to a circle.

fun clipRounded(radius: Dp): AdModifier

Clips content with rounded corners.

fun clipToBounds(): AdModifier

Clips content to bounds.

fun cornerRadius(radius: Dp): AdModifier

Rounds corners and sets clip shape.

fun elevation(elevation: Dp): AdModifier

Sets shadow elevation.

fun fillMaxHeight(): AdModifier

Fills the available height.

fun fillMaxSize(): AdModifier

Fills both available width and height.

fun fillMaxWidth(): AdModifier

Fills the available width.

fun gone(): AdModifier

Makes the node gone (removed from layout).

fun height(height: Dp): AdModifier

Sets a fixed height.

fun heightIn(min: Dp? = null, max: Dp? = null): AdModifier

Sets height min/max constraints.

fun invisible(): AdModifier

Makes the node invisible (still occupies space).

fun margin(all: Dp): AdModifier

Applies uniform margin on all sides.

fun margin(horizontal: Dp = 0.dp, vertical: Dp = 0.dp): AdModifier

Applies horizontal and vertical margin.

fun margin(start: Dp = 0.dp, top: Dp = 0.dp, end: Dp = 0.dp, bottom: Dp = 0.dp): AdModifier

Applies per-side margin.

matchParentSize

fun matchParentSize(): AdModifier

Fills both available width and height. Alias for fillMaxSize.

fun maxHeight(height: Dp): AdModifier

Sets a maximum height.

fun maxWidth(width: Dp): AdModifier

Sets a maximum width.

fun minHeight(height: Dp): AdModifier

Sets a minimum height.

fun minWidth(width: Dp): AdModifier

Sets a minimum width.

fun offset(x: Dp = 0.dp, y: Dp = 0.dp): AdModifier

Applies an offset.

fun padding(all: Dp): AdModifier

Applies uniform padding on all sides.

fun padding(horizontal: Dp = 0.dp, vertical: Dp = 0.dp): AdModifier

Applies horizontal and vertical padding.

fun padding(start: Dp = 0.dp, top: Dp = 0.dp, end: Dp = 0.dp, bottom: Dp = 0.dp): AdModifier

Applies per-side padding.

fun shadow(elevation: Dp): AdModifier

Sets shadow elevation. Alias for elevation.

fun size(size: Dp): AdModifier

Sets a fixed size (same width and height).

fun size(width: Dp, height: Dp): AdModifier

Sets a fixed width and height.

fun sizeIn(minWidth: Dp? = null, minHeight: Dp? = null, maxWidth: Dp? = null, maxHeight: Dp? = null): AdModifier

Sets width and height min/max constraints.

fun visible(): AdModifier

Makes the node visible.

fun visible(visible: Boolean): AdModifier

If visible is true, makes visible; otherwise gone.

fun weight(weight: Float): AdModifier

Sets flex weight (must be > 0).

fun width(width: Dp): AdModifier

Sets a fixed width.

fun widthIn(min: Dp? = null, max: Dp? = null): AdModifier

Sets width min/max constraints.

wrapContentHeight

fun wrapContentHeight(): AdModifier

Wraps content height.

wrapContentSize

fun wrapContentSize(): AdModifier

Wraps content width and height.

wrapContentWidth

fun wrapContentWidth(): AdModifier

Wraps content width.

fun zIndex(zIndex: Float): AdModifier

Sets z-index (stacking order).