Compose 修飾子のリスト

操作

スコープ: 任意
@ExperimentalFoundationApi
<T : Any?> Modifier.anchoredDraggable(
    state: AnchoredDraggableState<T>,
    orientation: Orientation,
    enabled: Boolean,
    interactionSource: MutableInteractionSource?,
    overscrollEffect: OverscrollEffect?,
    startDragImmediately: Boolean
)

一連の事前定義値の間でドラッグ操作を有効にします。

スコープ: 任意
@ExperimentalFoundationApi
<T : Any?> Modifier.anchoredDraggable(
    state: AnchoredDraggableState<T>,
    reverseDirection: Boolean,
    orientation: Orientation,
    enabled: Boolean,
    interactionSource: MutableInteractionSource?,
    overscrollEffect: OverscrollEffect?,
    startDragImmediately: Boolean
)

一連の事前定義値の間でドラッグ操作を有効にします。

スコープ: 任意
Modifier.clickable(
    enabled: Boolean,
    onClickLabel: String?,
    role: Role?,
    onClick: () -> Unit
)

入力またはユーザー補助「クリック」イベントを介してクリックを受信するようにコンポーネントを構成します。

スコープ: 任意
Modifier.clickable(
    interactionSource: MutableInteractionSource?,
    indication: Indication?,
    enabled: Boolean,
    onClickLabel: String?,
    role: Role?,
    onClick: () -> Unit
)

入力またはユーザー補助「クリック」イベントを介してクリックを受信するようにコンポーネントを構成します。

スコープ: 任意
@ExperimentalFoundationApi
Modifier.combinedClickable(
    enabled: Boolean,
    onClickLabel: String?,
    role: Role?,
    onLongClickLabel: String?,
    onLongClick: (() -> Unit)?,
    onDoubleClick: (() -> Unit)?,
    onClick: () -> Unit
)

入力またはユーザー補助「クリック」イベントを介してクリック、ダブルクリック、長押しを受信するようにコンポーネントを構成します。

スコープ: 任意
@ExperimentalFoundationApi
Modifier.combinedClickable(
    interactionSource: MutableInteractionSource?,
    indication: Indication?,
    enabled: Boolean,
    onClickLabel: String?,
    role: Role?,
    onLongClickLabel: String?,
    onLongClick: (() -> Unit)?,
    onDoubleClick: (() -> Unit)?,
    onClick: () -> Unit
)

入力またはユーザー補助「クリック」イベントを介してクリック、ダブルクリック、長押しを受信するようにコンポーネントを構成します。

スコープ: 任意
@ExperimentalFoundationApi
Modifier.mouseClickable(
    enabled: Boolean,
    onClickLabel: String?,
    role: Role?,
    onClick: MouseClickScope.() -> Unit
)

Modifier.clickable に似た修飾子を作成しますが、押されたボタンとキーボード修飾子に関する情報を含む追加のコンテキストを提供します。

スコープ: 任意
@ExperimentalFoundationApi
Modifier.draggable2D(
    state: Draggable2DState,
    enabled: Boolean,
    interactionSource: MutableInteractionSource?,
    startDragImmediately: Boolean,
    onDragStarted: (startedPosition: Offset) -> Unit,
    onDragStopped: (velocity: Velocity) -> Unit,
    reverseDirection: Boolean
)

両方の向きで UI 要素のタッチドラッグを構成します。

スコープ: 任意
Modifier.draggable(
    state: DraggableState,
    orientation: Orientation,
    enabled: Boolean,
    interactionSource: MutableInteractionSource?,
    startDragImmediately: Boolean,
    onDragStarted: suspend CoroutineScope.(startedPosition: Offset) -> Unit,
    onDragStopped: suspend CoroutineScope.(velocity: Float) -> Unit,
    reverseDirection: Boolean
)

単一の Orientation で UI 要素のタッチドラッグを構成します。

スコープ: 任意

この修飾子は、ユーザー補助の目的で selectable アイテム(Tab や RadioButton など)のリストをグループ化するために使用します。

スコープ: 任意
Modifier.selectable(
    selected: Boolean,
    enabled: Boolean,
    role: Role?,
    onClick: () -> Unit
)

通常は、任意の時点で 1 つのアイテムのみを選択できる相互排他的なグループの一部として選択可能になるようにコンポーネントを構成します。

スコープ: 任意
Modifier.selectable(
    selected: Boolean,
    interactionSource: MutableInteractionSource?,
    indication: Indication?,
    enabled: Boolean,
    role: Role?,
    onClick: () -> Unit
)

通常は、任意の時点で 1 つのアイテムのみを選択できる相互排他的なグループの一部として選択可能になるようにコンポーネントを構成します。

スコープ: 任意
@ExperimentalMaterialApi
<T : Any?> Modifier. swipeable(
    state: SwipeableState<T>,
    anchors: Map<Float, T>,
    orientation: Orientation,
    enabled: Boolean,
    reverseDirection: Boolean,
    interactionSource: MutableInteractionSource?,
    thresholds: (from, to) -> ThresholdConfig,
    resistance: ResistanceConfig?,
    velocityThreshold: Dp
)

この関数は非推奨になりました。Material の Swipeable は、Foundation の AnchoredDraggable API に置き換えられました。

スコープ: 任意
@ExperimentalWearMaterialApi
<T : Any?> Modifier.swipeable(
    state: SwipeableState<T>,
    anchors: Map<Float, T>,
    orientation: Orientation,
    enabled: Boolean,
    reverseDirection: Boolean,
    interactionSource: MutableInteractionSource?,
    thresholds: (from, to) -> ThresholdConfig,
    resistance: ResistanceConfig?,
    velocityThreshold: Dp
)

事前定義された状態のセット間でスワイプ操作を有効にします。

スコープ: 任意
Modifier.toggleable(
    value: Boolean,
    enabled: Boolean,
    role: Role?,
    onValueChange: (Boolean) -> Unit
)

入力イベントとユーザー補助イベントを介して切り替え可能になるようにコンポーネントを構成します。

スコープ: 任意
Modifier.toggleable(
    value: Boolean,
    interactionSource: MutableInteractionSource?,
    indication: Indication?,
    enabled: Boolean,
    role: Role?,
    onValueChange: (Boolean) -> Unit
)

入力イベントとユーザー補助イベントを介して切り替え可能になるようにコンポーネントを構成します。

