ui/org.jetbrains.jewel.ui.component

Package-level declarations

Types

Link copied to clipboard
@Immutable
@JvmInline
value class ButtonState(val state: ULong) : FocusableComponentState
Link copied to clipboard
@Immutable
@JvmInline
value class CheckboxState(state: ULong) : ToggleableComponentState, FocusableComponentState
Link copied to clipboard
@Immutable
@JvmInline
value class ChipState(val state: ULong) : FocusableComponentState, SelectableComponentState
Link copied to clipboard
object ContextMenuDivider : ContextMenuItem
Link copied to clipboard
object ContextMenuRepresentation : ContextMenuRepresentation
Link copied to clipboard
class ContextSubmenu(label: String, val submenu: () -> List<ContextMenuItem>) : ContextMenuItem
Link copied to clipboard
@Immutable
@JvmInline
value class DropdownState(val state: ULong) : FocusableComponentState
Link copied to clipboard
@Immutable
@JvmInline
value class IconButtonState(val state: ULong) : FocusableComponentState, SelectableComponentState
Link copied to clipboard
@Immutable
@JvmInline
value class InputFieldState(val state: ULong) : FocusableComponentState
Link copied to clipboard
@Immutable
@JvmInline
value class LinkState(val state: ULong) : FocusableComponentState
Link copied to clipboard
@Immutable
@JvmInline
value class MenuItemState(val state: ULong) : SelectableComponentState, FocusableComponentState
Link copied to clipboard
class MenuManager(val onDismissRequest: (InputMode) -> Boolean, parentMenuManager: MenuManager? = null)
Link copied to clipboard
interface MenuScope
Link copied to clipboard
@Immutable
@JvmInline
value class RadioButtonState(val state: ULong) : SelectableComponentState, FocusableComponentState
Link copied to clipboard
@Immutable
@JvmInline
value class SliderState(val state: ULong) : FocusableComponentState
Link copied to clipboard
interface TabContentScope
Link copied to clipboard
@Immutable
sealed class TabData
Link copied to clipboard
@Immutable
@JvmInline
value class TabState(val state: ULong) : SelectableComponentState
Link copied to clipboard
@Immutable
@JvmInline
value class TabStripState(val state: ULong) : FocusableComponentState
Link copied to clipboard
class TooltipPlacement(contentOffset: DpOffset, alignment: Alignment.Horizontal, density: Density, windowMargin: Dp = 4.dp) : TooltipPlacement

Properties

Link copied to clipboard
val LocalMenuManager: ProvidableCompositionLocal<MenuManager>

Functions

