Список модификаторов 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
)

Настройте сенсорное перетаскивание для элемента пользовательского интерфейса в обеих ориентациях.

Область применения: Любая
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 .

Область применения: Любая

Используйте этот модификатор, чтобы сгруппировать список selectable элементов, таких как вкладки или радиокнопки, для обеспечения доступности.

Область применения: Любая
Modifier . selectable (
selected: Boolean ,
enabled: Boolean ,
role: Role ?,
onClick: () -> Unit
)

Настройте компонент так, чтобы его можно было выбирать, обычно как часть взаимоисключающей группы, где в любой момент времени можно выбрать только один элемент.

Область применения: Любая
Modifier . selectable (
selected: Boolean ,
interactionSource: MutableInteractionSource ?,
indication: Indication ?,
enabled: Boolean ,
role: Role ?,
onClick: () -> Unit
)

Настройте компонент так, чтобы его можно было выбирать, обычно как часть взаимоисключающей группы, где в любой момент времени можно выбрать только один элемент.

Область применения: Любая
@ 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
)

Эта функция устарела. Swipeable материала был заменен API-интерфейсами AnchoredDraggable от Foundation.

Область применения: Любая
@ 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
)

Настройте компонент так, чтобы его можно было переключать с помощью событий ввода и доступности с тремя состояниями: «Включено», «Выключено» и «Неопределенно».

Область применения: Любая
Modifier . triStateToggleable (
state: ToggleableState ,
interactionSource: MutableInteractionSource ?,
indication: Indication ?,
enabled: Boolean ,
role: Role ?,
onClick: () -> Unit
)

Настройте компонент так, чтобы его можно было переключать с помощью событий ввода и доступности с тремя состояниями: «Включено», «Выключено» и «Неопределенно».

Выравнивание

Область: RowScope

Выровняйте элемент по вертикали внутри Row .

Область: RowScope
Modifier . alignBy (alignmentLineBlock: ( Measured ) -> Int )

Расположите элемент вертикально так, чтобы линия выравнивания содержимого, определенная alignmentLineBlock совпадала с родственными элементами, также настроенными для alignBy .

Область: RowScope

Расположите элемент вертикально так, чтобы его alignmentLine совпадало с родственными элементами, также настроенными на alignBy .

Область: RowScope

Расположите элемент вертикально так, чтобы его первая базовая линия совпадала с родственными элементами, также настроенными на alignByBaseline или alignBy .

Область: ColumnScope

Выровняйте элемент по горизонтали внутри Column .

Область: ColumnScope
Modifier . alignBy (alignmentLineBlock: ( Measured ) -> Int )

Расположите элемент горизонтально так, чтобы линия выравнивания содержимого, определенная alignmentLineBlock совпадала с родственными элементами, также настроенными для alignBy .

Область: ColumnScope

Расположите элемент горизонтально так, чтобы его alignmentLine совпадало с родственными элементами, также настроенными на alignBy .

Область применения: BoxScope
Modifier . align (alignment: Alignment )

Подтяните элемент содержимого к определенному Alignment внутри Box .

Анимация

Область: AnimatedVisibilityScope
open

Модификатор animateEnterExit можно использовать для любых прямых или косвенных дочерних элементов AnimatedVisibility для создания анимации входа/выхода, отличной от той, которая указана в AnimatedVisibility .

Область: LazyItemScope
open
Modifier . animateItem (
fadeInSpec: FiniteAnimationSpec < Float >?,
placementSpec: FiniteAnimationSpec < IntOffset >?,
fadeOutSpec: FiniteAnimationSpec < Float >?
)

Этот модификатор анимирует внешний вид элемента (появление), исчезновение (появление) и изменения размещения (например, изменение порядка элементов).

Область: LazyItemScope
open

Эта функция устарела. Вместо этого используйте Modifier.animateItem().

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

Этот модификатор анимирует внешний вид элемента (появление), исчезновение (появление) и изменения размещения (например, изменение порядка элементов).

open

Эта функция устарела. Вместо этого используйте Modifier.animateItem().

Граница

Область применения: Любая
Modifier . border (border: BorderStroke , shape: Shape )

Измените элемент, чтобы добавить границу с внешним видом, заданным border и shape , и обрезать ее.

Область применения: Любая
Modifier . border (width: Dp , brush: Brush , shape: Shape )

Измените элемент, чтобы добавить границу с внешним видом, заданным width , brush и shape , и обрежьте ее.

