Bullet

Cmn

class Bullet : AnnotatedString.Annotation

Draws a bullet point next to a paragraph.

Bullets do not add indentation. The call site must provide sufficient leading space to accommodate the bullet and its padding, preventing overlap with the text.

There are several ways to achieve this leading space. One common approach is to use ParagraphStyle with textIndent within an AnnotatedString.

import androidx.compose.foundation.text.BasicText
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.RectangleShape
import androidx.compose.ui.graphics.SolidColor
import androidx.compose.ui.graphics.drawscope.Stroke
import androidx.compose.ui.text.AnnotatedString
import androidx.compose.ui.text.Bullet
import androidx.compose.ui.text.buildAnnotatedString

val bullet1 = Bullet.Default.copy(shape = RectangleShape)
val bullet2 = bullet1.copy(drawStyle = Stroke(2f))
val bullet3 = bullet1.copy(brush = SolidColor(Color.LightGray))
BasicText(
    buildAnnotatedString {
        withBulletList(bullet = bullet1) {
            withBulletListItem { append("Item 1") }
            withBulletList(bullet = bullet2) {
                withBulletListItem { append("Item 2") }
                withBulletListItem { append("Item 3") }
                withBulletList(bullet = bullet3) { withBulletListItem { append("Item 4") } }
            }
            withBulletListItem { append("Item 5") }
        }
    }
)

Summary

Public companion properties
`Bullet`	`Default` Default bullet used in AnnotatedString's bullet list	Cmn
`TextUnit`	`DefaultIndentation` Indentation required to fit `Default` bullet.	Cmn
`TextUnit`	`DefaultPadding` Padding between bullet and start of paragraph for `Default` bullet	Cmn
`TextUnit`	`DefaultSize` Height and width for `Default` bullet.	Cmn

Public constructors
`Bullet( shape: Shape, width: TextUnit, height: TextUnit, padding: TextUnit, brush: Brush?, alpha: Float, drawStyle: DrawStyle )`	Cmn

Public functions
`Bullet`	`copy( shape: Shape, width: TextUnit, height: TextUnit, padding: TextUnit, brush: Brush?, alpha: Float, drawStyle: DrawStyle )` Copies the existing `Bullet` replacing some of the fields as desired.	Cmn
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`open String`	`toString()`	Cmn

Public properties
`Float`	`alpha` opacity to be applied to `brush` drawing a bullet from 0.0f to 1.0f representing fully transparent to fully opaque respectively.	Cmn
`Brush?`	`brush` brush to draw a bullet with.	Cmn
`DrawStyle`	`drawStyle` defines the draw style of the bullet, e.g. a fill or a stroke	Cmn
`TextUnit`	`height` the height of the bullet	Cmn
`TextUnit`	`padding` the padding between the end of the bullet and the start of the paragraph	Cmn
`Shape`	`shape` the shape of the bullet to draw	Cmn
`TextUnit`	`width` the width of the bullet	Cmn

Public companion properties

Default

Cmn

Added in 1.9.0-alpha01

val Default: Bullet

Default bullet used in AnnotatedString's bullet list

DefaultIndentation

Cmn

Added in 1.9.0-alpha01

val DefaultIndentation: TextUnit

Indentation required to fit Default bullet.

DefaultPadding

Cmn

Added in 1.9.0-alpha01

val DefaultPadding: TextUnit

Padding between bullet and start of paragraph for Default bullet

DefaultSize

Cmn

Added in 1.9.0-alpha01

val DefaultSize: TextUnit

Height and width for Default bullet.

Public constructors

Bullet

Cmn

Bullet(
    shape: Shape,
    width: TextUnit,
    height: TextUnit,
    padding: TextUnit,
    brush: Brush? = null,
    alpha: Float = Float.NaN,
    drawStyle: DrawStyle = Fill
)

Parameters
`shape: Shape`	the shape of the bullet to draw
`width: TextUnit`	the width of the bullet
`height: TextUnit`	the height of the bullet
`padding: TextUnit`	the padding between the end of the bullet and the start of the paragraph
`brush: Brush? = null`	brush to draw a bullet with. If `null` is passed, the bullet will be drawn like the rest of the text
`alpha: Float = Float.NaN`	opacity to be applied to `brush` drawing a bullet from 0.0f to 1.0f representing fully transparent to fully opaque respectively. When `Float.NaN` is passed, the alpha will not be changed and the one used for drawing rest of the text is used
`drawStyle: DrawStyle = Fill`	defines the draw style of the bullet, e.g. a fill or a stroke

Public functions

copy

Cmn

fun copy(
    shape: Shape = this.shape,
    width: TextUnit = this.width,
    height: TextUnit = this.height,
    padding: TextUnit = this.padding,
    brush: Brush? = this.brush,
    alpha: Float = this.alpha,
    drawStyle: DrawStyle = this.drawStyle
): Bullet

Copies the existing Bullet replacing some of the fields as desired.

equals

Cmn

open operator fun equals(other: Any?): Boolean

hashCode

Cmn

open fun hashCode(): Int

toString

Cmn

open fun toString(): String

Public properties

alpha

Cmn

Added in 1.9.0-alpha01

val alpha: Float

opacity to be applied to brush drawing a bullet from 0.0f to 1.0f representing fully transparent to fully opaque respectively. When Float.NaN is passed, the alpha will not be changed and the one used for drawing rest of the text is used