Compose 修饰符列表

操作

在一组预定义值之间启用拖动手势。

作用域:任意

在一组预定义值之间启用拖动手势。

作用域:任意

将组件配置为通过输入或无障碍“点击”事件接收点击操作。

作用域:Any

将组件配置为通过输入或无障碍“点击”事件接收点击操作。

作用域:Any

将组件配置为通过输入或无障碍“点击”事件接收点击、双击和长按操作。

作用域:Any

将组件配置为通过输入或无障碍“点击”事件接收点击、双击和长按操作。

作用域:任意

为界面元素配置在两种屏幕方向下的轻触拖动。

作用域:任意

为界面元素配置单个 Orientation 的触摸拖动。

作用域:Any

使用此修饰符将用于实现无障碍功能的一系列 selectable 项(例如 Tab 或 RadioButton)归到一组。

作用域:Any

将组件配置为可选择,通常作为互斥组的一部分,在任何时间点只能选择该组中的一项。

作用域:Any

将组件配置为可选择,通常作为互斥组的一部分,在任何时间点只能选择该组中的一项。

作用域:任意

将组件配置为可通过输入和无障碍事件切换

作用域:Any

将组件配置为可通过输入和无障碍事件切换。

作用域:Any

将组件配置为可通过输入和无障碍事件在三种状态之间切换:启用、停用和不确定。

作用域:Any

将组件配置为可通过输入和无障碍事件在三种状态之间切换:启用、停用和不确定。

作用域:任意

应应用于拖动手柄可组合项的修饰符,以便拖动手柄可以拖动并正确操作提供的 PaneExpansionState。

对齐方式

在 Row 中垂直对齐元素。

范围:RowScope

垂直放置元素,使由 alignmentLineBlock 确定的内容的对齐线与同样配置为 alignBy 的同级元素对齐。

范围:RowScope

垂直放置元素,使其 alignmentLine 与同样配置为 alignBy 的同级元素对齐。

范围:RowScope

垂直放置元素,使其第一条基线与同样配置为 alignByBaseline 或 alignBy 的同级元素对齐。

范围:RowScope

在 Column 中水平对齐元素。

范围:ColumnScope

水平放置元素,使由 alignmentLineBlock 确定的内容的对齐线与同样配置为 alignBy 的同级元素对齐。

范围:ColumnScope

水平放置元素,使其 alignmentLine 与同样配置为 alignBy 的同级元素对齐。

范围:ColumnScope

将内容元素拉取到 Box 中的特定 Alignment。

范围:BoxScope

动画

Modifier,用于为 LookaheadScope 内发生的布局更改(位置和/或大小)添加动画效果。

作用域:任意

将此修饰符应用于 FloatingActionButton,即可通过动画显示或隐藏它,通常基于应用的主要内容滚动。

作用域:任意

animateEnterExit 修饰符可用于 AnimatedVisibility 的任何直接或间接子项,以创建与 AnimatedVisibility 中指定的内容不同的进入/退出动画。

open

此修饰符可为项目的出现(淡入)、消失(淡出)和位置变化(例如项目重新排序)添加动画效果。

范围:LazyItemScope
open

此修饰符可为项目出现(淡入)、消失(淡出)和位置变化(例如项目重新排序)添加动画效果。

此修饰符可为项目出现(淡入)、消失(淡出)和位置变化(例如项目重新排序)添加动画效果。

边框

修改元素,以添加使用 border 和 shape 指定了外观的边框,并进行裁剪。

作用域:Any

修改元素,以添加使用 width、brush 和 shape 指定了外观的边框,并进行裁剪。

作用域:Any

修改元素,以添加使用 width、color 和 shape 指定了外观的边框,并进行裁剪。

作用域:任意

绘图

使用可能小于 1 的修饰的 alpha 绘制内容。

作用域:Any

使用纯 color 在内容后方绘制 shape。

作用域:Any

使用 brush 在内容后方绘制 shape。

作用域:Any

将内容裁剪到 shape。

作用域:Any

将内容裁剪到此修饰符定义的图层的边界。

作用域:Any

绘制到修饰的内容后方的 Canvas 中。

作用域:Any

绘制到 DrawScope 中,只要绘制区域的大小不变或读取的任何状态对象未发生变化,便使内容在各绘制调用中始终保留。