Link copied to clipboard
@Composable
fun Checkbox(checked: Boolean, onCheckedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, colors: CheckboxColors = JewelTheme.checkboxStyle.colors, metrics: CheckboxMetrics = JewelTheme.checkboxStyle.metrics, icons: CheckboxIcons = JewelTheme.checkboxStyle.icons, textStyle: TextStyle = LocalTextStyle.current)
Link copied to clipboard
@Composable
fun CheckboxRow(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, colors: CheckboxColors = LocalCheckboxStyle.current.colors, metrics: CheckboxMetrics = LocalCheckboxStyle.current.metrics, icons: CheckboxIcons = LocalCheckboxStyle.current.icons, textStyle: TextStyle = LocalTextStyle.current, content: @Composable RowScope.() -> Unit)
@Composable
fun CheckboxRow(text: String, checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, colors: CheckboxColors = LocalCheckboxStyle.current.colors, metrics: CheckboxMetrics = LocalCheckboxStyle.current.metrics, icons: CheckboxIcons = LocalCheckboxStyle.current.icons, textStyle: TextStyle = LocalTextStyle.current)
Link copied to clipboard
@Composable
fun Chip(modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, enabled: Boolean = true, selected: Boolean = false, style: ChipStyle = JewelTheme.chipStyle, onClick: () -> Unit = {}, content: @Composable () -> Unit)
Link copied to clipboard
@Composable
fun CircularProgressIndicator(modifier: Modifier = Modifier, style: CircularProgressStyle = JewelTheme.circularProgressStyle)
Link copied to clipboard
@Composable
fun CircularProgressIndicatorBig(modifier: Modifier = Modifier, style: CircularProgressStyle = JewelTheme.circularProgressStyle)
Link copied to clipboard
@Composable
fun DefaultButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: ButtonStyle = JewelTheme.defaultButtonStyle, textStyle: TextStyle = JewelTheme.textStyle, content: @Composable RowScope.() -> Unit)
Link copied to clipboard
@Composable
fun Divider(orientation: Orientation, modifier: Modifier = Modifier, color: Color = Color.Unspecified, thickness: Dp = Dp.Unspecified, startIndent: Dp = Dp.Unspecified, style: DividerStyle = JewelTheme.dividerStyle)
Link copied to clipboard
@Composable
fun Dropdown(modifier: Modifier = Modifier, enabled: Boolean = true, menuModifier: Modifier = Modifier, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: DropdownStyle = JewelTheme.dropdownStyle, menuContent: MenuScope.() -> Unit, content: @Composable BoxScope.() -> Unit)
Link copied to clipboard
@Composable
fun DropdownLink(text: String, modifier: Modifier = Modifier, enabled: Boolean = true, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textAlign: TextAlign? = null, overflow: TextOverflow = TextOverflow.Clip, lineHeight: TextUnit = TextUnit.Unspecified, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: LinkStyle = LocalLinkStyle.current, menuModifier: Modifier = Modifier, menuStyle: MenuStyle = LocalMenuStyle.current, menuContent: MenuScope.() -> Unit)
Link copied to clipboard
@Composable
fun ExternalLink(text: String, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textAlign: TextAlign? = null, overflow: TextOverflow = TextOverflow.Clip, lineHeight: TextUnit = TextUnit.Unspecified, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: LinkStyle = LocalLinkStyle.current)
Link copied to clipboard
@Composable
fun GroupHeader(text: String, modifier: Modifier = Modifier, textColor: Color = Color.Unspecified, style: GroupHeaderStyle = LocalGroupHeaderStyle.current)
Link copied to clipboard
@Composable
fun HorizontalProgressBar(progress: Float, modifier: Modifier = Modifier, style: HorizontalProgressBarStyle = JewelTheme.horizontalProgressBarStyle)
Link copied to clipboard
@Composable
fun HorizontalScrollbar(adapter: ScrollbarAdapter, modifier: Modifier = Modifier, reverseLayout: Boolean = false, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: ScrollbarStyle = JewelTheme.scrollbarStyle)
Link copied to clipboard
@Composable
fun HorizontalSplitLayout(first: @Composable (Modifier) -> Unit, second: @Composable (Modifier) -> Unit, modifier: Modifier = Modifier, dividerColor: Color = JewelTheme.globalColors.borders.normal, dividerThickness: Dp = 1.dp, dividerIndent: Dp = 0.dp, draggableWidth: Dp = 8.dp, minRatio: Float = 0.0f, maxRatio: Float = 1.0f, initialDividerPosition: Dp = 300.dp)
Link copied to clipboard
@Composable
fun Icon(bitmap: ImageBitmap, contentDescription: String?, modifier: Modifier = Modifier, tint: Color = Color.Unspecified)

Icon component that draws bitmap using tint, defaulting to Color.Unspecified.

@Composable
fun Icon(painter: Painter, contentDescription: String?, modifier: Modifier = Modifier, tint: Color = Color.Unspecified)

Icon component that draws a painter using tint, defaulting to Color.Unspecified

@Composable
fun Icon(painter: Painter, contentDescription: String?, colorFilter: ColorFilter?, modifier: Modifier = Modifier)

Icon component that draws a painter using a colorFilter

@Composable
fun Icon(imageVector: ImageVector, contentDescription: String?, modifier: Modifier = Modifier, tint: Color = Color.Unspecified)

Icon component that draws imageVector using tint, defaulting to Color.Unspecified.