スコープ: 任意
Modifier.triStateToggleable(
    state: ToggleableState,
    enabled: Boolean,
    role: Role?,
    onClick: () -> Unit
)

入力イベントとユーザー補助イベントを介して、オン、オフ、不確定の 3 つの状態の間で切り替え可能になるようにコンポーネントを構成します。

スコープ: 任意
Modifier.triStateToggleable(
    state: ToggleableState,
    interactionSource: MutableInteractionSource?,
    indication: Indication?,
    enabled: Boolean,
    role: Role?,
    onClick: () -> Unit
)

入力イベントとユーザー補助イベントを介して、オン、オフ、不確定の 3 つの状態の間で切り替え可能になるようにコンポーネントを構成します。

位置揃え

スコープ: RowScope

Row 内で要素を垂直方向に揃えます。

スコープ: RowScope
Modifier.alignBy(alignmentLineBlock: (Measured) -> Int)

要素を垂直方向に配置して、alignmentLineBlock によって決定されるコンテンツの整列ラインが alignBy に構成された兄弟要素とも揃うようにします。

スコープ: RowScope

要素を垂直方向に配置して、alignmentLinealignBy に構成された兄弟要素とも揃うようにします。

スコープ: RowScope

要素を垂直方向に配置して、最初の基準線が alignByBaseline または alignBy に構成された兄弟要素とも揃うようにします。

スコープ: ColumnScope

Column 内で要素を水平方向に揃えます。

スコープ: ColumnScope
Modifier.alignBy(alignmentLineBlock: (Measured) -> Int)

要素を水平方向に配置して、alignmentLineBlock によって決定されるコンテンツの整列ラインが alignBy に構成された兄弟要素とも揃うようにします。

スコープ: ColumnScope

要素を水平方向に配置して、alignmentLinealignBy に構成された兄弟要素とも揃うようにします。

スコープ: BoxScope
Modifier.align(alignment: Alignment)

Box 内の特定の Alignment にコンテンツ要素をプルします。

アニメーション

Modifier.animateEnterExit(
    enter: EnterTransition,
    exit: ExitTransition,
    label: String
)

AnimatedVisibility の直接または間接の子に animateEnterExit 修飾子を使用すると、AnimatedVisibility で指定されたアニメーションとは異なる開始/終了アニメーションを作成できます。

スコープ: LazyItemScope
Modifier.animateItem(
    fadeInSpec: FiniteAnimationSpec<Float>?,
    placementSpec: FiniteAnimationSpec<IntOffset>?,
    fadeOutSpec: FiniteAnimationSpec<Float>?
)

この修飾子は、アイテムの表示(フェードイン)、非表示(フェードアウト)、配置の変更(アイテムの並べ替えなど)をアニメーション化します。

スコープ: LazyItemScope

この関数は非推奨になりました。代わりに Modifier.animateItem() を使用してください

Modifier.animateItem(
    fadeInSpec: FiniteAnimationSpec<Float>?,
    placementSpec: FiniteAnimationSpec<IntOffset>?,
    fadeOutSpec: FiniteAnimationSpec<Float>?
)

この修飾子は、アイテムの外観(フェードイン)、消失(フェードアウト)、配置の変化(アイテムの並べ替えなど)をアニメーション化します。

この関数は非推奨になりました。代わりに Modifier.animateItem() を使用してください

枠線

スコープ: 任意
Modifier.border(border: BorderStroke, shape: Shape)

要素を変更して、bordershape で指定された外観の枠線を追加してクリップします。

スコープ: 任意
Modifier.border(width: Dp, brush: Brush, shape: Shape)

要素を変更して、widthbrushshape で指定された外観の枠線を追加してクリップします。

スコープ: 任意
Modifier.border(width: Dp, color: Color, shape: Shape)

要素を変更して、widthcolorshape で指定された外観の枠線を追加してクリップします。

描画

スコープ: 任意
Modifier.alpha(alpha: Float)

変更されたアルファ値が 1 未満である可能性があるコンテンツを描画します。

スコープ: 任意
Modifier.background(color: Color, shape: Shape)

コンテンツの背後に塗りつぶした colorshape を描画します。

スコープ: 任意
Modifier.background(
    brush: Brush,
    shape: Shape,
    alpha: @FloatRange(from = 0.0, to = 1.0) Float
)

コンテンツの背後に brushshape を描画します。

スコープ: 任意
Modifier.clip(shape: Shape)

コンテンツを shape にクリップします。

スコープ: 任意

コンテンツを、この修飾子で定義されたレイヤの境界にクリップします。

スコープ: 任意
Modifier.drawBehind(onDraw: DrawScope.() -> Unit)

変更されたコンテンツの背後の Canvas に描画します。

スコープ: 任意
Modifier.drawWithCache(onBuildDrawCache: CacheDrawScope.() -> DrawResult)

描画領域のサイズが同じであるか、読み取られる状態オブジェクトが変更されていない場合に限り、描画呼び出し全体で保持されるコンテンツを含む DrawScope に描画します。

スコープ: 任意

デベロッパーがレイアウトのコンテンツの前または後に描画できる DrawModifier を作成します。

スコープ: 任意
Modifier.indication(
    interactionSource: InteractionSource,
    indication: Indication?
)

インタラクションが発生したときに、このコンポーネントの視覚効果を描画します。

スコープ: 任意
Modifier.paint(
    painter: Painter,
    sizeToIntrinsics: Boolean,
    alignment: Alignment,
    contentScale: ContentScale,
    alpha: Float,
    colorFilter: ColorFilter?
)

painter を使用してコンテンツをペイントします。

スコープ: 任意
Modifier.shadow(
    elevation: Dp,
    shape: Shape,
    clip: Boolean,
    ambientColor: Color,
    spotColor: Color
)

シャドウを描画する graphicsLayer を作成します。

スコープ: 任意

safe drawing インセットに合わせてパディングを追加します。

スコープ: 任意
Modifier.zIndex(zIndex: Float)

同じ親レイアウトの子の描画順序を制御する修飾子を作成します。

フォーカス

スコープ: 任意
Modifier.onFocusChanged(onFocusChanged: (FocusState) -> Unit)

この修飾子をコンポーネントに追加すると、フォーカス状態イベントを監視できます。

スコープ: 任意
Modifier.onFocusEvent(onFocusEvent: (FocusState) -> Unit)

