OudsBulletList

fun OudsBulletList(modifier: Modifier = Modifier, type: OudsBulletListType = OudsBulletListDefaults.Type, textStyle: OudsBulletListTextStyle = OudsBulletListDefaults.TextStyle, bold: Boolean = true, builder: OudsBulletListBuilder.() -> Unit)

Bullet list is a UI element that helps to view in related individual text items grouped together; items usually starting with a number or a bullet.

Bullet list is also known as “Unordered list” or “Ordered list” and is not an interactive element by default, although text items can support hypertext links.

Design

Guidelinesunified-design-system.orange.com
Version1.0.0

Parameters

modifier

Modifier applied to the list.

type

The visual type of the list (e.g., ordered, unordered, bare). See OudsBulletListType.

textStyle

The typography style for the list items. See OudsBulletListTextStyle.

bold

Whether the list item text should be bold. This can be overridden for sub-lists. Defaults to true.

builder

A lambda scope using the OudsBulletListBuilder to define the list items.

Samples

import androidx.compose.runtime.Composable
import androidx.compose.ui.tooling.preview.PreviewLightDark
import com.orange.ouds.core.component.OudsBulletList
import com.orange.ouds.core.component.OudsBulletListType
import com.orange.ouds.core.utilities.OudsPreview

fun main() { 
   //sampleStart 
   OudsBulletList {
    item(label = "Milk")
    item(label = "Vegetables", subListType = OudsBulletListType.Unordered(brandColor = true)) {
        item(label = "Tomatoes")
        item(label = "Salad", subListHasBoldText = false) {
            item(label = "Lettuce")
            item(label = "Arugula")
        }
    }
} 
   //sampleEnd
}
import androidx.compose.runtime.Composable
import androidx.compose.ui.tooling.preview.PreviewLightDark
import com.orange.ouds.core.component.OudsBulletList
import com.orange.ouds.core.component.OudsBulletListType
import com.orange.ouds.core.utilities.OudsPreview

fun main() { 
   //sampleStart 
   OudsBulletList(type = OudsBulletListType.Ordered()) {
    item(label = "Prepare the ingredients")
    item(label = "Cook the pasta") {
        item(label = "Boil water in a large pot")
        item(label = "Add salt and then the pasta", subListHasBoldText = false) {
            item(label = "Cook for 8-10 minutes")
            item(label = "Stir occasionally")
        }
    }
    item(label = "Drain the pasta and serve")
} 
   //sampleEnd
}
import androidx.compose.runtime.Composable
import androidx.compose.ui.tooling.preview.PreviewLightDark
import com.orange.ouds.core.component.OudsBulletList
import com.orange.ouds.core.component.OudsBulletListType
import com.orange.ouds.core.utilities.OudsPreview

fun main() { 
   //sampleStart 
   OudsBulletList(type = OudsBulletListType.Bare()) {
    item(label = "Event Planning")
    item(label = "Logistic Team", subListHasBoldText = false) {
        item(label = "Venue Booking")
        item(label = "Catering")
    }
    item(label = "Communication Team", subListHasBoldText = false) {
        item(label = "Invitations")
        item(label = "Social Media")
    }
} 
   //sampleEnd
}