Skip to content

Latest commit

 

History

History
220 lines (193 loc) · 19.9 KB

README.md

File metadata and controls

220 lines (193 loc) · 19.9 KB
Raw

alt text

SSJetPackComposeProgressButton

SSJetPackComposeProgressButton is an elegant button with a different loading animations which makes your app attractive.

CI Status Kotlin Version Platform API Android Arsenal

Features

  • Android’s modern toolkit - Jetpack Compose support.
  • Newly designed loading animation make your app attractive.
  • Blinking icon button for your hot-feature.
  • Button with text, right and left icon.
  • Different types of state makes it easy to manage button. (Idle, Loading, Success, Failure)
  • Fully customized button (Corner radius, background, colors, animation speed etc.)
  • Customize button loading animation with your logo and special animation effect.
  • Supports displaying GIFs via URL or local file in the button's loading state.

🎬 Preview

On Success On Failure

🎬 Customized loading animation

On Success On Failure

Installation

  1. Add it in your root build.gradle at the end of repositories:

    allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

  • Add the dependency in your app's build.gradle file

     dependencies {
         implementation 'com.github.SimformSolutionsPvtLtd:SSJetPackComposeProgressButton:<LATEST_TAG>'
 }

Usage

  • Just use SSJetPackComposeProgressButton where you want button.

     var submitButtonState by remember { mutableStateOf(SSButtonState.IDLE) }
 SSJetPackComposeProgressButton(
     type = SSButtonType.CLOCK,
     width = 300.dp,
     height = 50.dp,
     onClick = {
         //Perform action on click of button and make it's state to LOADING
         submitButtonState = SSButtonState.LOADING
     },
     assetColor = Color.Red,
     buttonState = submitButtonState
 )
     // On Success change submitButtonState to success state
 submitButtonState = SSButtonState.SUCCESS
     // On Failure change submitButtonState to failure state
 submitButtonState = SSButtonState.FAILIURE

Migration guide from release v1.0.9

  • Added support displaying GIFs via URL or local file in the button's loading state.
  • Added blinkingIconColor to animate with your custom color.
  • You can now apply different tints by using these updated variables: leftImageIconTintColor rightImageTintColor successIconTintColor failureIconTintColor These variables allow you to customize tints as per your specific requirements, while defaulting to null if not specified.
  • Changed default cornerRadius value to 0 from 20.
  • Renamed blinkingIcon to isBlinkingIcon in SSJetPackComposeProgressButton.
  • Renamed colorChanger in fadeInOut in SSCustomLoadingEffect.
  • Removed buttonBorderStroke and instead use buttonBorderWidth, buttonBorderColor and animatedButtonBorderColor to offer more control over button borders.
  • Removed default values for successIconPainter and failureIconPainter and set to null to offer more control over what is displayed when animation is completed.
  • Removed default value for customLoadingIconPainter and set to null to offer more control over what is displayed when animation is in progress.

Customization

  • You can customize loading icon and animation effect according to your requirement.You can apply multiple animation effect from rotation, zoom-in-out and fade-in-out too.

     var submitButtonState by remember { mutableStateOf(SSButtonState.IDLE) }
 SSJetPackComposeProgressButton(
                 type = SSButtonType.CUSTOM,
                 width = 480.dp,
                 height = 60.dp,
                 onClick = {
                     //Perform action on click of button and make it's state to LOADING
                     submitButtonState = SSButtonState.LOADING
                     CoroutineScope(Dispatchers.Default).launch {
                         // Do your heavy work once completed show success or failure
                         delay(2000) 
                         submitButtonState = SSButtonState.SUCCESS
                     }
                 },
                 cornerRadius = 20,
                 assetColor = Color.Red,
                 buttonState = submitButtonState,
                 successIconPainter = rememberVectorPainter(image = Icons.Default.Done),
                 successIconTintColor = LIGHT_PINK,
                 failureIconPainter = rememberVectorPainter(image = Icons.Outlined.Info),
                 failureIconTintColor = LIGHT_PINK,
                 colors = ButtonDefaults.buttonColors(
                     containerColor = Color.White,
                     disabledContainerColor = Color.White
                 ),
                 padding = PaddingValues(12.dp),
                 text = stringResource(id = R.string.app_name),
                 textModifier = Modifier.padding(10.dp),
                 fontWeight = FontWeight.Bold,
                 leftImagePainter = painterResource(id = R.drawable.baby_pink_android),
                 isBlinkingIcon = true,
                 blinkingIconColor = Color.White,
                 buttonBorderWidth = 3.dp,
                 animatedButtonBorderColor = LIGHT_PINK,
                 buttonBorderColor = LIGHT_PINK,
                 customLoadingIconPainter = painterResource(id = R.drawable.baby_pink_android),
                 customLoadingEffect = SSCustomLoadingEffect(
                     zoomInOut = true,
                 )
             )
     // On Success change submitButtonState to success state
 submitButtonState = SSButtonState.SUCCESS
     // On Failure change submitButtonState to failure state
 submitButtonState = SSButtonState.FAILIURE

