compose/com.yourssu.handy.compose

Package-level declarations

Types

data class BottomNavItem(val icon: ImageVector, val label: String? = null)

BottomNavItem : 하단 네비게이션 바의 아이템을 정의하는 데이터 클래스 입니다.

sealed class CheckBoxSize

object DialogDefaults

DividerThickness

enum DividerThickness : Enum<DividerThickness>

Divider의 두께를 정의하는 enum class

enum DragValue : Enum<DragValue>

드래그 위치를 나타냅니다. Start는 초기 위치, End는 스낵바가 사라질 위치를 나타냅니다.

FloatingActionButtonColorState

class FloatingActionButtonColorState(val contentColor: Color = Color.Unspecified, val disabledContentColor: Color = Color.Unspecified, val bgColor: Color = Color.Transparent, val disabledBgColor: Color = Color.Transparent, val shadowColor: Color = Color.Transparent, val borderColor: Color = Color.Transparent, pressed: Boolean = false)

FloatingActionButtonDefaults

object FloatingActionButtonDefaults

FloatingActionButtonSize

enum FloatingActionButtonSize : Enum<FloatingActionButtonSize>

FloatingActionButtonSizeState

data class FloatingActionButtonSizeState(val containerSize: FloatingActionButtonSize = FloatingActionButtonSize.S)

FloatingActionButtonType

enum FloatingActionButtonType : Enum<FloatingActionButtonType>

object HandyTheme

enum IconSize : Enum<IconSize>

OpacityTransition

typealias OpacityTransition = @Composable (snackBar: @Composable () -> Unit) -> Unit

RadioButtonSize

sealed class RadioButtonSize

interface SnackBarData

SnackBarDefaults

object SnackBarDefaults

SnackBarHostState

class SnackBarHostState

enum SnackBarResult : Enum<SnackBarResult>

SnackBarTransitionItem

data class SnackBarTransitionItem(val snackBarData: SnackBarData?, val opacityTransition: OpacityTransition)

enum SnackBarType : Enum<SnackBarType>

enum SwitchSize : Enum<SwitchSize>

enum SwitchState : Enum<SwitchState>

object TabBarDefaults

class TabPosition

object TopBarDefaults

Properties

val LocalTextStyle: ProvidableCompositionLocal<HandyTextStyle>

Functions

CenterAlignedTopAppBar

fun CenterAlignedTopAppBar(title: String, navIcon: ImageVector, onNavIconClick: () -> Unit, modifier: Modifier = Modifier, actions: @Composable RowScope.() -> Unit? = null)

Center-Aligned Top App Bar

fun CheckBox(checked: Boolean, onCheckedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, sizeType: CheckBoxSize = CheckBoxSize.Medium, text: String = "", enabled: Boolean = true, contentColor: Color = HandyTheme.colors.checkBoxSelected)

선택, 비선택, 비활성화 상태를 나타낼 수 있는 CheckBox입니다.

fun Divider(thickness: Dp = 1.dp, color: Color = HandyTheme.colors.lineBasicLight)

기본 Divider로, 인디케이터 아래에 있는 탭의 하단에 수평으로 배치됩니다.

fun Divider(dividerThickness: DividerThickness, modifier: Modifier = Modifier, color: Color = HandyTheme.colors.bgBasicStrong)

width를 지정할 수 없는 Divider 기본적으로 fillMaxWidth를 사용

fun Divider(dividerThickness: DividerThickness, modifier: Modifier = Modifier, width: Dp = 0.dp, color: Color = HandyTheme.colors.bgBasicStrong)

width를 지정할 수 있는 Divider

fun ErrorSnackBar(text: String, onClose: () -> Unit, modifier: Modifier = Modifier)

에러 스낵바의 UI를 그린 함수입니다.

fun FadeInFadeOut(newSnackBarData: SnackBarData?, modifier: Modifier = Modifier, snackBar: @Composable (SnackBarData) -> Unit)

스낵바에 애니메이션을 적용합니다.

fun FixedTab(selectedTabIndex: Int, modifier: Modifier = Modifier, backgroundColor: Color = HandyTheme.colors.bgBasicDefault, contentColor: Color = HandyTheme.colors.textBasicPrimary, tabs: @Composable () -> Unit)