作用域:Any

创建 DrawModifier,允许开发者在布局内容前后进行绘制。

作用域:Any

在发生互动时为此组件绘制视觉效果。

作用域:Any

使用 painter 绘制内容。

作用域:任意

在其余内容后面绘制一个投影,其几何图形由给定形状指定,阴影属性由 DropShadowScope 定义。

作用域:任意

在其余内容后面绘制一个投影,其几何图形由给定形状指定,阴影属性由 Shadow 定义。

作用域:任意

使用给定形状指定的几何图形和 InnerShadowScope 定义的阴影属性,在其余内容后面绘制内阴影。

作用域:任意

在其余内容的顶部绘制内阴影,其几何图形由给定形状指定,阴影属性由 Shadow 定义。

作用域:任意

创建一个用于绘制阴影的 graphicsLayer。

作用域:Any

添加内边距,以适应 safe drawing 边衬区。

作用域:Any

创建一个修饰符,用于控制同一布局父项的子项的绘制顺序。

作用域:任意

焦点

将此修饰符添加到组件,以观察焦点状态事件。

作用域:Any

将此修饰符添加到组件,以观察焦点状态事件。

作用域:任意

将此修饰符添加到组件,以使其可聚焦。

作用域:任意

此修饰符可让您指定可供修饰符链中更底层或子布局节点上的 focusTarget 访问的属性。

作用域:Any

将此修饰符添加到组件中,以请求更改焦点。

作用域:任意

此修饰符可用于保存并恢复对焦点小组的焦点状态。

作用域:任意

创建焦点小组或将此组件标记为焦点小组。

作用域:Any

将组件配置为可通过焦点系统或无障碍“焦点”事件聚焦。

作用域:任意

图形

键盘

将此 modifier 添加到组件的 modifier 参数中后,它可以在自己(或其某个子级)获得焦点时截获硬件按键事件。

作用域:Any

将此 modifier 添加到组件的 modifier 参数中后,它可以在自己(或其某个子级)获得焦点时截获硬件按键事件。

作用域:任意

布局

androidx.compose.ui.layout.layoutId 的替代方案,可让您使用 tag。

作用域:任意

使用 layoutId 标记元素,以在其父项中识别它。

作用域:Any

创建 LayoutModifier,以允许更改已封装元素的测量和布局方式。

作用域:Any

当内容的全局位置可能发生变化时,使用元素的 LayoutCoordinates 调用 onGloballyPositioned。

作用域:任意

其他

使用 contentType 设置自动填充提示。

作用域:任意

如果修改后的内容太宽,无法在可用空间中显示,则会应用动画跑马灯效果。

作用域:任意

绘制内容,并使用指定的半径模糊处理内容。

作用域:Any

绘制内容,并使用指定的半径模糊处理内容。

作用域:任意

可用于发送 bringIntoView 请求的修饰符。

作用域:任意

声明将针对所修饰的每个元素进行组合的 Modifier 的即时组合。

作用域:Any

声明将针对所修饰的每个元素进行组合的 Modifier 的即时组合。

作用域:Any

声明将针对所修饰的每个元素进行组合的 Modifier 的即时组合。

作用域:Any

声明将针对所修饰的每个元素进行组合的 Modifier 的即时组合。

作用域:Any

声明将针对所修饰的每个元素进行组合的 Modifier 的即时组合。

作用域:任意

Modifier,可让应用它的元素被视为拖放操作的来源。

作用域:任意

Modifier,可让应用它的元素被视为拖放操作的来源。

作用域:任意

一种允许接收拖放手势的修饰符。

作用域:任意

在 Composable 上设置请求的帧速率

作用域:任意

在 Composable 上设置请求的帧速率

作用域:任意

将某个元素配置为手写检测器,用于检测触控笔手写内容,并将识别出的文本的处理工作委托给另一个元素。

作用域:任意

将元素配置为手写笔手写处理程序,该处理程序可以处理由手写检测器上的手写笔手写触发的手写会话中的文本输入。

作用域:任意

将组件配置为可通过指针进入/退出事件悬停。

作用域:任意

一种修饰符,只要它在受支持的平台上属于组合的一部分,就会使设备屏幕保持开启状态。

作用域:任意

