Button.Builder

Builder(context: Context, clickable: ModifiersBuilders.Clickable)

Creates a builder for the Button from the given content. Custom content should be later set with one of the following setIconContent, setIconContent, setTextContent, setTextContent or setImageContent.

fun build(): Button

Constructs and returns Button with the provided field and look.

fun setButtonColors(buttonColors: ButtonColors): Button.Builder

Sets the colors for the Button. If not set, PRIMARY_COLORS will be used.

Note: The content color will be ignored (and won't be returned by the getter) if the Button content is an image.

fun setContentDescription(contentDescription: CharSequence): Button.Builder

Sets the static content description for the Button. It is highly recommended to provide this for button containing icon or image.

fun setContentDescription(contentDescription: TypeBuilders.StringProp): Button.Builder

Sets the content description for the Button. It is highly recommended to provide this for button containing icon or image.

While this field is statically accessible from 1.0, it's only bindable since version 1.2 and renderers supporting version 1.2 will use the dynamic value (if set).

fun setCustomContent(content: LayoutElementBuilders.LayoutElement): Button.Builder

Sets the custom content for this Button. Any previously added content will be overridden.

fun setIconContent(imageResourceId: String): Button.Builder

Sets the content of this Button to be the given icon with the default size that is half of the set size of the button. Any previously added content will be overridden. Provided icon will be tinted to the given content color from ButtonColors. This icon should be image with chosen alpha channel and not an actual image.

fun setIconContent(imageResourceId: String, size: DimensionBuilders.DpProp): Button.Builder

Sets the content of this Button to be the given icon with the given size. Any previously added content will be overridden. Provided icon will be tinted to the given content color from ButtonColors and with the given size. This icon should be image with chosen alpha channel and not an actual image.

fun setImageContent(imageResourceId: String): Button.Builder

Sets the content of this Button to be the given image, i.e. contacts photo. Any previously added content will be overridden.

fun setSize(size: DimensionBuilders.DpProp): Button.Builder

Sets the size for the Button. Strongly recommended values are DEFAULT_SIZE, LARGE_SIZE and EXTRA_LARGE_SIZE. If not set, DEFAULT_SIZE will be used.

fun setSize(size: @Dimension(unit = 0) Float): Button.Builder

Sets the size for the Button. Strongly recommended values are DEFAULT_SIZE, LARGE_SIZE and EXTRA_LARGE_SIZE. If not set, DEFAULT_SIZE will be used.

fun setTextContent(text: String): Button.Builder

Sets the content of this Button to be the given text with the default font for the set size (for the DEFAULT_SIZE, LARGE_SIZE and EXTRA_LARGE_SIZE is TYPOGRAPHY_TITLE2, TYPOGRAPHY_TITLE1 and TYPOGRAPHY_DISPLAY3 respectively). Any previously added content will be overridden. Text should contain no more than 3 characters, otherwise it will overflow from the edges.

fun setTextContent(text: String, typographyName: Int): Button.Builder

Sets the content of this Button to be the given text with the given font. If you need more font related customization, consider using setCustomContent with Text component. Any previously added content will be overridden. Text should contain no more than 3 characters, otherwise it will overflow from the edges.