FixedTab에는 TabItem 행이 포함되어 있으며 현재 선택된 탭 아래에 인디케이터가 표시됩니다. FixedTab은 전체 행을 따라 균등한 간격으로 탭을 배치하며 각 탭은 동일한 공간을 차지합니다.

FloatingActionButton

fun FloatingActionButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = CircleShape, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, icon: ImageVector = HandyIcons.Line.ExternalLink, sizeType: FloatingActionButtonSize = FloatingActionButtonSize.S, floatingActionButtonType: FloatingActionButtonType = FloatingActionButtonType.Primary)

fun HandyTheme(isDarkMode: Boolean = isSystemInDarkTheme(), content: @Composable () -> Unit)

fun Icon(bitmap: ImageBitmap, modifier: Modifier = Modifier, tint: Color = LocalContentColor.current, iconSize: IconSize = IconSize.M, contentDescription: String? = null)

fun Icon(painter: Painter, modifier: Modifier = Modifier, tint: Color = LocalContentColor.current, iconSize: IconSize = IconSize.M, contentDescription: String? = null)

fun Icon(imageVector: ImageVector, modifier: Modifier = Modifier, tint: Color = LocalContentColor.current, iconSize: IconSize = IconSize.M, contentDescription: String? = null)

fun Indicator(modifier: Modifier = Modifier, height: Dp = 2.dp, color: Color = HandyTheme.colors.bgBasicBlack)

기본 Indicator로, 구분선 위에 있는 탭의 하단에 배치됩니다.

fun InfoSnackBar(text: String, onDismiss: () -> Unit, modifier: Modifier = Modifier)

정보성 스낵바의 UI를 그린 함수입니다.

LeftAlignedTopAppBar

fun LeftAlignedTopAppBar(title: String, actions: @Composable RowScope.() -> Unit? = null)

Left-aligned

fun Navigation(items: List<BottomNavItem>, selectedIndex: Int, onItemSelected: (Int) -> Unit, modifier: Modifier = Modifier)

Navigation : 하단 네비게이션 바 Composable 함수 입니다.

OneButtonDialog

fun OneButtonDialog(title: String, positiveText: String, onPositiveClick: () -> Unit, onDismiss: () -> Unit, modifier: Modifier = Modifier, description: String?, content: @Composable () -> Unit? = null)

OneButtonDialog : 선택 버튼이 하나 있는 Dialog 입니다.

fun RadioButton(checked: Boolean, onCheckedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, sizeType: RadioButtonSize = RadioButtonSize.Medium, text: String = "", enabled: Boolean = true, contentColor: Color = HandyTheme.colors.buttonRadioSelected)

단일 선택을 나타낼 수 있는 RadioButton입니다.

rememberSnackBarHostState

fun rememberSnackBarHostState(): SnackBarHostState

fun ScrollableTab(selectedTabIndex: Int, modifier: Modifier = Modifier, backgroundColor: Color = HandyTheme.colors.bgBasicDefault, contentColor: Color = HandyTheme.colors.textBasicPrimary, tabs: @Composable () -> Unit)

ScrollableTab에는 TabItem 행이 포함되어 있으며 현재 탭 아래에 인디케이터가 표시됩니다.

fun SnackBarHost(snackBarHostState: SnackBarHostState, modifier: Modifier = Modifier, snackBar: @Composable (SnackBarData) -> Unit = { snackBarData -> when (snackBarData.type) { SnackBarType.Info -> InfoSnackBar( text = snackBarHostState.currentSnackBarData?.message.orEmpty(), onDismiss = snackBarData::dismiss ) SnackBarType.Error -> ErrorSnackBar( text = snackBarHostState.currentSnackBarData?.message.orEmpty(), onClose = snackBarData::dismiss ) } })

SnackBar를 보여주기 위해선 SnackBarHost를 통해 상태를 관리해야 합니다. 스낵바의 타입에 따라 정보성 스낵바또는 에러 스낵바를 표시합니다.