@Composable
fun Icon(resource: String, contentDescription: String?, iconClass: Class<*>, modifier: Modifier = Modifier, tint: Color = Color.Unspecified)
@Composable
fun Icon(resource: String, contentDescription: String?, iconClass: Class<*>, colorFilter: ColorFilter?, modifier: Modifier = Modifier)
Link copied to clipboard
@Composable
fun IconButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, style: IconButtonStyle = JewelTheme.iconButtonStyle, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable BoxScope.(IconButtonState) -> Unit)
Link copied to clipboard
@Composable
fun IndeterminateHorizontalProgressBar(modifier: Modifier = Modifier, style: HorizontalProgressBarStyle = JewelTheme.horizontalProgressBarStyle)
Link copied to clipboard
fun MenuScope.items(count: Int, isSelected: (Int) -> Boolean, onItemClick: (Int) -> Unit, content: @Composable (Int) -> Unit)
fun <T> MenuScope.items(items: List<T>, isSelected: (T) -> Boolean, onItemClick: (T) -> Unit, content: @Composable (T) -> Unit)
Link copied to clipboard
@Composable
fun <T> LazyTree(tree: Tree<T>, modifier: Modifier = Modifier, onElementClick: (Tree.Element<T>) -> Unit = {}, treeState: TreeState = rememberTreeState(), onElementDoubleClick: (Tree.Element<T>) -> Unit = {}, onSelectionChange: (List<Tree.Element<T>>) -> Unit = {}, keyActions: KeyActions = DefaultTreeViewKeyActions(treeState), style: LazyTreeStyle = JewelTheme.treeStyle, nodeContent: @Composable SelectableLazyItemScope.(Tree.Element<T>) -> Unit)
Link copied to clipboard
@Composable
fun Link(text: String, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textAlign: TextAlign? = null, overflow: TextOverflow = TextOverflow.Clip, lineHeight: TextUnit = TextUnit.Unspecified, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: LinkStyle = LocalLinkStyle.current)
Link copied to clipboard
@Composable
fun MenuSeparator(modifier: Modifier = Modifier, metrics: MenuItemMetrics = JewelTheme.menuStyle.metrics.itemMetrics, colors: MenuItemColors = JewelTheme.menuStyle.colors.itemColors)
Link copied to clipboard
@Composable
fun MenuSubmenuItem(modifier: Modifier = Modifier, enabled: Boolean = true, canShowIcon: Boolean, iconResource: String?, iconClass: Class<*>, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: MenuStyle = JewelTheme.menuStyle, submenu: MenuScope.() -> Unit, content: @Composable () -> Unit)
Link copied to clipboard
@Composable
fun OutlinedButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: ButtonStyle = JewelTheme.outlinedButtonStyle, textStyle: TextStyle = JewelTheme.textStyle, content: @Composable RowScope.() -> Unit)
Link copied to clipboard
@Composable
fun painterResource(resourcePath: String, loader: ResourceLoader): Painter
Link copied to clipboard
@Composable
fun PopupMenu(onDismissRequest: (InputMode) -> Boolean, horizontalAlignment: Alignment.Horizontal, modifier: Modifier = Modifier, style: MenuStyle = JewelTheme.menuStyle, content: MenuScope.() -> Unit)
Link copied to clipboard
@Composable
fun RadioButton(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: RadioButtonStyle = JewelTheme.radioButtonStyle, textStyle: TextStyle = JewelTheme.textStyle)
Link copied to clipboard
@Composable
fun RadioButtonChip(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, enabled: Boolean = true, style: ChipStyle = JewelTheme.chipStyle, content: @Composable () -> Unit)
Link copied to clipboard
@Composable
fun RadioButtonRow(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: RadioButtonStyle = JewelTheme.radioButtonStyle, textStyle: TextStyle = JewelTheme.textStyle, content: @Composable RowScope.() -> Unit)
@Composable
fun RadioButtonRow(text: String, selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: RadioButtonStyle = JewelTheme.radioButtonStyle, textStyle: TextStyle = JewelTheme.textStyle)
Link copied to clipboard
@Composable
fun SelectableIconButton(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, style: IconButtonStyle = JewelTheme.iconButtonStyle, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable BoxScope.(IconButtonState) -> Unit)
Link copied to clipboard
Link copied to clipboard
@Composable
fun TabContentScope.SimpleTabContent(label: String, state: TabState, modifier: Modifier = Modifier, icon: Painter? = null)
@Composable
fun TabContentScope.SimpleTabContent(state: TabState, modifier: Modifier = Modifier, icon: @Composable () -> Unit? = null, label: @Composable () -> Unit)
Link copied to clipboard
@Composable
fun Slider(value: Float, onValueChange: (Float) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, valueRange: ClosedFloatingPointRange<Float> = 0f..1f, steps: Int = 0, onValueChangeFinished: () -> Unit? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: SliderStyle = JewelTheme.sliderStyle)
Link copied to clipboard
@Composable
fun TabStrip(tabs: List<TabData>, modifier: Modifier = Modifier, enabled: Boolean = true)
Link copied to clipboard
@Composable
fun TabStripHorizontalScrollbar(adapter: ScrollbarAdapter, modifier: Modifier = Modifier, reverseLayout: Boolean = false, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: ScrollbarStyle = JewelTheme.scrollbarStyle)
Link copied to clipboard
@Composable
fun Text(text: String, modifier: Modifier = Modifier, color: Color = Color.Unspecified, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign? = null, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = JewelTheme.textStyle)
@Composable
fun Text(text: AnnotatedString, modifier: Modifier = Modifier, color: Color = Color.Unspecified, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign? = null, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, inlineContent: Map<String, InlineTextContent> = emptyMap(), onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = JewelTheme.textStyle)
Link copied to clipboard
@Composable
fun TextArea(value: TextFieldValue, onValueChange: (TextFieldValue) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, placeholder: @Composable () -> Unit? = null, undecorated: Boolean = false, outline: Outline = Outline.None, visualTransformation: VisualTransformation = VisualTransformation.None, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions(), maxLines: Int = Int.MAX_VALUE, onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextAreaStyle = JewelTheme.textAreaStyle, textStyle: TextStyle = JewelTheme.textStyle, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })
@Composable
fun TextArea(value: String, onValueChange: (String) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, outline: Outline = Outline.None, placeholder: @Composable () -> Unit? = null, undecorated: Boolean = false, visualTransformation: VisualTransformation = VisualTransformation.None, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions(), maxLines: Int = Int.MAX_VALUE, onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextAreaStyle = JewelTheme.textAreaStyle, textStyle: TextStyle = JewelTheme.textStyle, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })
Link copied to clipboard
@Composable
fun TextField(value: String, onValueChange: (String) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, outline: Outline = Outline.None, placeholder: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, undecorated: Boolean = false, visualTransformation: VisualTransformation = VisualTransformation.None, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions(), onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextFieldStyle = JewelTheme.textFieldStyle, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })
@Composable
fun TextField(value: TextFieldValue, onValueChange: (TextFieldValue) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, outline: Outline = Outline.None, placeholder: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, undecorated: Boolean = false, visualTransformation: VisualTransformation = VisualTransformation.None, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions(), onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextFieldStyle = JewelTheme.textFieldStyle, textStyle: TextStyle = JewelTheme.textStyle, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })
Link copied to clipboard
@Composable
fun ToggleableChip(checked: Boolean, onClick: (Boolean) -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, enabled: Boolean = true, style: ChipStyle = JewelTheme.chipStyle, content: @Composable () -> Unit)
Link copied to clipboard
@Composable
fun Tooltip(tooltip: @Composable () -> Unit, modifier: Modifier = Modifier, style: TooltipStyle = JewelTheme.tooltipStyle, tooltipPlacement: TooltipPlacement = TooltipPlacement( contentOffset = style.metrics.tooltipOffset, alignment = style.metrics.tooltipAlignment, density = LocalDensity.current, ), content: @Composable () -> Unit)
Link copied to clipboard
@Composable
fun TriStateCheckbox(state: ToggleableState, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, colors: CheckboxColors = LocalCheckboxStyle.current.colors, metrics: CheckboxMetrics = LocalCheckboxStyle.current.metrics, icons: CheckboxIcons = LocalCheckboxStyle.current.icons, textStyle: TextStyle = LocalTextStyle.current)
Link copied to clipboard
@Composable
fun TriStateCheckboxRow(state: ToggleableState, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, colors: CheckboxColors = LocalCheckboxStyle.current.colors, metrics: CheckboxMetrics = LocalCheckboxStyle.current.metrics, icons: CheckboxIcons = LocalCheckboxStyle.current.icons, textStyle: TextStyle = LocalTextStyle.current, content: @Composable RowScope.() -> Unit)
@Composable
fun TriStateCheckboxRow(text: String, state: ToggleableState, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, outline: Outline = Outline.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, colors: CheckboxColors = LocalCheckboxStyle.current.colors, metrics: CheckboxMetrics = LocalCheckboxStyle.current.metrics, icons: CheckboxIcons = LocalCheckboxStyle.current.icons, textStyle: TextStyle = LocalTextStyle.current)
Link copied to clipboard
@Composable
fun VerticalScrollbar(adapter: ScrollbarAdapter, modifier: Modifier = Modifier, reverseLayout: Boolean = false, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, style: ScrollbarStyle = JewelTheme.scrollbarStyle)
Link copied to clipboard
@Composable
fun VerticalSplitLayout(first: @Composable (Modifier) -> Unit, second: @Composable (Modifier) -> Unit, modifier: Modifier = Modifier, dividerColor: Color = JewelTheme.globalColors.borders.normal, dividerThickness: Dp = 1.dp, dividerIndent: Dp = 0.dp, draggableWidth: Dp = 8.dp, minRatio: Float = 0.0f, maxRatio: Float = 1.0f, initialDividerPosition: Dp = 300.dp)