Область применения: Любая
Modifier . border (width: Dp , color: Color , shape: Shape )

Измените элемент, чтобы добавить рамку с внешним видом, заданным width , color и shape , и обрежьте ее.

Рисунок

Область применения: Любая
Modifier . alpha (alpha: Float )

Нарисуйте контент с измененной альфа-версией, которая может быть меньше 1.

Область применения: Любая
Modifier . background (color: Color , shape: Shape )

Рисует shape сплошным color позади содержимого.

Область применения: Любая
Modifier . background (
brush: Brush ,
shape: Shape ,
alpha: @ FloatRange (from = 0.0, to = 1.0) Float
)

Рисует shape brush позади содержимого.

Область применения: Любая
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 . focusRequester (focusRequester: FocusRequester )

Добавьте этот модификатор к компоненту, чтобы запросить изменения фокуса.

Область применения: Любая

Этот модификатор можно использовать для сохранения и восстановления фокуса фокус-группы.

Область применения: Любая

Создает фокус-группу или помечает этот компонент как фокус-группу.

Область применения: Любая
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 ?)

Альтернатива androidx.compose.ui.layout.layoutId , позволяющая использовать tag .

Область применения: Любая
Modifier . layoutId (layoutId: Any )

Пометьте элемент с помощью layoutId чтобы идентифицировать элемент внутри его родительского элемента.

Область применения: Любая

Создает LayoutModifier , который позволяет изменить способ измерения и размещения обернутого элемента.

Область применения: Любая
Modifier . onGloballyPositioned (
onGloballyPositioned: ( LayoutCoordinates ) -> Unit
)

Вызовите onGloballyPositioned с LayoutCoordinates элемента, когда глобальное положение содержимого могло измениться.

Заполнение

Область применения: Любая
Modifier . paddingFrom (alignmentLine: AlignmentLine , before: Dp , after: Dp )

Modifier , который может добавлять отступы для позиционирования содержимого в соответствии с указанными расстояниями от его границ до alignment line .

Область применения: Любая
Modifier . paddingFrom (
alignmentLine: AlignmentLine ,
before: TextUnit ,
after: TextUnit
)

Modifier , который может добавлять отступы для позиционирования содержимого в соответствии с указанными расстояниями от его границ до alignment line .

Область применения: Любая
Modifier . paddingFromBaseline (top: Dp , bottom: Dp )

Modifier , который позиционирует содержимое в макете таким образом, чтобы расстояние от верхней части макета до 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 . absolutePadding (left: Dp , top: Dp , right: Dp , bottom: Dp )

Примените дополнительное пространство вдоль каждого края содержимого в Dp : left , top , right и bottom .

Область применения: Любая
Modifier . padding (all: Dp )

Примените all dp дополнительного пространства вдоль каждого края содержимого: слева, сверху, справа и снизу.

Область применения: Любая
Modifier . padding (paddingValues: PaddingValues )

Примените PaddingValues ​​к компоненту в качестве дополнительного пространства вдоль каждого края содержимого слева, сверху, справа и снизу.

Область применения: Любая
Modifier . padding (horizontal: Dp , vertical: Dp )

Примените horizontal пространство dp вдоль левого и правого краев содержимого и vertical пространство вдоль верхнего и нижнего краев.

Область применения: Любая
Modifier . padding (start: Dp , top: Dp , end: Dp , bottom: Dp )

Примените дополнительное пространство вдоль каждого края содержимого в Dp : start , top , end и bottom .

Область применения: Любая

Добавляет отступы для размещения вставок 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
)

Специальный PointerInputModifier, который обеспечивает доступ к базовым объектам MotionEvent , первоначально отправленным в Compose.

Область применения: Любая
@ ExperimentalComposeUiApi
Modifier . pointerMoveFilter (
onMove: (position: Offset ) -> Boolean ,
onExit: () -> Boolean ,
onEnter: () -> Boolean
)

Модификатор, позволяющий отслеживать события перемещения указателя (т.е. мыши или трекпада).

Область применения: Любая
Modifier . pointerInput (block: suspend PointerInputScope .() -> Unit )

Эта функция устарела. Modifier.pointerInput должен предоставить один или несколько «ключевых» параметров, которые определяют личность модификатора и определяют, когда его предыдущая сопрограмма обработки ввода должна быть отменена и запущен новый эффект для нового ключа.

Область применения: Любая
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 )