fun Surface(modifier: Modifier = Modifier, rounding: Dp? = null, shape: Shape = rounding?.let { RoundedCornerShape(it) } ?: RectangleShape, backgroundColor: Color = HandyTheme.colors.bgBasicDefault, contentColor: Color = LocalContentColor.current, border: BorderStroke? = null, content: @Composable () -> Unit)

Surface : 어떠한 상호작용도 없는 기본적인 Surface 입니다. 비상호작용적인 UI 요소로 사용됩니다.

fun Surface(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, rounding: Dp? = null, shape: Shape = rounding?.let { RoundedCornerShape(it) } ?: RectangleShape, backgroundColor: Color = HandyTheme.colors.bgBasicDefault, contentColor: Color = LocalContentColor.current, border: BorderStroke? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource()}, indication: Indication? = null, content: @Composable () -> Unit)

Clickable Surface : 클릭 가능한 Surface 입니다.

fun Surface(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, rounding: Dp? = null, shape: Shape = rounding?.let { RoundedCornerShape(it) } ?: RectangleShape, backgroundColor: Color = HandyTheme.colors.bgBasicDefault, contentColor: Color = LocalContentColor.current, border: BorderStroke? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource()}, indication: Indication? = null, content: @Composable () -> Unit)

Selectable Surface : 선택이 가능한 Surface 입니다.

fun Surface(checked: Boolean, onCheckedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, rounding: Dp? = null, shape: Shape = rounding?.let { RoundedCornerShape(it) } ?: RectangleShape, backgroundColor: Color = HandyTheme.colors.bgBasicDefault, contentColor: Color = LocalContentColor.current, border: BorderStroke? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, indication: Indication? = null, content: @Composable () -> Unit)

Toggleable Surface : 토글 기능이 있는 Surface 입니다.

fun Surface(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, rounding: Dp? = null, shape: Shape = rounding?.let { RoundedCornerShape(it) } ?: RectangleShape, backgroundColor: Color = HandyTheme.colors.bgBasicDefault, contentColor: Color = LocalContentColor.current, border: BorderStroke? = null, shadowColor: Color = Color.Transparent, shadowElevation: Dp = 0.dp, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, indication: Indication? = null, content: @Composable () -> Unit)

fun Switch(onToggle: (SwitchState) -> Unit, modifier: Modifier = Modifier, switchState: SwitchState = SwitchState.Unselected, switchSize: SwitchSize = SwitchSize.Large)

Switch를 그리는 함수입니다.

tabIndicatorOffset

fun Modifier.tabIndicatorOffset(currentTabPosition: TabPosition, tabMargin: Dp): Modifier

인디케이터의 오프셋과 너비를 조정합니다. 각 탭의 양옆에 tabMargin만큼의 마진을 두고, 인디케이터가 해당 마진을 고려하여 조정됩니다. 인디케이터는 선택된 탭의 위치에 맞춰서 배치되며, 탭의 너비에서 양옆의 마진을 제외한 너비를 가집니다.

fun TabItem(selected: Boolean, onClick: () -> Unit, text: String, modifier: Modifier = Modifier, selectedContentColor: Color = HandyTheme.colors.textBasicPrimary, unselectedContentColor: Color = HandyTheme.colors.textBasicTertiary)

fun Text(text: String, modifier: Modifier = Modifier, color: Color = Color.Unspecified, fontSize: Dp = Dp.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textAlign: TextAlign = TextAlign.Unspecified, lineHeight: Dp = Dp.Unspecified, overflow: TextOverflow = TextOverflow.Clip, maxLines: Int = Int.MAX_VALUE, minLines: Int = 1, onTextLayout: (TextLayoutResult) -> Unit = {}, style: HandyTextStyle = LocalTextStyle.current)

TwoButtonDialog

fun TwoButtonDialog(title: String, positiveText: String, negativeText: String, onPositiveClick: () -> Unit, onNegativeClick: () -> Unit, onDismiss: () -> Unit, modifier: Modifier = Modifier, description: String?, content: @Composable () -> Unit? = null)

TwoButtonDialog : 버튼이 두개 있는 다이알로그 입니다.