All Attributes

Attribute Description Default
type Choose type of animation from:[CIRCLE, WHEEL, ZOOM_IN_OUT_CIRCLE, CLOCK, SPIRAL, CUSTOM] None
width Width to be applied to the button. None
height Height to be applied to the button. None
onClick Will be called when the user clicks the button. None
assetColor Color to be applied to icon and text inside button. None
buttonState Represent the state of button from IDLE, LOADING, SUCCESS, FAILIURE from SSButtonState. None
buttonBorderWidth Border width to draw around the button. 0.dp
buttonBorderColor Border color to be applied around the button. 0.dp
animatedButtonBorderColor Border color to be applied around the button when button is in LOADING state. 0.dp
isBlinkingIcon Icon will be blink with size and color. false
blinkingIconColor Color which will be used with Icon tintColor when isBlinkingIcon is enabled. null
cornerRadius Corner radius to be applied to the button. 20
speedMillis Speed of the animation while changing the state. 1000
enabled Controls the enabled state of the button. true
elevation It is used to resolve the elevation for this button in different. ButtonDefaults.elevatedButtonElevation()
colors Colors that will be used to resolve the background and content color for this button in different states ButtonDefaults.buttonColors()
padding The spacing values to apply internally between the container and the content. PaddingValues(0.dp)
alphaValue The alpha of the drawn area. 1f
leftImagePainter Painter to draw inside this left Icon. null
leftImageTintColor Color to be applied to left image. null
rightImagePainter Painter to draw inside this right Icon. null
rightImageTintColor Color to be applied to right image. null
successIconPainter Painter to draw inside this success state Icon. null
successIconTintColor Color to be applied to success icon. null
failureIconPainter Painter to draw inside this failure state Icon. null
failureIconTintColor Color to be applied to failure icon. null
text The text to be displayed. null
textModifier To apply to this text layout node. Modifier
fontSize The size of glyphs to use when painting the text. TextUnit.Unspecified
fontStyle The typeface variant to use when drawing the letters (e.g., italic). null
fontFamily The font family to be used when rendering the text. null
fontWeight The typeface thickness to use when painting the text (e.g., [FontWeight.Bold]). null
hourHandColor Color will be apply to hour hand in clock type animation only. Color.Black
customLoadingIconPainter painter [Painter] to draw your custom loading icon. painterResource(id = R.drawable.simform_logo)
customLoadingEffect Custom loading animation type like roation, zoom in out etc. SSCustomLoadingEffect( rotation = false, zoomInOut = false, colorChanger = false)
customLoadingPadding Spacing between button border and loading icon. 0
shouldAutoMoveToIdleState In case of success/failure state after defined time it move back to idle state. true

Our JetPackCompose Sample

SSComposeCookBook : A Collection of major Jetpack compose UI components which are commonly used.

Find this library useful? ❤️

Support it by joining stargazers for this repository.⭐

How to Contribute🤝

Whether you're helping us fix bugs, improve the docs, or a feature request, we'd love to have you! 💪 Check out our Contributing Guide for ideas on contributing.

Bugs and Feedback

For bugs, feature requests, and discussion please use GitHub Issues.

Medium Blog

For more info go to Progress Button using JetPack Compose : SSJetPackComposeProgressButton

Awesome Mobile Libraries

License

Distributed under the MIT License. See LICENSE for details.