この修飾子をコンポーネントに追加すると、フォーカス状態イベントを監視できます。

スコープ: 任意

この関数は非推奨になりました。focusTarget に置き換えられています。

スコープ: 任意

この修飾子をコンポーネントに追加すると、フォーカス可能にすることができます。

スコープ: 任意
Modifier. focusOrder(focusOrderReceiver: FocusOrder.() -> Unit)

この関数は非推奨になりました。代わりに focusProperties() を使用してください。

スコープ: 任意
Modifier. focusOrder(focusRequester: FocusRequester)

この関数は非推奨になりました。代わりに focusRequester() を使用してください。

スコープ: 任意
Modifier. focusOrder(
    focusRequester: FocusRequester,
    focusOrderReceiver: FocusOrder.() -> Unit
)

この関数は非推奨になりました。代わりに focusProperties() と focusRequester() を使用してください。

スコープ: 任意

この修飾子を使用すると、修飾子チェーンの下位または子レイアウト ノードの focusTarget がアクセスできるプロパティを指定できます。

スコープ: 任意

この修飾子をコンポーネントに追加すると、フォーカスの変更をリクエストできます。

スコープ: 任意

この修飾子を使用すると、フォーカス グループにフォーカスを保存して復元できます。

スコープ: 任意

フォーカス グループを作成するか、このコンポーネントをフォーカス グループとしてマークします。

スコープ: 任意
Modifier.focusable(
    enabled: Boolean,
    interactionSource: MutableInteractionSource?
)

フォーカス システムまたはユーザー補助「フォーカス」イベントを介してフォーカス可能になるようにコンポーネントを構成します。

スコープ: 任意

現在フォーカスされているエリアの境界が変化するたびに、onPositioned を呼び出します。

グラフィック

スコープ: 任意

描画レイヤにコンテンツを描画する Modifier.Node

スコープ: 任意
Modifier.graphicsLayer(
    scaleX: Float,
    scaleY: Float,
    alpha: Float,
    translationX: Float,
    translationY: Float,
    shadowElevation: Float,
    rotationX: Float,
    rotationY: Float,
    rotationZ: Float,
    cameraDistance: Float,
    transformOrigin: TransformOrigin,
    shape: Shape,
    clip: Boolean,
    renderEffect: RenderEffect?,
    ambientShadowColor: Color,
    spotShadowColor: Color,
    compositingStrategy: CompositingStrategy
)

描画レイヤにコンテンツを描画する Modifier.Element

スコープ: 任意

描画レイヤを追加してツールが描画された画像の要素を識別できるようにする Modifier.Element

キーボード

スコープ: 任意
Modifier.onKeyEvent(onKeyEvent: (KeyEvent) -> Boolean)

この modifier をコンポーネントの modifier パラメータに追加すると、そのコンポーネント(またはその子のいずれか)がフォーカスされたときにハードウェア キーイベントをインターセプトできます。

スコープ: 任意
Modifier.onPreviewKeyEvent(onPreviewKeyEvent: (KeyEvent) -> Boolean)

この modifier をコンポーネントの modifier パラメータに追加すると、そのコンポーネント(またはその子のいずれか)がフォーカスされたときにハードウェア キーイベントをインターセプトできます。

レイアウト

スコープ: 任意
Modifier.layoutId(layoutId: String, tag: String?)

tag の使用を可能にする androidx.compose.ui.layout.layoutId の代替。

スコープ: 任意
Modifier.layoutId(layoutId: Any)

要素に layoutId をタグ付けすると、その要素を親要素内で識別できます。

スコープ: 任意

ラップされた要素の測定方法とレイアウト方法の変更を可能にする LayoutModifier を作成します。

スコープ: 任意
Modifier.onGloballyPositioned(
    onGloballyPositioned: (LayoutCoordinates) -> Unit
)

コンテンツのグローバル位置が変更された可能性がある場合に、要素の LayoutCoordinates を使用して onGloballyPositioned を呼び出します。

パディング

スコープ: 任意
Modifier.paddingFrom(alignmentLine: AlignmentLine, before: Dp, after: Dp)

パディングを追加して、境界から alignment line までの指定された距離に応じてコンテンツを配置できる Modifier

スコープ: 任意
Modifier.paddingFrom(
    alignmentLine: AlignmentLine,
    before: TextUnit,
    after: TextUnit
)

パディングを追加して、境界から alignment line までの指定された距離に応じてコンテンツを配置できる Modifier

スコープ: 任意
Modifier.paddingFromBaseline(top: Dp, bottom: Dp)

レイアウトの上部から baseline of the first line of text in the content までの距離が top になり、baseline of the last line of text in the content からレイアウトの下部までの距離が bottom になるようにコンテンツをレイアウト内に配置する Modifier

スコープ: 任意

レイアウトの上部から baseline of the first line of text in the content までの距離が top になり、baseline of the last line of text in the content からレイアウトの下部までの距離が bottom になるようにコンテンツをレイアウト内に配置する Modifier

スコープ: 任意
Modifier.absolutePadding(left: Dp, top: Dp, right: Dp, bottom: Dp)

コンテンツの lefttoprightbottom の端に沿って、Dp の追加スペースを適用します。

スコープ: 任意

コンテンツの左、上、右、下の端に all dp の追加スペースを適用します。

スコープ: 任意
Modifier.padding(paddingValues: PaddingValues)

コンテンツの左、上、右、下の端に沿って、PaddingValues を追加スペースとしてコンポーネントに適用します。

スコープ: 任意
Modifier.padding(horizontal: Dp, vertical: Dp)

コンテンツの左端と右端に沿って horizontal dp のスペースを適用し、上端と下端に沿って vertical dp のスペースを適用します。

スコープ: 任意
Modifier.padding(start: Dp, top: Dp, end: Dp, bottom: Dp)

コンテンツの starttopendbottom の端に沿って、Dp の追加スペースを適用します。

スコープ: 任意

caption bar インセットに合わせてパディングを追加します。

スコープ: 任意

display cutout に合わせてパディングを追加します。

スコープ: 任意

ime インセットに合わせてパディングを追加します。

スコープ: 任意

mandatory system gestures インセットに合わせてパディングを追加します。

スコープ: 任意

navigation bars インセットに合わせてパディングを追加します。

スコープ: 任意

safe content インセットに合わせてパディングを追加します。

スコープ: 任意