Modifier , который занимает всю доступную ширину внутри TabRow , а затем анимирует смещение индикатора, к которому он применяется, в зависимости от currentTabPosition .

Область: TabRowDefaults
Modifier . tabIndicatorOffset (currentTabPosition: TabPosition )

Modifier , который занимает всю доступную ширину внутри TabRow , а затем анимирует смещение индикатора, к которому он применяется, в зависимости от currentTabPosition .

Семантика

Область применения: Любая

Содержит semantics необходимую для неопределенного индикатора хода выполнения, который представляет факт выполнения операции.

Область применения: Любая
Modifier . progressSemantics (
value: Float ,
valueRange: ClosedFloatingPointRange < Float >,
steps: @ IntRange (from = 0) Int
)

Содержит semantics необходимую для определенного индикатора прогресса или части прогресса ползунка, которая представляет прогресс в пределах valueRange .

Область применения: Любая
Modifier . rangeSemantics (
value: Float ,
enabled: Boolean ,
onValueChange: ( Float ) -> Unit ,
valueRange: ClosedFloatingPointRange < Float >,
steps: Int
)

Модификатор для добавления семантики, обозначающей прогресс степпера/ползунка.

Область применения: Любая

Очищает семантику всех узлов-потомков и устанавливает новую семантику.

Область применения: Любая
Modifier . semantics (mergeDescendants: Boolean , properties: SemanticsPropertyReceiver .() -> Unit )

Добавьте семантические пары ключ/значение в узел макета для использования при тестировании, обеспечении доступности и т. д.

Прокрутка

Область применения: Любая

Обрезает границы прокручиваемого контейнера по главной оси, оставляя место для фоновых эффектов (например, теней) по поперечной оси.

Область применения: Любая
Modifier . mouseScrollFilter (
onMouseScroll: (event: MouseScrollEvent , bounds: IntSize ) -> Boolean
)

Эта функция устарела. Используйте Modifier.pointerInput + PointerEventType.Scroll.

Область применения: Любая

Измените элемент, чтобы он участвовал во вложенной иерархии прокрутки.

Область применения: Любая

Отрисовывает прокрутку из предоставленного overscrollEffect .

Область применения: Любая
Modifier . onPreRotaryScrollEvent (
onPreRotaryScrollEvent: ( RotaryScrollEvent ) -> Boolean
)

Добавление этого modifier к параметру modifier компонента позволит ему перехватывать RotaryScrollEvent s, если он (или один из его дочерних элементов) находится в фокусе.

Область применения: Любая
Modifier . onRotaryScrollEvent (
onRotaryScrollEvent: ( RotaryScrollEvent ) -> Boolean
)

Добавление этого modifier к параметру modifier компонента позволит ему перехватывать RotaryScrollEvent s, если он (или один из его дочерних элементов) находится в фокусе.

Область применения: Любая
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
)

Эта функция устарела. Эта перегрузка предусмотрена для обратной совместимости с Compose for Wear OS 1.1. Доступна более новая перегрузка, которая использует ScalingLazyListState из пакета Wear.compose.foundation.lazy.

Область применения: Любая
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 .

Область применения: Любая
@ ExperimentalFoundationApi
Modifier . scrollable (
state: ScrollableState ,
orientation: Orientation ,
overscrollEffect: OverscrollEffect ?,
enabled: Boolean ,
reverseDirection: Boolean ,
flingBehavior: FlingBehavior ?,
interactionSource: MutableInteractionSource ?,
bringIntoViewSpec: BringIntoViewSpec ?
)

Настройте сенсорную прокрутку и перелистывание для элемента пользовательского интерфейса в одной Orientation .

Область применения: Любая
@ 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
)

Пытается изменить размер содержимого в соответствии с указанным соотношением сторон, пытаясь сопоставить одно из входящих ограничений в следующем порядке: Constraints.maxWidth , Constraints.maxHeight , Constraints.minWidth , Constraints.minHeight , если matchHeightConstraintsFirst имеет false (это значение по умолчанию). или Constraints.maxHeight , Constraints.maxWidth , Constraints.minHeight , Constraints.minWidth , если matchHeightConstraintsFirst имеет true .

Область применения: Любая

Зарезервирует размер не менее 48.dp, чтобы устранить неоднозначность сенсорного взаимодействия, если размер элемента будет меньше.

Область применения: Любая

Зарезервирует размер не менее 48.dp, чтобы устранить неоднозначность сенсорного взаимодействия, если размер элемента будет меньше.

Область применения: Любая