这会将修饰符的 RelativeLayoutBounds 映射到提供的 LayoutBoundsHolder 中。

作用域:任意

创建一个接近布局,旨在帮助逐步接近在预先测量传递中计算的目标布局。

作用域:任意

显示 Magnifier widget,以显示相对于当前布局节点而言在 sourceCenter 处内容的放大版。

作用域:Any

该修饰符可用于使用由布局树中的其他修饰符(位于此修饰符的左侧或上方)提供的 ModifierLocal。

作用域:Any

该修饰符可用于提供可被其他修饰符(位于该修饰符的右侧或者是该修饰符附加到的布局节点的子项)读取的 ModifierLocal。

作用域:任意

使用此布局节点相对于组合根坐标系的位置以及屏幕坐标和窗口坐标调用 callback。

作用域:任意

在放置父级 LayoutModifier 和父布局之后以及放置子级 LayoutModifier 之前,调用 onPlaced。

作用域:任意

注册一个回调,以监控节点是否位于窗口的视口内。

作用域:任意

一种修饰符,可让开发者定义当触控笔悬停在元素上时要显示的指针图标。

作用域:任意

使用布局区域或任何子级 pointerInput 接收的每个 MotionEvent 调用 watcher。

作用域:任意

将布局矩形标记为首选避开悬浮窗口。

作用域:任意

在局部布局坐标中标记一个矩形,使其尽量避开浮动窗口。

作用域:任意

一种修饰符,可向容器添加嵌套滚动,以支持下拉刷新手势。

作用域:任意

将当前节点和所有子节点配置为内容接收器。

作用域:任意

使内容适合 rulers。

作用域:任意

如果 rulers 中的某个 Ruler 的值在布局边界内,则系统会根据该 Ruler 和边缘调整内容大小。

作用域:任意

此修饰符提示可组合项会在屏幕上呈现敏感内容(即用户名、密码、信用卡等),并且在受支持的环境中进行屏幕共享时,应保护这些内容。

作用域:任意

将此 modifier 添加到组件的 modifier 参数中后,它可以在硬件按键事件发送到软件键盘之前截获这些事件。

作用域:任意

将此 modifier 添加到组件的 modifier 参数中后,它可以在硬件按键事件发送到软件键盘之前截获这些事件。

作用域:任意

此修饰符会创建一个区域,该区域由给定 Style 对象为该修饰符所附加到的组件设置样式。

作用域:任意

此修饰符会创建一个区域,该区域由给定 Style 对象为该修饰符所附加到的组件设置样式。

作用域:任意

从系统手势中排除布局矩形。

作用域:Any

从系统手势中排除局部布局坐标中的矩形。

作用域:任意

添加一个 builder,以便在此层次结构中显示文本上下文菜单时运行。

作用域:任意

添加一个 filter,以便在此层次结构中显示文本上下文菜单时运行。

作用域:任意

一个 Modifier,用于控制其所应用到的布局的可见性。

作用域:任意

使用尚未被类似于 windowInsetsPadding 的其他边衬区修饰符使用的边衬区,而无需添加任何内边距。

作用域:Any

将 paddingValues 用作边衬区,就像添加了内边距而不考虑边衬区。

作用域:Any

使用由 consumeWindowInsets 或其中一个内边距修饰符(如 imePadding)使用的 WindowInsets 调用 block。

作用域:任意

这会根据大小和位置重新计算 WindowInsets。

作用域:任意

在 SharedTransitionScope 的叠加层中呈现内容,默认情况下,共享内容(即共享元素和共享边界)会在此处呈现。

sharedBounds 是一个修饰符,用于为布局添加 SharedContentState.key 标记,以便在布局更改期间,进入和退出同一键的共享边界时,共享动画和持续变化的边界。

sharedElement 是一种修饰符,用于为布局添加 SharedContentState.key 标记,以便在布局更改期间,具有相同键的进入和退出共享元素共享动画和持续变化的边界。

sharedElementWithCallerManagedVisibility 是一种修饰符,用于为布局添加 SharedContentState.key 标记,以便在布局更改期间,进入和退出具有相同键的共享元素时,共享动画和持续变化的边界。

一种修饰符,用于在共享元素过渡期间将布局锚定在从预先测量传递中获取的目标位置。

open

应应用于 ExposedDropdownMenuBoxScope 内元素的修饰符,通常是文本字段或文本字段内的图标。