safe gestures インセットに合わせてパディングを追加します。

スコープ: 任意

status bars インセットに合わせてパディングを追加します。

スコープ: 任意

system bars インセットに合わせてパディングを追加します。

スコープ: 任意

system gestures インセットに合わせてパディングを追加します。

スコープ: 任意

waterfall インセットに合わせてパディングを追加します。

スコープ: 任意

コンテンツが insets スペースに入らないようにパディングを追加します。

ポインタ

スコープ: 任意
Modifier.pointerHoverIcon(
    icon: PointerIcon,
    overrideDescendants: Boolean
)

要素にカーソルを合わせたときに表示するポインタ アイコンを定義できる修飾子。

スコープ: 任意
@ExperimentalComposeUiApi
Modifier.pointerInteropFilter(
    requestDisallowInterceptTouchEvent: RequestDisallowInterceptTouchEvent?,
    onTouchEvent: (MotionEvent) -> Boolean
)

最初に Compose にディスパッチされた基となる MotionEvent へのアクセスを提供する特別な PointerInputModifier。

スコープ: 任意
@ExperimentalComposeUiApi
Modifier.pointerMoveFilter(
    onMove: (position: Offset) -> Boolean,
    onExit: () -> Boolean,
    onEnter: () -> Boolean
)

ポインタ(マウスやトラックパッド)の移動イベントをトラッキングできる修飾子。

スコープ: 任意
Modifier. pointerInput(block: suspend PointerInputScope.() -> Unit)

この関数は非推奨になりました。Modifier.pointerInput は、修飾子の識別情報を定義する 1 つ以上の「キー」パラメータを提供し、以前の入力処理コルーチンをいつキャンセルして新しいキーの新しい効果を開始するかを決定する必要があります。

スコープ: 任意
Modifier.pointerInput(key1: Any?, block: suspend PointerInputScope.() -> Unit)

変更された要素のリージョン内でポインタ入力を処理する修飾子を作成します。

スコープ: 任意
Modifier.pointerInput(vararg keys: Any?, block: suspend PointerInputScope.() -> Unit)

変更された要素のリージョン内でポインタ入力を処理する修飾子を作成します。

スコープ: 任意
Modifier.pointerInput(key1: Any?, key2: Any?, block: suspend PointerInputScope.() -> Unit)

変更された要素のリージョン内でポインタ入力を処理する修飾子を作成します。

位置

スコープ: 任意

コンテンツを offset ピクセル分オフセットします。

スコープ: 任意

コンテンツをオフセット(x dp、y dp)します。

スコープ: 任意
Modifier.offset(offset: Density.() -> IntOffset)

コンテンツを offset ピクセル分オフセットします。

スコープ: 任意
Modifier.offset(x: Dp, y: Dp)

コンテンツをオフセット(x dp、y dp)します。

スコープ: TabRowDefaults
Modifier.tabIndicatorOffset(currentTabPosition: TabPosition)

TabRow 内で使用可能な幅をすべて取り、適用されるインジケーターのオフセットを currentTabPosition に応じてアニメーション化する Modifier

スコープ: TabRowDefaults
Modifier.tabIndicatorOffset(currentTabPosition: TabPosition)

TabRow 内で使用可能な幅をすべて取り、適用されるインジケーターのオフセットを currentTabPosition に応じてアニメーション化する Modifier

セマンティクス

スコープ: 任意

オペレーションが進行中であることを表す未確定の進行状況インジケーターに必要な semantics を含みます。

スコープ: 任意
Modifier.progressSemantics(
    value: Float,
    valueRange: ClosedFloatingPointRange<Float>,
    steps: @IntRange(from = 0) Int
)

valueRange 内の進行状況を表す確定的な進行状況インジケーターまたはスライダーの進行状況領域に必要な semantics を含みます。

スコープ: 任意
Modifier.rangeSemantics(
    value: Float,
    enabled: Boolean,
    onValueChange: (Float) -> Unit,
    valueRange: ClosedFloatingPointRange<Float>,
    steps: Int
)

ステッパー/スライダーの進行状況を示すセマンティクスを追加する修飾子。

スコープ: 任意

すべての子孫ノードのセマンティクスを消去して新しいセマンティクスを設定します。

スコープ: 任意
Modifier.semantics(mergeDescendants: Boolean, properties: SemanticsPropertyReceiver.() -> Unit)

テストやユーザー補助機能などで使用するため、セマンティクスの Key-Value ペアをレイアウト ノードに追加します。

スクロール

スコープ: 任意

スクロール可能なコンテナの境界をメイン軸にクリップし、交差軸上に背景エフェクト(シャドウなど)のスペースを残します。

スコープ: 任意
Modifier. mouseScrollFilter(
    onMouseScroll: (event: MouseScrollEvent, bounds: IntSize) -> Boolean
)

この関数は非推奨になりました。Modifier.pointerInput + PointerEventType.Scroll を使用する

スコープ: 任意
Modifier.nestedScroll(
    connection: NestedScrollConnection,
    dispatcher: NestedScrollDispatcher?
)

要素を変更して、ネストされたスクロール階層に追加できるようにします。

スコープ: 任意

指定された overscrollEffect からオーバースクロールをレンダリングします。

スコープ: 任意
Modifier.onPreRotaryScrollEvent(
    onPreRotaryScrollEvent: (RotaryScrollEvent) -> Boolean
)

この modifier をコンポーネントの modifier パラメータに追加すると、このコンポーネント(またはその子のいずれか)がフォーカスされたときに RotaryScrollEvent をインターセプトできます。

スコープ: 任意
Modifier.onRotaryScrollEvent(
    onRotaryScrollEvent: (RotaryScrollEvent) -> Boolean
)

この modifier をコンポーネントの modifier パラメータに追加すると、このコンポーネント(またはその子のいずれか)がフォーカスされたときに RotaryScrollEvent をインターセプトできます。

スコープ: 任意
Modifier.rotaryScrollable(
    behavior: RotaryScrollableBehavior,
    focusRequester: FocusRequester,
    reverseDirection: Boolean
)

ロータリー イベントを Column、LazyList などのスクロール可能なコンテナに接続する修飾子。

スコープ: 任意
Modifier.scrollAway(scrollState: ScrollState, offset: Dp)

ScrollState に基づいてアイテムを上下にスクロールして表示 / 非表示にします。

