ComponentActivity

@ContentView
ComponentActivity(contentLayoutId: @LayoutRes Int)

Alternate constructor that can be used to provide a default layout that will be inflated as part of super.onCreate(savedInstanceState).

This should generally be called from your constructor that takes no parameters, as is required for API 27 and lower or when using the default android.app.AppComponentFactory.

open fun addMenuProvider(provider: MenuProvider): Unit

Adds the given MenuProvider to this MenuHost. If using this method, you must manually remove the provider when necessary.

open fun addMenuProvider(provider: MenuProvider, owner: LifecycleOwner): Unit

Adds the given MenuProvider to this MenuHost. This MenuProvider will be removed once the given LifecycleOwner receives an Lifecycle.Event.ON_DESTROY event.

open fun addMenuProvider(
    provider: MenuProvider,
    owner: LifecycleOwner,
    state: Lifecycle.State
): Unit

Adds the given MenuProvider to this MenuHost once the given LifecycleOwner reaches the given Lifecycle.State. This MenuProvider will be removed once the given LifecycleOwner goes down from the given Lifecycle.State.

final fun addOnConfigurationChangedListener(listener: Consumer<Configuration>): Unit

Add a new listener that will get a callback associated with ComponentCallbacks.onConfigurationChanged with the new Configuration.

final fun addOnContextAvailableListener(listener: OnContextAvailableListener): Unit

{@inheritDoc}

Any listener added here will receive a callback as part of super.onCreate(), but importantly before any other logic is done (including calling through to the framework Activity.onCreate with the exception of restoring the state of the savedStateRegistry for use in your listener.

final fun addOnMultiWindowModeChangedListener(
    listener: Consumer<MultiWindowModeChangedInfo>
): Unit

Add a new listener that will get a callback associated with Activity.onMultiWindowModeChanged with the new MultiWindowModeChangedInfo.

final fun addOnNewIntentListener(listener: Consumer<Intent>): Unit

Add a new listener that will get a callback associated with Activity.onNewIntent with the new Intent.

final fun addOnPictureInPictureModeChangedListener(
    listener: Consumer<PictureInPictureModeChangedInfo>
): Unit

Add a new listener that will get a callback associated with Activity.onPictureInPictureModeChanged with the new PictureInPictureModeChangedInfo.

final fun addOnPictureInPictureUiStateChangedListener(
    listener: Consumer<PictureInPictureUiStateCompat>
): Unit

Add a new listener that will get a callback associated with Activity.onPictureInPictureUiStateChanged with the new PictureInPictureUiStateCompat.

final fun addOnTrimMemoryListener(listener: Consumer<Int>): Unit

Add a new listener that will get a callback associated with ComponentCallbacks2.onTrimMemory with the int representing the level of trimming.

final fun addOnUserLeaveHintListener(listener: Runnable): Unit

Add a new listener that will get a callback associated with Activity.onUserLeaveHint

final fun enterPictureInPictureMode(params: PictureInPictureParamsCompat): Unit

Available since API 24 in the framework Activity class, puts the activity in picture-in-picture mode if possible in the current system state. Any prior calls to setPictureInPictureParams will still apply when entering picture-in-picture through this call.

@CallSuper
open fun initializeViewTreeOwners(): Unit

Sets the view tree owners before setting the content view so that the inflation process and attach listeners will see them already present.

open fun invalidateMenu(): Unit

Invalidates the android.view.Menu to ensure that what is displayed matches the current internal state of the menu. This should be called whenever the state of the menu is changed, such as items being removed or disabled based on some user event.

@MainThread
@CallSuper
open fun onBackPressed(): Unit

Called when the activity has detected the user's press of the back key. The onBackPressedDispatcher will be given a chance to handle the back button before the default behavior of android.app.Activity.onBackPressed is invoked.

@CallSuper
open fun onConfigurationChanged(newConfig: Configuration): Unit

{@inheritDoc}

Dispatches this call to all listeners added via addOnConfigurationChangedListener.

@CallSuper
open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean): Unit

{@inheritDoc}

Dispatches this call to all listeners added via addOnMultiWindowModeChangedListener.

@RequiresApi(api = 26)
@CallSuper
open fun onMultiWindowModeChanged(
    isInMultiWindowMode: Boolean,
    newConfig: Configuration
): Unit