abstract

此修饰符根据提供的 RectRulers 作为边衬区来指定关联窗格的外边距。

此修饰符会根据指定的固定外边距和提供的 RectRulers(作为边衬区,如有)指定关联窗格的外边距。

内边距

此 Modifier 可添加内边距,以根据从内容边界到 alignment line 的指定距离放置内容。

作用域:Any

此 Modifier 可添加内边距,以根据从内容边界到 alignment line 的指定距离放置内容。

作用域:Any

此 Modifier 用于在布局中放置内容,使从布局顶部到 baseline of the first line of text in the content 的距离为 top,且从 baseline of the last line of text in the content 到布局底部的距离为 bottom。

作用域:Any

此 Modifier 用于在布局中放置内容,使从布局顶部到 baseline of the first line of text in the content 的距离为 top,且从 baseline of the last line of text in the content 到布局底部的距离为 bottom。

作用域:Any

沿着内容的每个边缘应用 Dp 的额外空间:left、top、right 和 bottom。

作用域:任意

沿着内容的每个边缘(左侧、顶部、右侧和底部)应用 all dp 的额外空间。

作用域:Any

向组件应用 PaddingValues,将其作为沿内容左侧、顶部、右侧和底部的额外空间。

作用域:任意

沿着内容的左侧和右侧边缘应用 horizontal dp 空间,并沿着顶部和底部边缘应用 vertical dp 空间。

作用域:任意

沿着内容的每个边缘应用 Dp 的额外空间:start、top、end 和 bottom。

作用域:任意

添加内边距,以适应 caption bar 边衬区。

作用域:Any

添加内边距,以适应 display cutout。

作用域:Any

添加内边距,以适应 ime 边衬区。

作用域:Any

添加内边距,以适应 mandatory system gestures 边衬区。

作用域:Any

添加内边距,以适应 navigation bars 边衬区。

作用域:Any

添加内边距,以适应 safe content 边衬区。

作用域:Any

添加内边距,以适应 safe gestures 边衬区。

作用域:Any

添加内边距,以适应 status bars 边衬区。

作用域:Any

添加内边距,以适应 system bars 边衬区。

作用域:Any

添加内边距,以适应 system gestures 边衬区。

作用域:Any

添加内边距,以适应 waterfall 边衬区。

作用域:Any

添加内边距,使内容不会进入 insets 空间。

作用域:任意

指针

一个 Modifier,用于检测来自 IndirectPointerEvent 来源的高级点击和水平滑动。

作用域:任意

此修饰符可让开发者定义当光标悬停在元素上时要显示的指针图标。

作用域:任意

一个特殊的 PointerInputModifier,可提供对最初分派到 Compose 的底层 MotionEvent 的访问权限。

作用域:任意

创建一个用于在修饰的元素区域内处理指针输入的修饰符。

作用域:Any

创建一个用于在修饰的元素区域内处理指针输入的修饰符。

作用域:Any

创建一个用于在修饰的元素区域内处理指针输入的修饰符。

作用域:任意

位置

将内容偏移 offset 像素。

作用域:Any

将内容偏移(x dp,y dp)。

作用域:Any

将内容偏移 offset 像素。

作用域:Any

将内容偏移(x dp,y dp)。

作用域:任意

滚动

裁剪可滚动容器在主轴上的边界,同时在交叉轴上为背景效果(例如阴影)留出空间。

作用域:Any

修改元素,以使其参与嵌套滚动层次结构。

作用域:任意

根据提供的 overscrollEffect 呈现滚动回弹。

作用域:任意

将此 modifier 添加到组件的 modifier 参数中后,它可以在自己(或其某个子级)获得焦点时截获 RotaryScrollEvent。

作用域:Any

将此 modifier 添加到组件的 modifier 参数中后,它可以在自己(或其某个子级)获得焦点时截获 RotaryScrollEvent。

作用域:Any

修改元素,以支持在内容的宽度大于允许的最大约束时水平滚动。

作用域:任意

修改元素,以支持在内容的宽度大于允许的最大约束时水平滚动。

作用域:Any

修改元素,以支持在内容的高度大于允许的最大约束值时垂直滚动。

作用域:任意

修改元素,以支持在内容的高度大于允许的最大约束值时垂直滚动。