スコープ: 任意
Modifier.scrollAway(
    scrollState: LazyListState,
    itemIndex: Int,
    offset: Dp
)

LazyListState に基づいてアイテムを上下にスクロールして表示 / 非表示にします。

スコープ: 任意
Modifier.scrollAway(
    scrollState: ScalingLazyListState,
    itemIndex: Int,
    offset: Dp
)

ScalingLazyListState に基づいてアイテムを上下にスクロールして表示 / 非表示にします。

スコープ: 任意
Modifier. scrollAway(
    scrollState: ScalingLazyListState,
    itemIndex: Int,
    offset: Dp
)

この関数は非推奨になりました。このオーバーロードは、Wear OS 向け Compose 1.1 との下位互換性を確保するために用意されています。wear.compose.foundation.lazy パッケージの ScalingLazyListState を使用する新しいオーバーロードも利用できます。

スコープ: 任意
Modifier.horizontalScroll(
    state: ScrollState,
    enabled: Boolean,
    flingBehavior: FlingBehavior?,
    reverseScrolling: Boolean
)

要素を変更して、コンテンツの幅が最大制約より大きい場合に水平方向にスクロールできるようにします。

スコープ: 任意
Modifier.verticalScroll(
    state: ScrollState,
    enabled: Boolean,
    flingBehavior: FlingBehavior?,
    reverseScrolling: Boolean
)

要素を変更して、コンテンツの高さが最大制約より大きい場合に垂直方向にスクロールできるようにします。

スコープ: 任意
Modifier.scrollable(
    state: ScrollableState,
    orientation: Orientation,
    enabled: Boolean,
    reverseDirection: Boolean,
    flingBehavior: FlingBehavior?,
    interactionSource: MutableInteractionSource?
)

単一の Orientation で UI 要素のタッチ スクロールとタッチフリングを構成します。

スコープ: 任意
@ExperimentalFoundationApi
Modifier.scrollable(
    state: ScrollableState,
    orientation: Orientation,
    overscrollEffect: OverscrollEffect?,
    enabled: Boolean,
    reverseDirection: Boolean,
    flingBehavior: FlingBehavior?,
    interactionSource: MutableInteractionSource?,
    bringIntoViewSpec: BringIntoViewSpec?
)

単一の Orientation で UI 要素のタッチ スクロールとタッチフリングを構成します。

スコープ: 任意
@ExperimentalTvFoundationApi
Modifier. scrollableWithPivot(
    state: ScrollableState,
    orientation: Orientation,
    pivotOffsets: PivotOffsets,
    enabled: Boolean,
    reverseDirection: Boolean
)

この関数は非推奨になりました。 scrollableWithPivot は非推奨になりました。

スコープ: 任意

Android R 以降で、ソフト キーボードをネストされたスクロールとして制御します。

サイズ

スコープ: 任意
Modifier.animateContentSize(
    animationSpec: FiniteAnimationSpec<IntSize>,
    finishedListener: ((initialValue: IntSize, targetValue: IntSize) -> Unit)?
)

この修飾子は、子修飾子(すでにチェーンの末尾にある場合は子コンポーザブル)のサイズが変更されたときに、自身のサイズをアニメーション化します。

スコープ: 任意
Modifier.animateContentSize(
    animationSpec: FiniteAnimationSpec<IntSize>,
    alignment: Alignment,
    finishedListener: ((initialValue: IntSize, targetValue: IntSize) -> Unit)?
)

この修飾子は、子修飾子(すでにチェーンの末尾にある場合は子コンポーザブル)のサイズが変更されたときに、自身のサイズをアニメーション化します。

スコープ: 任意
Modifier.aspectRatio(
    ratio: @FloatRange(from = 0.0, fromInclusive = false) Float,
    matchHeightConstraintsFirst: Boolean
)

指定されたアスペクト比に一致するようにコンテンツのサイズ調整を試みます。指定された制約のうち、matchHeightConstraintsFirstfalse(デフォルト)の場合は Constraints.maxWidthConstraints.maxHeightConstraints.minWidthConstraints.minHeightmatchHeightConstraintsFirsttrue の場合は Constraints.maxHeightConstraints.maxWidthConstraints.minHeightConstraints.minWidth の順序で一致を試みます。

スコープ: 任意

要素のサイズが小さい場合にタップ操作の曖昧さをなくすため、48 dp 以上のサイズを予約します。

スコープ: 任意

要素のサイズが小さい場合にタップ操作の曖昧さをなくすため、48 dp 以上のサイズを予約します。

スコープ: 任意

要素のサイズが小さい場合にタップ操作の曖昧さをなくすため、48 dp 以上のサイズを予約します。

スコープ: 任意

要素のサイズが小さい場合にタップ操作の曖昧さをなくすため、48 dp 以上のサイズを予約します。

スコープ: 任意
Modifier.height(intrinsicSize: IntrinsicSize)

コンテンツの推奨の高さを、コンテンツの本来の最小の高さまたは最大の高さと同じものとして宣言します。

スコープ: 任意

コンテンツの高さを、コンテンツの本来の最小の高さまたは最大の高さと正確に同じものとして宣言します。

スコープ: 任意

コンテンツの幅を、コンテンツの本来の最小幅または最大幅と正確に同じものとして宣言します。

スコープ: 任意
Modifier.width(intrinsicSize: IntrinsicSize)

コンテンツの推奨の幅を、コンテンツの本来の最小幅または最大幅と同じものとして宣言します。

スコープ: 任意
Modifier.onSizeChanged(onSizeChanged: (IntSize) -> Unit)

要素が最初に測定されたとき、または要素のサイズが変更されたときに、変更された Compose UI 要素のサイズで呼び出されます。

スコープ: 任意
Modifier.defaultMinSize(minWidth: Dp, minHeight: Dp)

他の制約が適用されない場合に限り、ラップされたレイアウトのサイズを制限します。minWidth 制約と minHeight 制約は、対応する受信制約が 0 の場合にのみ適用されます。

スコープ: 任意
Modifier.fillMaxHeight(fraction: @FloatRange(from = 0.0, to = 1.0) Float)

minimum heightmaximum heightmaximum heightfraction を掛けた値に設定することで、コンテンツが受信測定の制約の Constraints.maxHeight を(場合によっては部分的に)満たすようにします。

スコープ: 任意
Modifier.fillMaxSize(fraction: @FloatRange(from = 0.0, to = 1.0) Float)

