Image composable in Android Kotlin

Introduction

We use the Image composable to show pictures in our app. Pictures make apps more interesting and easier to understand.

To display a logo on the app's home screen.

To show a user's profile picture in a chat app.

To add icons for buttons or navigation.

To display photos in a gallery app.

To decorate the app with background images.

Syntax

Android Kotlin

Image(
  painter = painterResource(id = R.drawable.image_name),
  contentDescription = "Description of image"
)

painter tells which image to show.

contentDescription helps people using screen readers understand the image.

Examples

Shows the app's logo with a description for accessibility.

Android Kotlin

Image(
  painter = painterResource(id = R.drawable.ic_launcher_foreground),
  contentDescription = "App logo"
)

Displays a user's profile picture.

Android Kotlin

Image(
  painter = painterResource(id = R.drawable.profile_pic),
  contentDescription = "User profile picture"
)

Shows a decorative background image. Description is null because it's not important for screen readers.

Android Kotlin

Image(
  painter = painterResource(id = R.drawable.background),
  contentDescription = null
)

Sample App

This app shows the app logo image in the center of the screen. The image has a description for accessibility.

Android Kotlin

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.Image
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.tooling.preview.Preview
import com.example.myapp.R

class MainActivity : ComponentActivity() {
  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContent {
      MyApp()
    }
  }
}

@Composable
fun MyApp() {
  Surface(
    modifier = Modifier.fillMaxSize(),
    color = MaterialTheme.colorScheme.background
  ) {
    Box(modifier = Modifier.fillMaxSize()) {
      Image(
        painter = painterResource(id = R.drawable.ic_launcher_foreground),
        contentDescription = "App logo",
        modifier = Modifier.align(Alignment.Center)
      )
    }
  }
}

@Preview(showBackground = true)
@Composable
fun DefaultPreview() {
  MyApp()
}

Important Notes

Always provide contentDescription for accessibility unless the image is purely decorative.

You can use different painter sources like painterResource for local images or rememberImagePainter for loading from the internet (with extra libraries).

Use Modifier to change image size, shape, or position.

Summary

The Image composable shows pictures in your app.

Use painterResource to load images from your app resources.

Always add contentDescription for users who need screen readers.

Practice

1. What is the main purpose of the Image composable in Android Jetpack Compose?

easy

A. To play audio files

B. To display pictures or images in the app UI

C. To create buttons

D. To handle user input

Solution

1. Step 1: Understand the role of Image composable

   The Image composable is designed to show pictures or images in the app's user interface.

2. Step 2: Compare with other options

   Playing audio, creating buttons, and handling input are done by other composables, not Image.

3. Final Answer:

   To display pictures or images in the app UI -> Option B

4. Quick Check:

   Image composable = display pictures [OK]

Hint: Image composable always shows pictures or graphics [OK]

Common Mistakes:

• Confusing Image with Button composable
• Thinking Image plays sounds
• Assuming Image handles user input

2. Which of the following is the correct way to load an image resource named logo in an Image composable?

easy

A. Image(resource = R.drawable.logo, description = "App logo")

B. Image(imageId = R.drawable.logo)

C. Image(src = "logo", desc = "App logo")

D. Image(painter = painterResource(id = R.drawable.logo), contentDescription = "App logo")

Solution

1. Step 1: Recall correct Image syntax

   The Image composable requires a painter, which is created by painterResource with the drawable resource ID.

2. Step 2: Check parameters

   Image(painter = painterResource(id = R.drawable.logo), contentDescription = "App logo") uses painterResource(id = R.drawable.logo) and contentDescription, which is correct and recommended for accessibility.

3. Final Answer:

   Image(painter = painterResource(id = R.drawable.logo), contentDescription = "App logo") -> Option D

4. Quick Check:

   Use painterResource and contentDescription [OK]

Hint: Use painterResource with drawable ID and add contentDescription [OK]

Common Mistakes:

• Using wrong parameter names like resource or src
• Omitting contentDescription
• Passing imageId instead of painter

3. What will happen if you run this code snippet?

Image(painter = painterResource(id = R.drawable.ic_launcher), contentDescription = null)

medium

A. The image will display but screen readers will ignore it

B. The app will crash due to missing contentDescription

C. The image will not display at all

D. The image will display with a default description

Solution

1. Step 1: Understand contentDescription null effect

   Setting contentDescription to null means the image is decorative and screen readers will skip it.

2. Step 2: Check image display behavior

   The image still displays normally on screen; only accessibility tools ignore it.

3. Final Answer:

   The image will display but screen readers will ignore it -> Option A

4. Quick Check:

   contentDescription=null means decorative image [OK]

Hint: Null contentDescription hides image from screen readers only [OK]

Common Mistakes:

• Thinking app crashes without contentDescription
• Assuming image won't show
• Believing default description is added automatically

4. Identify the error in this Image composable code:

Image(painter = painterResource(), contentDescription = "Icon")

medium

A. R.drawable.icon is invalid resource

B. contentDescription should be null

C. Missing named parameter 'id' in painterResource call

D. painterResource cannot be used inside Image

Solution

1. Step 1: Check painterResource usage

   painterResource requires the drawable resource ID to be passed with the named parameter 'id'.

2. Step 2: Identify missing 'id' parameter

   The code calls painterResource without providing the required 'id' parameter, causing a syntax error.

3. Final Answer:

   Missing named parameter 'id' in painterResource call -> Option C

4. Quick Check:

   painterResource(id = ...) is required [OK]

Hint: Always use 'id =' when calling painterResource [OK]

Common Mistakes:

• Omitting the 'id' parameter in painterResource
• Setting contentDescription to null incorrectly
• Thinking painterResource is invalid inside Image

5. You want to display a user profile picture from a drawable resource named profile_pic with a circular shape and a description for accessibility. Which code snippet correctly achieves this?

hard

A. Image(painter = painterResource(id = R.drawable.profile_pic), contentDescription = "User profile picture", modifier = Modifier.clip(CircleShape))

B. Image(painterResource(id = R.drawable.profile_pic), contentDescription = null, shape = CircleShape)

C. Image(painter = R.drawable.profile_pic, contentDescription = "Profile", modifier = Modifier.circle())

D. Image(src = R.drawable.profile_pic, desc = "User picture", modifier = Modifier.clip(CircleShape))

Solution

1. Step 1: Use painterResource with id and contentDescription

   Image(painter = painterResource(id = R.drawable.profile_pic), contentDescription = "User profile picture", modifier = Modifier.clip(CircleShape)) correctly uses painterResource with id and provides a meaningful contentDescription.

2. Step 2: Apply circular clipping with Modifier.clip(CircleShape)

   This modifier clips the image into a circle shape, which is the desired effect.

3. Final Answer:

   Image(painter = painterResource(id = R.drawable.profile_pic), contentDescription = "User profile picture", modifier = Modifier.clip(CircleShape)) -> Option A

4. Quick Check:

   Use painterResource + contentDescription + Modifier.clip(CircleShape) [OK]

Hint: Use Modifier.clip(CircleShape) for circular images [OK]

Common Mistakes:

• Passing drawable resource directly as painter
• Omitting contentDescription or setting it null
• Using incorrect modifier or parameter names