{@inheritDoc}

Dispatches this call to all listeners added via addOnMultiWindowModeChangedListener.

@CallSuper
open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean): Unit

{@inheritDoc}

Dispatches this call to all listeners added via addOnPictureInPictureModeChangedListener.

@RequiresApi(api = 26)
@CallSuper
open fun onPictureInPictureModeChanged(
    isInPictureInPictureMode: Boolean,
    newConfig: Configuration
): Unit

{@inheritDoc}

Dispatches this call to all listeners added via addOnPictureInPictureModeChangedListener.

@RequiresApi(api = 31)
@CallSuper
open fun onPictureInPictureUiStateChanged(pipState: PictureInPictureUiState): Unit

{@inheritDoc}

@CallSuper
open fun onRequestPermissionsResult(
    requestCode: Int,
    permissions: Array<String>,
    grantResults: IntArray
): Unit

{@inheritDoc}

open fun onRetainCustomNonConfigurationInstance(): Any?

Use this instead of onRetainNonConfigurationInstance. Retrieve later with lastCustomNonConfigurationInstance.

final fun onRetainNonConfigurationInstance(): Any?

Retain all appropriate non-config state. You can NOT override this yourself! Use a androidx.lifecycle.ViewModel if you want to retain your own non config state.

@CallSuper
open fun onTrimMemory(level: Int): Unit

{@inheritDoc}

Dispatches this call to all listeners added via addOnTrimMemoryListener.

open fun peekAvailableContext(): Context?

Get the Context if it is currently available. If this returns null, you can use addOnContextAvailableListener to receive a callback for when it available.

final fun <I : Any?, O : Any?> registerForActivityResult(
    contract: ActivityResultContract<I, O>,
    callback: ActivityResultCallback<O>
): ActivityResultLauncher<I>

Register a request to start an activity for result, designated by the given contract.

This creates a record in the registry associated with this caller, managing request code, as well as conversions to/from Intent under the hood.

This must be called unconditionally, as part of initialization path, typically as a field initializer of an Activity or Fragment.

final fun <I : Any?, O : Any?> registerForActivityResult(
    contract: ActivityResultContract<I, O>,
    registry: ActivityResultRegistry,
    callback: ActivityResultCallback<O>
): ActivityResultLauncher<I>

Register a request to start an activity for result, designated by the given contract.

This creates a record in the given registry, managing request code, as well as conversions to/from Intent under the hood.

This must be called unconditionally, as part of initialization path, typically as a field initializer of an Activity or Fragment.

open fun removeMenuProvider(provider: MenuProvider): Unit

Removes the given MenuProvider from this MenuHost.

final fun removeOnConfigurationChangedListener(listener: Consumer<Configuration>): Unit

Remove a previously added listener. It will not receive any future callbacks.

final fun removeOnContextAvailableListener(listener: OnContextAvailableListener): Unit

Remove a OnContextAvailableListener previously added via addOnContextAvailableListener.

final fun removeOnMultiWindowModeChangedListener(
    listener: Consumer<MultiWindowModeChangedInfo>
): Unit

Remove a previously added listener. It will not receive any future callbacks.

final fun removeOnNewIntentListener(listener: Consumer<Intent>): Unit

Remove a previously added listener. It will not receive any future callbacks.

final fun removeOnPictureInPictureModeChangedListener(
    listener: Consumer<PictureInPictureModeChangedInfo>
): Unit

Remove a previously added listener. It will not receive any future callbacks.

final fun removeOnPictureInPictureUiStateChangedListener(
    listener: Consumer<PictureInPictureUiStateCompat>
): Unit

Remove a previously added listener. It will not receive any future callbacks.

final fun removeOnTrimMemoryListener(listener: Consumer<Int>): Unit

Remove a previously added listener. It will not receive any future callbacks.

final fun removeOnUserLeaveHintListener(listener: Runnable): Unit

Remove a previously added listener. It will not receive any future callbacks.

final fun setPictureInPictureParams(params: PictureInPictureParamsCompat): Unit

Available since API 26 in the framework Activity class, updates the properties of the picture-in-picture activity, or sets it to be used later when enterPictureInPictureMode is called

open fun startActivityForResult(intent: Intent, requestCode: Int): Unit

