ModifiersBuilders.Clickable.Builder

Builder()

Creates an instance of Builder.

Note that, builder created with this constructor can not be used to invoke setOnClick, otherwise an exception will be thrown. Instead, create the builder with Builder for setting a PendingIntent as onClick action.

@RequiresSchemaVersion(major = 1, minor = 600)
Builder(scope: ProtoLayoutScope, clickableId: String)

Creates an instance of Builder which is able to accept a PendingIntent as onClick action. Builder instance created with this constructor works with other type of actions as well.

Note that, calling #setId would override the clickable Id set here.

fun build(): ModifiersBuilders.Clickable

Builds an instance from accumulated values.

@RequiresSchemaVersion(major = 1, minor = 0)
fun setId(id: String): ModifiersBuilders.Clickable.Builder

Sets the ID associated with this action.

@RequiresSchemaVersion(major = 1, minor = 300)
fun setMinimumClickableHeight(
    minimumClickableHeight: DimensionBuilders.DpProp
): ModifiersBuilders.Clickable.Builder

Sets the minimum height of the clickable area.

The default value is 48dp, following the Material design accessibility guideline. Note that this value does not affect the layout, so the minimum clickable height is not guaranteed unless there is enough space around the element within its parent bounds.

Note that this field only supports static values.

@RequiresSchemaVersion(major = 1, minor = 300)
fun setMinimumClickableWidth(
    minimumClickableWidth: DimensionBuilders.DpProp
): ModifiersBuilders.Clickable.Builder

Sets the minimum width of the clickable area.

The default value is 48dp, following the Material design accessibility guideline. Note that this value does not affect the layout, so the minimum clickable width is not guaranteed unless there is enough space around the element within its parent bounds.

Note that this field only supports static values.

@RequiresSchemaVersion(major = 1, minor = 0)
fun setOnClick(onClick: ActionBuilders.Action): ModifiersBuilders.Clickable.Builder

Sets the action to perform when the element this modifier is attached to is clicked.

@RequiresSchemaVersion(major = 1, minor = 600)
fun setOnClick(pendingIntent: PendingIntent): ModifiersBuilders.Clickable.Builder

Sets the PendingIntent to perform when the element this modifier is attached to is clicked.

Note that this method is mutually exclusive with #setOnClick(Action), the later method call will override the previous one.

@RequiresSchemaVersion(major = 1, minor = 400)
fun setVisualFeedbackEnabled(visualFeedbackEnabled: Boolean): ModifiersBuilders.Clickable.Builder

Sets whether the click visual feedback (such as a ripple) should be enabled. Defaults to true.