README.md

Credit card preview

A simple composable component that displays a credit card preview and provides a form to enter the information, including field validations.

This component supports (at the moment) visa and mastercard on the preview.

Preview

How to use?

Initialize the viewModel provided by the project

class Activity : ComponentActivity() {
    // Initialize here
    private val viewModel by viewModels<CreditCardViewModel>()
    
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            // This function is declarated in the next step
            LayoutCreditCard(
                viewModel = viewModel
            )
        }
    }
}

Then create the composable function, using the viewmodel as a parameter

@Composable
fun LayoutCreditCard(viewModel: CreditCardViewModel) {
    Column(
        modifier = Modifier.padding(
            start = 16.dp, 
            top = 16.dp, 
            end = 16.dp
        )
    ) {
        CreditCard(
            number = viewModel.number,
            expiration = viewModel.expiration,
            holderName = viewModel.name,
            cvc = viewModel.cvc,
            flipped = viewModel.flipped,
            emptyChar = 'X',
            showSecurityCode = false
        )

        Spacer(modifier = Modifier.size(16.dp))

        CreditCardForm(viewModel = viewModel)
    }
}

The credit card preview and form are separated components, so you can use them independently.

Contribute

I will be more than happy to receive your PR, I am open to suggestions or modifications.

As for commits, I use gitmoji to keep the history small and consistent.

Next steps

• Create an standar design for the card
• Include back view
• Identify card entity
• Add inputs to fill the view
• Include testing
• Upload project to centralMaven