minimum widthmaximum widthmaximum widthfraction を掛けた値、minimum heightmaximum heightmaximum heightfraction を乗じた値に設定することで、コンテンツで受信測定制約の Constraints.maxWidthConstraints.maxHeight を(部分的にのみ)埋めるようにします。

スコープ: 任意
Modifier.fillMaxWidth(fraction: @FloatRange(from = 0.0, to = 1.0) Float)

コンテンツが受信測定制約の Constraints.maxWidth を完全に(場合によっては部分的に)満たすようにします。そのために、minimum widthmaximum widthmaximum widthfraction を乗じた値に設定します。

スコープ: 任意
Modifier.height(height: Dp)

コンテンツの推奨の高さを正確に height dp として宣言します。

スコープ: 任意
Modifier.heightIn(min: Dp, max: Dp)

コンテンツの高さを、受信測定の Constraints によって許容される min dp から max dp の範囲に制限します。

スコープ: 任意

コンテンツの高さを正確に height dp として宣言します。

スコープ: 任意
Modifier.requiredHeightIn(min: Dp, max: Dp)

コンテンツの高さを min dp から max dp の範囲に制限します。

スコープ: 任意

コンテンツのサイズを正確に size dp の幅と高さで宣言します。

スコープ: 任意

コンテンツのサイズを正確に size として宣言します。

スコープ: 任意
Modifier.requiredSize(width: Dp, height: Dp)

コンテンツのサイズを正確に width dp と height dp で宣言します。

スコープ: 任意
Modifier.requiredSizeIn(
    minWidth: Dp,
    minHeight: Dp,
    maxWidth: Dp,
    maxHeight: Dp
)

コンテンツの幅を minWidth dp から maxWidth dp の範囲に制限し、コンテンツの高さを minHeight dp から maxHeight dp の範囲に制限します。

スコープ: 任意

コンテンツの幅を正確に width dp として宣言します。

スコープ: 任意
Modifier.requiredWidthIn(min: Dp, max: Dp)

コンテンツの幅を min dp から max dp の範囲に制限します。

スコープ: 任意
Modifier.size(size: Dp)

コンテンツの推奨サイズを正確に size dp の四角形として宣言します。

スコープ: 任意
Modifier.size(size: DpSize)

コンテンツの推奨サイズを正確に size として宣言します。

スコープ: 任意
Modifier.size(width: Dp, height: Dp)

コンテンツの推奨サイズを正確に width dp x height dp として宣言します。

スコープ: 任意
Modifier.sizeIn(minWidth: Dp, minHeight: Dp, maxWidth: Dp, maxHeight: Dp)

受信測定の Constraints に従い、コンテンツの幅を minWidth dp から maxWidth dp の範囲に制限し、コンテンツの高さを minHeight dp から maxHeight dp の範囲に制限します。

スコープ: 任意
Modifier.width(width: Dp)

コンテンツの推奨の幅を正確に width dp として宣言します。

スコープ: 任意
Modifier.widthIn(min: Dp, max: Dp)

コンテンツの幅を、受信測定の Constraints によって許容される min dp から max dp の範囲に制限します。

スコープ: 任意
Modifier.wrapContentHeight(
    align: Alignment.Vertical,
    unbounded: Boolean
)

受信測定の minimum height constraint を考慮せずに、コンテンツを希望する高さで測定できるようにします。unbounded が true の場合は、受信測定の maximum height constraint も考慮しません。

スコープ: 任意
Modifier.wrapContentSize(align: Alignment, unbounded: Boolean)

受信測定の minimum width または minimum height の制約を考慮せずに、コンテンツを希望するサイズで測定できるようにします。unbounded が true の場合は、受信測定の最大値の制約も考慮しません。

スコープ: 任意
Modifier.wrapContentWidth(
    align: Alignment.Horizontal,
    unbounded: Boolean
)

受信測定の minimum width constraint を考慮せずに、コンテンツを希望する幅で測定できるようにします。unbounded が true の場合は、受信測定の maximum width constraint も考慮しません。

スコープ: 任意

IconButton と TextButton のサイズと推奨タップ ターゲットの両方を設定する修飾子。

スコープ: 任意

高さを画面の bottom での insets の高さに設定します。

スコープ: 任意

LayoutDirection に応じて left または right を使用して、幅を画面の end での insets の幅に設定します。

スコープ: 任意

LayoutDirection に応じて left または right を使用して、幅を画面の start での insets の幅に設定します。

スコープ: 任意

高さを画面の top での insets の高さに設定します。

スコープ: RowScope
Modifier.weight(
    weight: @FloatRange(from = 0.0, fromInclusive = false) Float,
    fill: Boolean
)

Row 内の他の重み付けされた兄弟要素と比例する weight を使用して、要素の幅を設定します。

スコープ: ColumnScope
Modifier.weight(
    weight: @FloatRange(from = 0.0, fromInclusive = false) Float,
    fill: Boolean
)

Column 内の他の重み付けされた兄弟要素と比例する weight を使用して、要素の高さを設定します。

スコープ: BoxScope

他のすべてのコンテンツ要素の測定後に、Box のサイズに合わせて要素のサイズを設定します。

スコープ: LazyItemScope
Modifier.fillParentMaxHeight(
    fraction: @FloatRange(from = 0.0, to = 1.0) Float
)

コンテンツが受信測定制約の Constraints.maxHeight を満たすようにします。そのために、minimum heightmaximum heightfraction を乗じた値に設定します。

スコープ: LazyItemScope
Modifier.fillParentMaxSize(
    fraction: @FloatRange(from = 0.0, to = 1.0) Float
)

コンテンツが親受信測定制約の Constraints.maxWidthConstraints.maxHeight を満たすようにします。そのために、minimum widthmaximum widthfraction を乗じた値に設定し、minimum heightmaximum heightfraction を乗じた値に設定します。

スコープ: LazyItemScope
Modifier.fillParentMaxWidth(
    fraction: @FloatRange(from = 0.0, to = 1.0) Float
)

コンテンツが親受信測定制約の Constraints.maxWidth を満たすようにします。そのために、minimum widthmaximum widthfraction を乗じた値に設定します。

abstract
Modifier.exposedDropdownSize(matchTextFieldWidth: Boolean)

スコープ内に配置された ExposedDropdownMenu に適用する修飾子。