Зарезервирует размер не менее 48.dp, чтобы устранить неоднозначность сенсорного взаимодействия, если размер элемента будет меньше.

Область применения: Любая

Зарезервирует размер не менее 48.dp, чтобы устранить неоднозначность сенсорного взаимодействия, если размер элемента будет меньше.

Область применения: Любая
Modifier . height (intrinsicSize: IntrinsicSize )

Объявите, что предпочтительная высота содержимого равна минимальной или максимальной внутренней высоте содержимого.

Область применения: Любая

Объявите высоту содержимого точно такой же, как минимальная или максимальная внутренняя высота содержимого.

Область применения: Любая
Modifier . requiredWidth (intrinsicSize: IntrinsicSize )

Объявите, что ширина содержимого точно такая же, как минимальная или максимальная внутренняя ширина содержимого.

Область применения: Любая
Modifier . width (intrinsicSize: IntrinsicSize )

Объявите, что предпочтительная ширина содержимого равна минимальной или максимальной внутренней ширине содержимого.

Область применения: Любая
Modifier . onSizeChanged (onSizeChanged: ( IntSize ) -> Unit )

Вызывается с размером измененного элемента пользовательского интерфейса Compose при первом измерении элемента или при изменении размера элемента.

Область применения: Любая
Modifier . defaultMinSize (minWidth: Dp , minHeight: Dp )

Ограничивайте размер завернутого макета только в том случае, если в противном случае он не был бы ограничен: ограничения minWidth и minHeight применяются только тогда, когда входящее соответствующее ограничение равно 0 .

Область применения: Любая
Modifier . fillMaxHeight (fraction: @ FloatRange (from = 0.0, to = 1.0) Float )

Заполните содержимое (возможно, только частично) Constraints.maxHeight входящих ограничений измерения, установив minimum height и maximum height равными maximum height умноженной на fraction .

Область применения: Любая
Modifier . fillMaxSize (fraction: @ FloatRange (from = 0.0, to = 1.0) Float )

Заполните содержимым (возможно, только частично) Constraints.maxWidth и Constraints.maxHeight входящих ограничений измерения, установив minimum width и maximum width равными maximum width умноженной на fraction , а также minimum height и maximum height должна быть равна maximum height умноженной на fraction .

Область применения: Любая
Modifier . fillMaxWidth (fraction: @ FloatRange (from = 0.0, to = 1.0) Float )

Заполните содержимое (возможно, только частично) Constraints.maxWidth входящих ограничений измерения, установив minimum width и maximum width равными maximum width умноженной на fraction .

Область применения: Любая
Modifier . height (height: Dp )

Объявите, что предпочтительная высота содержимого равна height dp.

Область применения: Любая
Modifier . heightIn (min: Dp , max: Dp )

Ограничьте высоту содержимого между min dp и max dp, как это разрешено входящими измерениями Constraints .

