Skip to content

Commit

Permalink
[#267] Rename buttons composables to match with Jetpack compose SDK n…
Browse files Browse the repository at this point in the history
…aming
  • Loading branch information
paulinea committed Sep 12, 2022
1 parent ee62335 commit 0689d8c
Show file tree
Hide file tree
Showing 10 changed files with 75 additions and 75 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import androidx.compose.ui.Modifier
import androidx.compose.ui.res.dimensionResource
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.res.stringResource
import com.orange.ods.compose.component.button.OdsButtonOutlined
import com.orange.ods.compose.component.button.OdsOutlinedButton
import com.orange.ods.compose.theme.OdsDisplaySurface
import com.orange.ods.demo.R

Expand All @@ -38,14 +38,14 @@ fun ButtonsOutlined() {

@Composable
private fun OutlinedButtonsEnabledDisabled(hasIcon: Boolean, displaySurface: OdsDisplaySurface = OdsDisplaySurface.Default) {
OdsButtonOutlined(
OdsOutlinedButton(
modifier = Modifier.fullWidthButton(),
text = stringResource(R.string.component_state_enabled),
onClick = {},
icon = if (hasIcon) painterResource(id = R.drawable.ic_search) else null,
displaySurface = displaySurface
)
OdsButtonOutlined(
OdsOutlinedButton(
modifier = Modifier.fullWidthButton(false),
text = stringResource(R.string.component_state_disabled),
onClick = {},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ import androidx.compose.ui.Modifier
import androidx.compose.ui.res.dimensionResource
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.res.stringResource
import com.orange.ods.compose.component.button.OdsButtonText
import com.orange.ods.compose.component.button.OdsButtonTextStyle
import com.orange.ods.compose.component.button.OdsTextButton
import com.orange.ods.compose.component.button.OdsTextButtonStyle
import com.orange.ods.compose.theme.OdsDisplaySurface
import com.orange.ods.demo.R
import com.orange.ods.demo.ui.utilities.composable.Title

@Composable
fun ButtonsText() {
Title(R.string.component_buttons_text_subtitle_primary, withHorizontalPadding = true)
TextButtons(style = OdsButtonTextStyle.Primary)
TextButtons(style = OdsTextButtonStyle.Primary)

Title(R.string.component_buttons_text_subtitle_default, withHorizontalPadding = true)
TextButtons(style = OdsButtonTextStyle.Default)
TextButtons(style = OdsTextButtonStyle.Default)
}

@Composable
private fun TextButtons(style: OdsButtonTextStyle) {
private fun TextButtons(style: OdsTextButtonStyle) {
TextButtonsEnabledDisabled(style = style, hasIcon = false)
TextButtonsEnabledDisabled(style = style, hasIcon = true)

Expand All @@ -48,16 +48,16 @@ private fun TextButtons(style: OdsButtonTextStyle) {
}

@Composable
private fun TextButtonsEnabledDisabled(style: OdsButtonTextStyle, hasIcon: Boolean, displaySurface: OdsDisplaySurface = OdsDisplaySurface.Default) {
OdsButtonText(
private fun TextButtonsEnabledDisabled(style: OdsTextButtonStyle, hasIcon: Boolean, displaySurface: OdsDisplaySurface = OdsDisplaySurface.Default) {
OdsTextButton(
modifier = Modifier.fullWidthButton(),
text = stringResource(R.string.component_state_enabled),
onClick = {},
style = style,
icon = if (hasIcon) painterResource(id = R.drawable.ic_search) else null,
displaySurface = displaySurface
)
OdsButtonText(
OdsTextButton(
modifier = Modifier.fullWidthButton(false),
text = stringResource(R.string.component_state_disabled),
onClick = {},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import androidx.compose.runtime.setValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.dimensionResource
import androidx.compose.ui.res.painterResource
import com.orange.ods.compose.component.button.OdsButtonToggle
import com.orange.ods.compose.component.button.OdsIconToggleButton
import com.orange.ods.compose.theme.OdsDisplaySurface
import com.orange.ods.demo.R
import com.orange.ods.demo.ui.utilities.composable.Title
Expand All @@ -35,7 +35,7 @@ fun ButtonsToggle() {

Title(R.string.component_buttons_toggle_subtitle_single, withHorizontalPadding = true)
var toggleChecked by remember { mutableStateOf(false) }
OdsButtonToggle(
OdsIconToggleButton(
checked = toggleChecked,
onCheckedChange = { toggleChecked = it },
icon = painterResource(id = R.drawable.ic_module_molecule),
Expand Down Expand Up @@ -65,7 +65,7 @@ private fun ToggleGroup() {
horizontalArrangement = Arrangement.Center
) {
iconsRes.forEach { iconRes ->
OdsButtonToggle(
OdsIconToggleButton(
checked = checkedIcon == iconRes,
onCheckedChange = { checkedIcon = iconRes },
icon = painterResource(id = iconRes),
Expand All @@ -78,7 +78,7 @@ private fun ToggleGroup() {
@Composable
private fun ToggleButtonFullWidthAppearanceForced(displaySurface: OdsDisplaySurface) {
var toggleChecked by remember { mutableStateOf(false) }
OdsButtonToggle(
OdsIconToggleButton(
checked = toggleChecked,
onCheckedChange = { toggleChecked = it },
icon = painterResource(id = R.drawable.ic_module_molecule),
Expand Down
14 changes: 7 additions & 7 deletions docs/components/Buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ cards. In cards, text buttons help maintain an emphasis on card content.

> **Jetpack Compose implementation**
Use the `OdsButtonText` composable:
Use the `OdsTextButton` composable:

```kotlin
OdsButtonText(
OdsTextButton(
text = "Text button",
onClick = {},
enabled = true,
icon = painterResource(R.drawable.ic_search), // Optional, line can be removed if you don't need any icon
style = OdsButtonTextStyle.Primary
style = OdsTextButtonStyle.Primary
)
```

Expand Down Expand Up @@ -90,10 +90,10 @@ the primary action in an app.

> **Jetpack Compose implementation**
Use the `OdsButtonOutlined` composable:
Use the `OdsOutlinedButton` composable:

```kotlin
OdsButtonOutlined(
OdsOutlinedButton(
text = "Outlined button",
onClick = {},
enabled = true,
Expand Down Expand Up @@ -211,10 +211,10 @@ To emphasize groups of related toggle buttons, a group should share a common con

> **Jetpack Compose implementation**
Use the `OdsButtonToggle` composable:
Use the `OdsIconToggleButton` composable:

```kotlin
OdsButtonToggle(
OdsIconToggleButton(
checked = false,
onCheckedChange = { },
icon = painterResource(R.drawable.ic_search),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ import com.orange.ods.compose.theme.odsLightThemeColors
* surface. By default the appearance applied is based on the system night mode value.
*/
@Composable
fun OdsButtonToggle(
fun OdsIconToggleButton(
checked: Boolean,
onCheckedChange: (Boolean) -> Unit,
icon: Painter,
Expand Down Expand Up @@ -106,24 +106,24 @@ private fun Colors.buttonToggleBackgroundColor(displaySurface: OdsDisplaySurface
}

@Composable
private fun PreviewOdsButtonToggle() = Preview {
private fun PreviewOdsIconToggleButton() = Preview {
val checked = remember { mutableStateOf(false) }
OdsButtonToggle(
OdsIconToggleButton(
checked = checked.value,
onCheckedChange = { checked.value = it },
icon = painterResource(id = android.R.drawable.ic_btn_speak_now),
contentDescription = "Microphone"
)
}

@Preview(name = "OdsButtonToggle - Light")
@Preview(name = "OdsIconToggleButton - Light")
@Composable
private fun PreviewOdsButtonToggleLight() = PreviewOdsButtonToggle()
private fun PreviewOdsIconToggleButtonLight() = PreviewOdsIconToggleButton()

@Preview(
name = "OdsButtonToggle - Dark",
name = "OdsIconToggleButton - Dark",
uiMode = Configuration.UI_MODE_NIGHT_YES,
showBackground = true
)
@Composable
private fun PreviewOdsButtonToggleDark() = PreviewOdsButtonToggle()
private fun PreviewOdsIconToggleButtonDark() = PreviewOdsIconToggleButton()
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ import com.orange.ods.compose.theme.odsLightThemeColors
* surface. By default the appearance applied is based on the system night mode value.
*/
@Composable
fun OdsButtonOutlined(
fun OdsOutlinedButton(
text: String,
onClick: () -> Unit,
modifier: Modifier = Modifier,
Expand Down Expand Up @@ -105,22 +105,22 @@ private fun Colors.buttonOutlinedDisabledColor(displaySurface: OdsDisplaySurface
buttonOutlinedColor(displaySurface).copy(alpha = ContentAlpha.disabled)

@Composable
private fun PreviewOdsButtonOutlined() = Preview {
OdsButtonOutlined(text = "Text", onClick = {})
private fun PreviewOdsOutlinedButton() = Preview {
OdsOutlinedButton(text = "Text", onClick = {})
}

@Preview(
name = "OdsButtonOutlined - Light",
name = "OdsOutlinedButton - Light",
widthDp = 200
)
@Composable
private fun PreviewOdsButtonOutlinedLight() = PreviewOdsButtonOutlined()
private fun PreviewOdsOutlinedButtonLight() = PreviewOdsOutlinedButton()

@Preview(
name = "OdsButtonOutlined - Dark",
name = "OdsOutlinedButton - Dark",
uiMode = Configuration.UI_MODE_NIGHT_YES,
showBackground = true,
widthDp = 200
)
@Composable
private fun PreviewOdsButtonOutlinedDark() = PreviewOdsButtonOutlined()
private fun PreviewOdsOutlinedButtonDark() = PreviewOdsOutlinedButton()
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ import com.orange.ods.compose.theme.odsDarkThemeColors
import com.orange.ods.compose.theme.odsLightThemeColors

/**
* Specifying an [OdsButtonTextStyle] allow to display a button with specific colors.
* Specifying an [OdsTextButtonStyle] allow to display a button with specific colors.
*/
enum class OdsButtonTextStyle {
enum class OdsTextButtonStyle {
Default, Primary
}

Expand All @@ -60,19 +60,19 @@ enum class OdsButtonTextStyle {
* surface. By default the appearance applied is based on the system night mode value.
*/
@Composable
fun OdsButtonText(
fun OdsTextButton(
text: String,
onClick: () -> Unit,
modifier: Modifier = Modifier,
icon: Painter? = null,
enabled: Boolean = true,
style: OdsButtonTextStyle = OdsButtonTextStyle.Default,
style: OdsTextButtonStyle = OdsTextButtonStyle.Default,
displaySurface: OdsDisplaySurface = OdsDisplaySurface.Default
) {
CompositionLocalProvider(
LocalRippleTheme provides when (style) {
OdsButtonTextStyle.Primary -> OdsPrimaryRippleTheme
OdsButtonTextStyle.Default -> when (displaySurface) {
OdsTextButtonStyle.Primary -> OdsPrimaryRippleTheme
OdsTextButtonStyle.Default -> when (displaySurface) {
OdsDisplaySurface.Default -> OdsRippleTheme
OdsDisplaySurface.Light -> OdsLightRippleTheme
OdsDisplaySurface.Dark -> OdsDarkRippleTheme
Expand All @@ -97,49 +97,49 @@ fun OdsButtonText(
}

@Composable
private fun Colors.buttonTextColor(displaySurface: OdsDisplaySurface, style: OdsButtonTextStyle) =
private fun Colors.buttonTextColor(displaySurface: OdsDisplaySurface, style: OdsTextButtonStyle) =
when (displaySurface) {
OdsDisplaySurface.Default -> when (style) {
OdsButtonTextStyle.Primary -> MaterialTheme.colors.primary
OdsButtonTextStyle.Default -> MaterialTheme.colors.onSurface
OdsTextButtonStyle.Primary -> MaterialTheme.colors.primary
OdsTextButtonStyle.Default -> MaterialTheme.colors.onSurface
}
OdsDisplaySurface.Dark -> when (style) {
OdsButtonTextStyle.Primary -> odsDarkThemeColors.primary
OdsButtonTextStyle.Default -> odsDarkThemeColors.onSurface
OdsTextButtonStyle.Primary -> odsDarkThemeColors.primary
OdsTextButtonStyle.Default -> odsDarkThemeColors.onSurface
}
OdsDisplaySurface.Light -> when (style) {
OdsButtonTextStyle.Primary -> odsLightThemeColors.primary
OdsButtonTextStyle.Default -> odsLightThemeColors.onSurface
OdsTextButtonStyle.Primary -> odsLightThemeColors.primary
OdsTextButtonStyle.Default -> odsLightThemeColors.onSurface
}
}

@Composable
private fun Colors.buttonTextDisabledColor(displaySurface: OdsDisplaySurface) =
buttonTextColor(displaySurface = displaySurface, style = OdsButtonTextStyle.Default).copy(alpha = ContentAlpha.disabled)
buttonTextColor(displaySurface = displaySurface, style = OdsTextButtonStyle.Default).copy(alpha = ContentAlpha.disabled)

@Composable
private fun PreviewOdsButtonText(style: OdsButtonTextStyle) = Preview {
OdsButtonText(text = "Text", onClick = {}, style = style)
private fun PreviewOdsTextButton(style: OdsTextButtonStyle) = Preview {
OdsTextButton(text = "Text", onClick = {}, style = style)
}

@Preview(
name = "OdsButtonText - Light",
name = "OdsTextButton - Light",
widthDp = 200
)
@Composable
private fun PreviewOdsButtonTextLight(@PreviewParameter(OdsButtonTextPreviewParameterProvider::class) style: OdsButtonTextStyle) {
PreviewOdsButtonText(style)
private fun PreviewOdsTextButtonLight(@PreviewParameter(OdsTextButtonPreviewParameterProvider::class) style: OdsTextButtonStyle) {
PreviewOdsTextButton(style)
}

@Preview(
name = "OdsButtonText - Dark",
name = "OdsTextButton - Dark",
uiMode = Configuration.UI_MODE_NIGHT_YES,
showBackground = true,
widthDp = 200
)
@Composable
private fun PreviewOdsButtonTextDark(@PreviewParameter(OdsButtonTextPreviewParameterProvider::class) style: OdsButtonTextStyle) {
PreviewOdsButtonText(style)
private fun PreviewOdsTextButtonDark(@PreviewParameter(OdsTextButtonPreviewParameterProvider::class) style: OdsTextButtonStyle) {
PreviewOdsTextButton(style)
}

internal class OdsButtonTextPreviewParameterProvider : EnumPreviewParameterProvider(OdsButtonTextStyle::class)
internal class OdsTextButtonPreviewParameterProvider : EnumPreviewParameterProvider(OdsTextButtonStyle::class)
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ import androidx.compose.ui.res.painterResource
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.tooling.preview.Preview
import com.orange.ods.R
import com.orange.ods.compose.component.button.OdsButtonText
import com.orange.ods.compose.component.button.OdsButtonTextStyle
import com.orange.ods.compose.component.button.OdsTextButton
import com.orange.ods.compose.component.button.OdsTextButtonStyle
import com.orange.ods.compose.component.utilities.Preview
import com.orange.ods.compose.text.OdsTextBody1
import com.orange.ods.compose.text.OdsTextH6
Expand Down Expand Up @@ -117,17 +117,17 @@ fun OdsCardImageFirst(
horizontalArrangement = Arrangement.spacedBy(dimensionResource(id = R.dimen.spacing_s))
) {
button1Text?.let {
OdsButtonText(
OdsTextButton(
text = it,
onClick = { onButton1Click?.invoke() },
style = OdsButtonTextStyle.Primary
style = OdsTextButtonStyle.Primary
)
}
button2Text?.let {
OdsButtonText(
OdsTextButton(
text = it,
onClick = { onButton2Click?.invoke() },
style = OdsButtonTextStyle.Primary
style = OdsTextButtonStyle.Primary
)
}
}
Expand Down
Loading

0 comments on commit 0689d8c

Please sign in to comment.