{@inheritDoc}

open fun startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?): Unit

{@inheritDoc}

open fun startIntentSenderForResult(
    intent: IntentSender,
    requestCode: Int,
    fillInIntent: Intent?,
    flagsMask: Int,
    flagsValues: Int,
    extraFlags: Int
): Unit

{@inheritDoc}

open fun startIntentSenderForResult(
    intent: IntentSender,
    requestCode: Int,
    fillInIntent: Intent?,
    flagsMask: Int,
    flagsValues: Int,
    extraFlags: Int,
    options: Bundle?
): Unit

{@inheritDoc}

@CallSuper
protected open fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?): Unit

{@inheritDoc}

protected open fun onCreate(savedInstanceState: Bundle?): Unit

{@inheritDoc}

If your ComponentActivity is annotated with ContentView, this will call setContentView for you.

@CallSuper
protected open fun onNewIntent(intent: Intent): Unit

{@inheritDoc}

Dispatches this call to all listeners added via addOnNewIntentListener.

@CallSuper
protected open fun onUserLeaveHint(): Unit

{@inheritDoc}

Dispatches this call to all listeners added via addOnUserLeaveHintListener.

final val activityResultRegistry: ActivityResultRegistry

Get the ActivityResultRegistry associated with this activity.

open val fullyDrawnReporter: FullyDrawnReporter

Retrieve the FullyDrawnReporter that should handle the independent parts of the UI that separately report that they are fully drawn.

open val lifecycle: Lifecycle

{@inheritDoc}

Overriding this method is no longer supported and this method will be made final in a future version of ComponentActivity. If you do override this method, you must:

1. Return an instance of LifecycleRegistry

2. Lazily initialize your LifecycleRegistry object when this is first called.

Note that this method will be called in the super classes' constructor, before any field initialization or object state creation is complete.

open val navigationEventDispatcher: NavigationEventDispatcher

Lazily provides a NavigationEventDispatcher for back navigation handling, including support for predictive back gestures introduced in Android 13 (API 33+).

This dispatcher acts as the central point for back navigation events. When a navigation event occurs (e.g., a back gesture), it safely invokes ComponentActivity.onBackPressed.

final val onBackPressedDispatcher: OnBackPressedDispatcher

Retrieve the OnBackPressedDispatcher that will be triggered when onBackPressed is called.

@MainThread
inline fun <VM : ViewModel> ComponentActivity.viewModels(
    noinline extrasProducer: (() -> CreationExtras)? = null,
    noinline factoryProducer: (() -> ViewModelProvider.Factory)? = null
): Lazy<VM>

Returns a Lazy delegate to access the ComponentActivity's ViewModel, if factoryProducer is specified then ViewModelProvider.Factory returned by it will be used to create ViewModel first time.

class MyComponentActivity : ComponentActivity() {
    val viewmodel: MyViewModel by viewModels()
}

This property can be accessed only after the Activity is attached to the Application, and access prior to that will result in IllegalArgumentException.

fun ComponentActivity.setContent(
    parent: CompositionContext? = null,
    content: @Composable () -> Unit
): Unit

Composes the given composable into the given activity. The content will become the root view of the given activity.

This is roughly equivalent to calling ComponentActivity.setContentView with a ComposeView i.e.:

setContentView(
  ComposeView(this).apply {
    setContent {
      MyComposableContent()
    }
  }
)

fun ComponentActivity.enableEdgeToEdge(
    statusBarStyle: SystemBarStyle = SystemBarStyle.auto(Color.TRANSPARENT, Color.TRANSPARENT),
    navigationBarStyle: SystemBarStyle = SystemBarStyle.auto(DefaultLightScrim, DefaultDarkScrim)
): Unit

Enables the edge-to-edge display for this ComponentActivity.

To set it up with the default style, call this method in your Activity's onCreate method:

    override fun onCreate(savedInstanceState: Bundle?) {
        enableEdgeToEdge()
        super.onCreate(savedInstanceState)
        ...
    }

The default style configures the system bars with a transparent background when contrast can be enforced by the system (API 29 or above). On older platforms (which only have 3-button/2-button navigation modes), an equivalent scrim is applied to ensure contrast with the system bars.

See SystemBarStyle for more customization options.