Область применения: Любая
Modifier . requiredHeight (height: 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 на height dp.

Область применения: Любая
Modifier . sizeIn (minWidth: Dp , minHeight: Dp , maxWidth: Dp , maxHeight: Dp )

Ограничьте ширину содержимого между minWidth dp и maxWidth dp, а высоту содержимого между minHeight dp и maxHeight dp, как это разрешено входящими измерениями Constraints .

Область применения: Любая
Modifier . width (width: Dp )

Объявите, что предпочтительная ширина содержимого равна width dp.

Область применения: Любая
Modifier . widthIn (min: Dp , max: Dp )

Ограничьте ширину содержимого между min dp и max dp, как это разрешено входящими измерениями Constraints .

Область применения: Любая

Разрешить измерение содержимого на желаемой высоте без учета minimum height constraint входящего измерения и, если значение unbounded равно true, также без учета maximum height constraint входящего измерения.

Область применения: Любая
Modifier . wrapContentSize (align: Alignment , unbounded: Boolean )

Разрешить измерение содержимого желаемого размера без учета ограничений minimum width или minimum height входящего измерения, а также, если значение unbounded истинно, также без учета ограничений максимального входящего значения.

Область применения: Любая

Разрешить содержимому измерять желаемую ширину без учета minimum width constraint входящего измерения, а если unbounded равно true, также без учета maximum width constraint входящего измерения.

Область применения: Любая

Модификатор для установки размера и рекомендуемой цели касания для IconButton и TextButton.

Область применения: Любая

Устанавливает высоту insets в bottom части экрана.

Область применения: Любая

Устанавливает ширину insets в end экрана, используя left или right , в зависимости от LayoutDirection .

Область применения: Любая

Устанавливает ширину insets в start экрана, используя left или right , в зависимости от LayoutDirection .

Область применения: Любая

Устанавливает высоту insets в top части экрана.

Область: RowScope
Modifier . weight (
weight: @ FloatRange (from = 0.0, fromInclusive = false) Float ,
fill: Boolean
)

Размер ширины элемента пропорционален его weight относительно других взвешенных одноуровневых элементов в Row .

Область: ColumnScope
Modifier . weight (
weight: @ FloatRange (from = 0.0, fromInclusive = false) Float ,
fill: Boolean
)

Измените высоту элемента пропорционально его weight относительно других взвешенных одноуровневых элементов в Column .

Область применения: BoxScope

Размер элемента соответствует размеру Box после измерения всех остальных элементов содержимого.

Область: LazyItemScope
Modifier . fillParentMaxHeight (
fraction: @ FloatRange (from = 0.0, to = 1.0) Float
)

Пусть содержимое заполнит Constraints.maxHeight входящих ограничений измерения, установив minimum height , равную maximum height умноженной на fraction .

Область: LazyItemScope
Modifier . fillParentMaxSize (
fraction: @ FloatRange (from = 0.0, to = 1.0) Float
)

Пусть содержимое заполняет Constraints.maxWidth и Constraints.maxHeight родительских ограничений измерения, установив minimum width равную maximum width умноженной на fraction , а minimum height , равную maximum height умноженной на fraction .

Область: LazyItemScope
Modifier . fillParentMaxWidth (
fraction: @ FloatRange (from = 0.0, to = 1.0) Float
)

Пусть содержимое заполнит Constraints.maxWidth родительских ограничений измерения, установив minimum width , равную maximum width умноженной на fraction .

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
)

Включите жесты трансформации измененного элемента пользовательского интерфейса.

Область применения: Любая
@ ExperimentalFoundationApi
Modifier . transformable (
state: TransformableState ,
canPan: ( Offset ) -> Boolean ,
lockRotationOnZoomPan: Boolean ,
enabled: Boolean
)

Включите жесты трансформации измененного элемента пользовательского интерфейса.

Другой

Область применения: Любая

Модификатор, который позволяет рассматривать элемент, к которому он применяется, как источник для операций перетаскивания.

Область применения: Любая
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 , предоставленных другими модификаторами слева от этого модификатора или над этим модификатором в дереве макета.

Область применения: Любая

Модификатор, который можно использовать для предоставления ModifierLocal , которые могут быть прочитаны другими модификаторами справа от этого модификатора, или модификаторами, которые являются дочерними элементами узла макета, к которому прикреплен этот модификатор.

Область применения: Любая
Modifier . onPlaced (onPlaced: ( LayoutCoordinates ) -> Unit )

Вызовите onPlaced после размещения родительского LayoutModifier и родительского макета и до размещения дочернего LayoutModifier .

Область применения: Любая

Рисует фигуру-заполнитель поверх составного объекта и анимирует эффект вытеснения для удаления заполнителя.

Область применения: Любая

Модификатор для рисования мерцающего заполнителя над компонентом.

Область применения: Любая

Вызывает watcher с каждым MotionEvent , которое получает область макета или любой дочерний pointerInput .

Область применения: Любая

Отметьте прямоугольник макета так, чтобы он предпочитал избегать плавающих окон.

Область применения: Любая
Modifier . preferKeepClear (rectProvider: ( LayoutCoordinates ) -> Rect )

Отметьте прямоугольник в локальных координатах макета, предпочитая избегать плавающих окон.

Область применения: Любая

Модификатор для перевода позиции и масштабирования размера индикатора обновления при извлечении на основе заданного 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
)

Вызовы block с использованием WindowInsets , либо с помощью consumeWindowInsets , либо с помощью одного из модификаторов заполнения, например imePadding .

Область: TooltipBoxScope

Желателен Modifier , который следует применять к составной привязке при отображении всплывающей подсказки после длительного нажатия на составную привязку.

Эта функция устарела. Используйте перегрузку, которая принимает MenuAnchorType и включенные параметры.

abstract
Modifier . menuAnchor (type: MenuAnchorType , enabled: Boolean )

Модификатор, который следует применить к элементу внутри ExposedDropdownMenuBoxScope , обычно к текстовому полю или значку внутри текстового поля.