作用域:任意

为界面元素配置在 X 和 Y 两个方向上的轻触滚动和快速滑动。

作用域:任意

将组件配置为可滚动区域。

作用域:任意

将组件配置为可滚动区域。

作用域:任意

在单个 Orientation 为界面元素配置触摸滚动和快速滑动。

作用域:Any

在单个 Orientation 为界面元素配置触摸滚动和快速滑动。

作用域:任意

一个仅用于视觉呈现的滚动条,表示滚动组件的当前滚动位置。

作用域:任意

在 Android R 及更高版本上将软键盘控制为嵌套滚动。

作用域:任意

语义

包含不确定性进度指示器所需的 semantics,它表示操作正在进行中。

作用域:任意

包含确定性进度指示器或滑块的进度部分所需的 semantics,它表示 valueRange 内的进度。

作用域:任意

清除所有后代节点的语义并设置新语义。

作用域:Any

将语义键值对添加到布局节点,以便用于测试、无障碍功能等。

作用域:任意

尺寸

此修饰符会在其子修饰符(或子可组合项,如果它已位于链尾)更改尺寸时为其自己的尺寸添加动画效果。

作用域:任意

此修饰符会在其子修饰符(或子可组合项,如果它已位于链尾)更改尺寸时为其自己的尺寸添加动画效果。

作用域:Any

通过尝试按照以下顺序匹配传入的某个约束条件来尝试调整内容尺寸,使其符合指定的宽高比:如果 matchHeightConstraintsFirst 为 false(默认值),则顺序为 Constraints.maxWidth、Constraints.maxHeight、Constraints.minWidth、Constraints.minHeight;如果 matchHeightConstraintsFirst 为 true,则顺序为 Constraints.maxHeight、Constraints.maxWidth、Constraints.minHeight、Constraints.minWidth。

作用域:任意

预留至少 48dp 的大小,以便在元素尺寸较小时消除触摸交互的歧义。

作用域:任意

将内容的首选高度声明为与内容的最小或最大固有高度相同。

作用域:Any

将内容的高度声明为与内容的最小或最大固有高度完全相同。

作用域:Any

将内容的宽度声明为与内容的最小或最大固有宽度完全相同。

作用域:Any

将内容的首选宽度声明为与内容的最小或最大固有宽度相同。

作用域:Any

首次测量元素时或元素的大小发生变化时,通过修改后的 Compose 界面元素的大小进行调用。

作用域:Any

仅在封装的布局不受约束时约束其尺寸:minWidth 和 minHeight 约束仅在传入的相应约束为 0 时应用。

作用域:Any

让内容填充(可能仅部分填充)传入的测量约束的 Constraints.maxHeight,方法是将 minimum height 和 maximum height 设置为等于 fraction 乘以 maximum height 得出的值。

作用域:Any

通过将 minimum width 和 maximum width 设置为等于 maximum width 乘以 fraction,以及将 minimum height 和 maximum height 设置为等于 maximum height 乘以 fraction,使内容填充传入测量约束条件的 Constraints.maxWidth 和 Constraints.maxHeight(可能仅部分填充)。

作用域:Any

让内容填充(可能仅部分填充)传入的测量约束的 Constraints.maxWidth,方法是将 minimum width 和 maximum width 设置为等于 fraction 乘以 maximum width 得出的值。

作用域:Any

将内容的首选高度声明为正好 heightdp。

作用域:Any

如果传入的测量 Constraints 允许,将内容的高度限制在 mindp 与 maxdp 之间。

作用域:Any

将内容的高度声明为正好 heightdp。

作用域:Any

将内容的高度限制在 mindp 与 maxdp 之间。

作用域:Any

将内容的尺寸声明为宽度和高度正好是 sizedp。

作用域:任意

将内容的尺寸声明为正好 size。

作用域:任意

将内容的尺寸声明为正好是 widthdp 和 heightdp。

作用域:任意

将内容的宽度限制在 minWidthdp 与 maxWidthdp 之间,并将内容的高度限制在 minHeightdp 与 maxHeightdp 之间。

作用域:Any

将内容的宽度声明为正好 widthdp。

作用域:Any

将内容的宽度限制在 mindp 与 maxdp 之间。

作用域:Any