abstract
Modifier.exposedDropdownSize(matchTextFieldWidth: Boolean)

ExposedDropdownMenuBoxScope 内に配置されたメニューに適用する修飾子。

テスト

スコープ: 任意

タグを適用して、変更された要素をテストで検出できるようにします。

変換

スコープ: 任意
Modifier.rotate(degrees: Float)

コンポーザブルの中心の周りでビューを回転させる角度を設定します。

スコープ: 任意
Modifier.scale(scale: Float)

コンテンツを、横軸と縦軸の両方に沿って同じ倍率で均等に拡大 / 縮小します。

スコープ: 任意
Modifier.scale(scaleX: Float, scaleY: Float)

コンポーザブルのコンテンツを、横軸と縦軸に沿ってそれぞれ指定した倍率で拡大 / 縮小します。

スコープ: 任意
Modifier.transformable(
    state: TransformableState,
    lockRotationOnZoomPan: Boolean,
    enabled: Boolean
)

変更された UI 要素の変換操作を有効にします。

スコープ: 任意
@ExperimentalFoundationApi
Modifier.transformable(
    state: TransformableState,
    canPan: (Offset) -> Boolean,
    lockRotationOnZoomPan: Boolean,
    enabled: Boolean
)

変更された UI 要素の変換操作を有効にします。

その他

スコープ: 任意

適用先の要素をドラッグ&ドロップ オペレーションのソースとして扱えるようにする修飾子。

スコープ: 任意
Modifier.basicMarquee(
    iterations: Int,
    animationMode: MarqueeAnimationMode,
    repeatDelayMillis: Int,
    initialDelayMillis: Int,
    spacing: MarqueeSpacing,
    velocity: Dp
)

幅が広すぎて使用可能なスペースに収まらない変更済みコンテンツには、アニメーション付きのマーキー効果が適用されます。

スコープ: 任意
Modifier.edgeSwipeToDismiss(
    swipeToDismissBoxState: SwipeToDismissBoxState,
    edgeWidth: Dp
)

スワイプによる非表示が、ビューポートのエッジからのみアクティブになるよう制限します。

スコープ: 任意
Modifier.blur(radius: Dp, edgeTreatment: BlurredEdgeTreatment)

指定した半径でぼかしを入れたコンテンツを描画します。

スコープ: 任意
Modifier.blur(
    radiusX: Dp,
    radiusY: Dp,
    edgeTreatment: BlurredEdgeTreatment
)

指定した半径でぼかしを入れたコンテンツを描画します。

スコープ: 任意

scrollIntoView リクエストの送信に使用できる修飾子。

スコープ: 任意

子からの BringIntoViewRequester リクエストに応答し、アイテムが画面上に表示されるようにスクロールする親。

スコープ: 任意
Modifier.composed(
    inspectorInfo: InspectorInfo.() -> Unit,
    factory: @Composable Modifier.() -> Modifier
)

変更する要素ごとに、コンポーズされる Modifier のジャストインタイム コンポジションを宣言します。

スコープ: 任意
@ExperimentalComposeUiApi
Modifier.composed(
    fullyQualifiedName: String,
    key1: Any?,
    inspectorInfo: InspectorInfo.() -> Unit,
    factory: @Composable Modifier.() -> Modifier
)

変更する要素ごとに、コンポーズされる Modifier のジャストインタイム コンポジションを宣言します。

スコープ: 任意
@ExperimentalComposeUiApi
Modifier.composed(
    fullyQualifiedName: String,
    vararg keys: Any?,
    inspectorInfo: InspectorInfo.() -> Unit,
    factory: @Composable Modifier.() -> Modifier
)

変更する要素ごとに、コンポーズされる Modifier のジャストインタイム コンポジションを宣言します。

スコープ: 任意
@ExperimentalComposeUiApi
Modifier.composed(
    fullyQualifiedName: String,
    key1: Any?,
    key2: Any?,
    inspectorInfo: InspectorInfo.() -> Unit,
    factory: @Composable Modifier.() -> Modifier
)

変更する要素ごとに、コンポーズされる Modifier のジャストインタイム コンポジションを宣言します。

スコープ: 任意
@ExperimentalComposeUiApi
Modifier.composed(
    fullyQualifiedName: String,
    key1: Any?,
    key2: Any?,
    key3: Any?,
    inspectorInfo: InspectorInfo.() -> Unit,
    factory: @Composable Modifier.() -> Modifier
)

変更する要素ごとに、コンポーズされる Modifier のジャストインタイム コンポジションを宣言します。

スコープ: 任意
@ExperimentalFoundationApi
Modifier.dragAndDropSource(
    drawDragDecoration: DrawScope.() -> Unit,
    block: suspend DragAndDropSourceScope.() -> Unit
)

適用先の要素をドラッグ&ドロップ オペレーションのソースとして扱えるようにする修飾子。

スコープ: 任意
@ExperimentalFoundationApi
Modifier.dragAndDropTarget(
    shouldStartDragAndDrop: (startEvent: DragAndDropEvent) -> Boolean,
    target: DragAndDropTarget
)

ドラッグ&ドロップ操作からの受信を可能にする修飾子。

スコープ: 任意

この関数は非推奨になりました。systemGestureExclusion を使用してください。

スコープ: 任意

この関数は非推奨になりました。systemGestureExclusion を使用してください。

スコープ: 任意
Modifier.handwritingDetector(callback: () -> Unit)

タッチペンでの手書き入力を検出し、認識されたテキストの処理を別の要素に委任する手書き検出機能として要素を構成します。

スコープ: 任意

タッチペン手書き検出機能でタッチペン手書きによってトリガーされた手書きセッションからのテキスト入力を処理できるタッチペン手書きハンドラとして要素を構成します。

スコープ: 任意
Modifier.hoverable(
    interactionSource: MutableInteractionSource,
    enabled: Boolean
)

ポインタの開始 / 終了イベントを介してカーソルを合わせられるようにコンポーネントを構成します。

スコープ: 任意
inline
Modifier. inspectable(
    noinline inspectorInfo: InspectorInfo.() -> Unit,
    factory: Modifier.() -> Modifier
)

この関数は非推奨になりました。この API を使用すると、必要以上に修飾子の無効化が発生するため、使用は推奨されません。