将内容的首选尺寸声明为正好是 sizedp 的方形。

作用域:任意

将内容的首选尺寸声明为正好 size。

作用域:任意

将内容的首选尺寸声明为正好是 widthdp x heightdp。

作用域:任意

如果传入的测量 Constraints 允许,将内容的宽度限制在 minWidthdp 与 maxWidthdp 之间,并将内容的高度限制在 minHeightdp 与 maxHeightdp 之间。

作用域:Any

将内容的首选宽度声明为正好 widthdp。

作用域:Any

如果传入的测量 Constraints 允许,将内容的宽度限制在 mindp 与 maxdp 之间。

作用域:Any

允许在不考虑传入的测量 minimum height constraint 的情况下将内容测量为所需高度;如果 unbounded 为 true,则也可不考虑传入的测量 maximum height constraint。

作用域:Any

允许在不考虑传入的测量 minimum width 或 minimum height 约束的情况下将内容测量为所需大小;如果 unbounded 为 true,则也可不考虑传入的最大约束。

作用域:Any

允许在不考虑传入的测量 minimum width constraint 的情况下以所需宽度测量内容;如果 unbounded 为 true,则也可不考虑传入的测量 maximum width constraint。

作用域:Any

将高度设置为屏幕 bottom 处 insets 的高度。

作用域:Any

根据 LayoutDirection,使用 left 或 right 将宽度设置为屏幕 end 处 insets 的宽度。

作用域:Any

根据 LayoutDirection,使用 left 或 right 将宽度设置为屏幕 start 处 insets 的宽度。

作用域:Any

将高度设置为屏幕 top 处 insets 的高度。

作用域:任意

尝试通过应用指定的 ContentScale 类型,调整原始内容矩形的大小,使其内切于目标。

作用域:任意

skipToLookaheadSize 使布局能够使用 Lookahead 约束条件测量其子级,从而像过渡已完成一样布置子级。

根据元素相对于 Row 中其他加权同级元素的 weight,按比例调整元素的宽度。

范围:RowScope

根据元素相对于 Column 中其他加权同级元素的 weight,按比例调整元素的高度。

范围:ColumnScope

让该项在 FlowRow 内填充其所在行中最高项的最大高度(可能只是部分填充)。

范围:FlowRowScope

让该项在 FlowColumn 内填充其所在列中最宽项的最大宽度(可能只是部分填充)。

在测量完所有其他内容元素后,调整元素的尺寸,使其与 Box 的尺寸一致。

范围:BoxScope

让内容填充传入的测量约束的 Constraints.maxHeight,方法是将 minimum height 设置为等于 maximum height 乘以 fraction 得出的值。

范围:LazyItemScope

让内容填充父级测量约束的 Constraints.maxWidth 和 Constraints.maxHeight,方法是将 minimum width 设置为等于 maximum width 乘以 fraction 得出的值,并将 minimum height 设置为等于 maximum height 乘以 fraction 得出的值。

范围:LazyItemScope

让内容填充父级测量约束的 Constraints.maxWidth,方法是将 minimum width 设置为等于 maximum width 乘以 fraction 得出的值。

范围:LazyItemScope

应应用于放置在 ExposedDropdownMenuBoxScope 内的菜单的修饰符。

abstract

此修饰符以 Dp 为单位指定窗格的首选高度,当关联的窗格呈现为重排或悬浮窗格时,窗格 Scaffold 实现会尽力遵循此高度。

此修饰符将窗格的首选高度指定为整个 Scaffold 高度的比例。

此修饰符将窗格的首选宽度指定为整个 Scaffold 宽度的比例。

此修饰符以 Dp 为单位指定窗格的首选宽度,当关联的窗格呈现为固定窗格(即不会拉伸以填充剩余空间的窗格)时,窗格 Scaffold 实现会尽力遵循此宽度。

测试

应用标记以允许在测试中找到修饰的元素。

作用域:任意

变换

设置视图围绕可组合项中心旋转的角度。

作用域:任意

按相同的缩放比例沿水平轴和垂直轴均匀缩放内容。

作用域:任意

分别按以下缩放比例沿水平轴和垂直轴缩放可组合项的内容。

作用域:任意

启用修饰的界面元素的变换手势。

作用域:任意

启用修饰的界面元素的变换手势。

作用域:任意