スコープ: 任意
Modifier.approachLayout(
    isMeasurementApproachInProgress: (lookaheadSize: IntSize) -> Boolean,
    isPlacementApproachInProgress: Placeable.PlacementScope.(lookaheadCoordinates: LayoutCoordinates) -> Boolean,
    approachMeasure: ApproachMeasureScope.(measurable: Measurable, constraints: Constraints) -> MeasureResult
)

先読みパスで計算されたデスティネーション レイアウトに徐々に近づけるように設計されたアプローチ レイアウトを作成します。

スコープ: 任意
Modifier.magnifier(
    sourceCenter: Density.() -> Offset,
    magnifierCenter: (Density.() -> Offset)?,
    onSizeChanged: ((DpSize) -> Unit)?,
    zoom: Float,
    size: DpSize,
    cornerRadius: Dp,
    elevation: Dp,
    clip: Boolean
)

Magnifier ウィジェットを表示し、現在のレイアウト ノードを基準にして sourceCenter にあるコンテンツを拡大して表示します。

スコープ: 任意

この修飾子の左側、またはレイアウト ツリーでこの修飾子より上にある他の修飾子によって提供された ModifierLocal を利用するために使用できる修飾子。

スコープ: 任意
@ExperimentalComposeUiApi
<T : Any?> Modifier.modifierLocalProvider(
    key: ProvidableModifierLocal<T>,
    value: () -> T
)

この修飾子の右側にある他の修飾子、またはこの修飾子が接続されているレイアウト ノードの子である修飾子で読み取り可能な ModifierLocal を提供するために使用できる修飾子。

スコープ: 任意

LayoutModifier と親レイアウトが配置された後、子 LayoutModifier が配置される前に onPlaced を呼び出します。

スコープ: 任意
@ExperimentalWearMaterialApi
@Composable
Modifier.placeholder(
    placeholderState: PlaceholderState,
    shape: Shape,
    color: Color
)

コンポーザブルの上にプレースホルダの形状を描画し、ワイプオフ エフェクトをアニメーション化してプレースホルダを削除します。

スコープ: 任意
@ExperimentalWearMaterialApi
@Composable
Modifier.placeholderShimmer(
    placeholderState: PlaceholderState,
    shape: Shape,
    color: Color
)

コンポーネントの上にプレースホルダのシマーを描画する修飾子。

スコープ: 任意

レイアウト領域または子 pointerInput が受け取る MotionEvent ごとに watcher を呼び出します。

スコープ: 任意

フローティング ウィンドウを表示しないように、レイアウト長方形にマークを付けます。

スコープ: 任意

フローティング ウィンドウを避けるために、ローカル レイアウト座標内の長方形をマークします。

スコープ: 任意

指定された PullRefreshState に基づいて、位置を変換し、下にスワイプして更新のインジケーターのサイズをスケーリングする修飾子。

スコープ: 任意

state にスクロール イベントを提供するネストされたスクロール修飾子。

スコープ: 任意
@ExperimentalMaterialApi
Modifier.pullRefresh(
    onPull: (pullDelta: Float) -> Float,
    onRelease: suspend (flingVelocity: Float) -> Float,
    enabled: Boolean
)

onPull コールバックと onRelease コールバックを提供し、カスタム プル更新コンポーネントの作成を支援するネストされたスクロール修飾子。

スコープ: 任意
@ExperimentalMaterial3Api
Modifier.pullToRefresh(
    isRefreshing: Boolean,
    state: PullToRefreshState,
    enabled: Boolean,
    threshold: Dp,
    onRefresh: () -> Unit
)

コンテナにネストされたスクロールを追加して、下にスワイプして更新のジェスチャーをサポートする修飾子。

スコープ: 任意
@ExperimentalMaterial3Api
Modifier.pullToRefreshIndicator(
    state: PullToRefreshState,
    isRefreshing: Boolean,
    threshold: Dp,
    shape: Shape,
    containerColor: Color,
    elevation: Dp
)

下にスワイプして更新インジケーターのサイズ、オフセット、クリッピング、シャドウ、背景描画を処理する修飾子。カスタム インジケーターを実装する場合に便利です。

スコープ: 任意

現在のノードとすべての子ノードをコンテンツ レシーバとして構成します。

スコープ: 任意
@ExperimentalComposeUiApi
Modifier.onInterceptKeyBeforeSoftKeyboard(
    onInterceptKeyBeforeSoftKeyboard: (KeyEvent) -> Boolean
)

この modifier をコンポーネントの modifier パラメータに追加すると、ハードウェア キーイベントがソフトウェア キーボードに送信される前にインターセプトできます。

スコープ: 任意
@ExperimentalComposeUiApi
Modifier.onPreInterceptKeyBeforeSoftKeyboard(
    onPreInterceptKeyBeforeSoftKeyboard: (KeyEvent) -> Boolean
)

この modifier をコンポーネントの modifier パラメータに追加すると、ハードウェア キーイベントがソフトウェア キーボードに送信される前にインターセプトできます。

スコープ: 任意
Modifier. edgeSwipeToDismiss(
    swipeToDismissBoxState: SwipeToDismissBoxState,
    edgeWidth: Dp
)

この関数は非推奨になりました。SwipeToDismiss が androidx.wear.compose.foundation に移行されました。

スコープ: 任意

システム ジェスチャーからレイアウトの長方形を除外します。

スコープ: 任意

ローカル レイアウト座標内の長方形をシステム ジェスチャーから除外します。

スコープ: 任意

パディングを追加せずに、windowInsetsPadding と同様の他のインセット修飾子により利用されていないインセットを利用します。

スコープ: 任意

インセットに関係なくパディングが追加された場合と同様に、paddingValues をインセットとして利用します。

スコープ: 任意
Modifier.onConsumedWindowInsetsChanged(
    block: (consumedWindowInsets: WindowInsets) -> Unit
)

consumeWindowInsets またはいずれかのパディング修飾子(imePadding など)で消費された WindowInsetsblock を呼び出します。

スコープ: TooltipBoxScope

アンカー コンポーザブルを長押しした後にツールチップを表示するときに、アンカー コンポーザブルに適用する Modifier

この関数は非推奨になりました。MenuAnchorType と有効なパラメータを受け取るオーバーロードを使用する

abstract

ExposedDropdownMenuBoxScope 内の要素(通常はテキスト フィールドまたはテキスト フィールド内のアイコン)に適用する必要がある修飾子。