ComposableFragment

class ComposableFragment : Fragment

kotlin.Any
   ↳ androidx.fragment.app.Fragment
     ↳ androidx.navigation.fragment.compose.ComposableFragment

This class provides a Fragment wrapper around a composable function that is loaded via reflection. The composable function has access to this fragment instance via LocalFragment.

This class is constructed via a factory method: make sure you add import androidx.navigation.fragment.compose.ComposableFragment.Companion.ComposableFragment

Summary

Public companion functions
ComposableFragment
ComposableFragment(fullyQualifiedName: String)

Creates a new ComposableFragment instance that will wrap the Composable method loaded via reflection from fullyQualifiedName.

Public functions
open View
onCreateView(
    inflater: LayoutInflater,
    container: ViewGroup?,
    savedInstanceState: Bundle?
)

Called to have the fragment instantiate its user interface view.

Inherited functions
From androidx.fragment.app.Fragment
Unit

Add a new OnContextAvailableListener for receiving a callback for when this class is associated with a android.content.Context.
Unit
dump(
    prefix: String,
    fd: FileDescriptor?,
    writer: PrintWriter,
    args: Array<String>?
)

Print the Fragments's state into the given stream.
operator Boolean
equals(o: Any?)

Subclasses can not override equals().
String

Return a localized string from the application's package's default string table.
String
getString(resId: @StringRes Int, vararg formatArgs: Any)

Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in java.util.Formatter and format.
CharSequence

Return a localized, styled CharSequence from the application's package's default string table.
Int

Subclasses can not override hashCode().
Unit

This function is deprecated.

use onViewCreated for code touching the view created by onCreateView and onCreate for other initialization.
Unit
onActivityResult(requestCode: Int, resultCode: Int, data: Intent?)

This function is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
Unit

This function is deprecated.

See onAttach.
Unit

Called when a fragment is first attached to its context.
Unit

This function is deprecated.

The responsibility for listening for fragments being attached has been moved to FragmentManager.
Unit
Boolean

This hook is called whenever an item in a context menu is selected.
Unit
@MainThread
@CallSuper
onCreate(savedInstanceState: Bundle?)

Called to do initial creation of a fragment.
Animation?
@MainThread
onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)

Called when a fragment loads an animation.
Animator?
@MainThread
onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)

Called when a fragment loads an animator.
Unit
@MainThread
onCreateContextMenu(
    menu: ContextMenu,
    v: View,
    menuInfo: ContextMenu.ContextMenuInfo?
)

Called when a context menu for the view is about to be shown.
Unit

This function is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
Unit

Called when the fragment is no longer in use.
Unit

This function is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
Unit

Called when the view previously created by onCreateView has been detached from the fragment.
Unit

Called when the fragment is no longer attached to its activity.
LayoutInflater
onGetLayoutInflater(savedInstanceState: Bundle?)

Returns the LayoutInflater used to inflate Views of this Fragment.
Unit

Called when the hidden state (as returned by isHidden of the fragment or another fragment in its hierarchy has changed.
Unit
@UiThread
@CallSuper
onInflate(
    activity: Activity,
    attrs: AttributeSet,
    savedInstanceState: Bundle?
)

This function is deprecated.

See onInflate.
Unit
@UiThread
@CallSuper
onInflate(
    context: Context,
    attrs: AttributeSet,
    savedInstanceState: Bundle?
)

Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
Unit

This function is deprecated.
Unit
onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
Boolean

This function is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
Unit

This function is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
Unit

Called when the Fragment is no longer resumed.
Unit
onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

Called by the system when the activity changes to and from picture-in-picture mode.
Unit

This function is deprecated.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
Unit
@MainThread
onPrimaryNavigationFragmentChanged(
    isPrimaryNavigationFragment: Boolean
)

Callback for when the primary navigation state of this Fragment has changed.
Unit
onRequestPermissionsResult(
    requestCode: Int,
    permissions: Array<String>,
    grantResults: IntArray
)

This function is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
Unit

Called when the fragment is visible to the user and actively running.
Unit

Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted.
Unit

Called when the Fragment is visible to the user.
Unit

Called when the Fragment is no longer started.
Unit
@MainThread
onViewCreated(view: View, savedInstanceState: Bundle?)

Called immediately after onCreateView has returned, but before any saved state has been restored in to the view.
Unit

Called when all saved state has been restored into the view hierarchy of the fragment.
Context?

Get the Context if it is currently available.
Unit

Postpone the entering Fragment transition until startPostponedEnterTransition or executePendingTransactions has been called.
Unit
postponeEnterTransition(duration: Long, timeUnit: TimeUnit)

Postpone the entering Fragment transition for a given amount of time and then call startPostponedEnterTransition.
ActivityResultLauncher<I>
@MainThread
<I : Any, O : Any> registerForActivityResult(
    contract: ActivityResultContract<I, O>,
    callback: ActivityResultCallback<O>
)

Register a request to start an activity for result, designated by the given contract.
ActivityResultLauncher<I>
@MainThread
<I : Any, O : Any> registerForActivityResult(
    contract: ActivityResultContract<I, O>,
    registry: ActivityResultRegistry,
    callback: ActivityResultCallback<O>
)

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

Registers a context menu to be shown for the given view (multiple views can show the context menu).
Unit

Remove a OnContextAvailableListener previously added via addOnContextAvailableListener.
Unit
requestPermissions(permissions: Array<String>, requestCode: Int)

This function is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
FragmentActivity

Return the FragmentActivity this fragment is currently associated with.
Bundle

Return the arguments supplied when the fragment was instantiated.
Context

Return the Context this fragment is currently associated with.
FragmentManager

This function is deprecated.

This has been renamed to getParentFragmentManager() to make it clear that you are accessing the FragmentManager that contains this Fragment and not the FragmentManager associated with child Fragments.
Any

Return the host object of this fragment.
Fragment

Returns the parent Fragment containing this Fragment.
View

Get the root view for the fragment's layout (the one returned by onCreateView).
Unit

When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
Unit

When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
Unit

This function is deprecated.

This method is no longer needed when using a MenuProvider to provide a Menu to your activity, which replaces onCreateOptionsMenu as the recommended way to provide a consistent, optionally Lifecycle-aware, and modular way to handle menu creation and item selection.
Unit

Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by FragmentManager.saveFragmentInstanceState.
Unit
setMenuVisibility(menuVisible: Boolean)

Set a hint for whether this fragment's menu should be visible.
Unit
setTargetFragment(fragment: Fragment?, requestCode: Int)

This function is deprecated.

Instead of using a target fragment to pass results, the fragment requesting a result should use setFragmentResultListener to register a FragmentResultListener with a requestKey using its parent fragment manager.
Boolean

Gets whether you should show UI with rationale before requesting a permission.
Unit

Call startActivity from the fragment's containing Activity.
Unit
startActivity(intent: Intent, options: Bundle?)

Call startActivity from the fragment's containing Activity.
Unit
startActivityForResult(intent: Intent, requestCode: Int)

This function is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
Unit
startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?)

This function is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
Unit
startIntentSenderForResult(
    intent: IntentSender,
    requestCode: Int,
    fillInIntent: Intent?,
    flagsMask: Int,
    flagsValues: Int,
    extraFlags: Int,
    options: Bundle?
)

This function is deprecated.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
Unit

Begin postponed transitions after postponeEnterTransition was called.
String
Unit

Prevents a context menu to be shown for the given view.

Inherited properties
From androidx.fragment.app.Fragment
FragmentActivity?
open Boolean
open Boolean
Bundle?
FragmentManager
open Context?
open Any?
open Any?
FragmentManager?
Any?
Int
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
LayoutInflater
open LoaderManager
Fragment?
FragmentManager
open Any?
Resources
Boolean
open Any?
open Any?
open Any?
String?
Fragment?
Int
open Boolean
open View?
open LifecycleOwner
open LiveData<LifecycleOwner>
From androidx.lifecycle.HasDefaultViewModelProviderFactory
open CreationExtras
open ViewModelProvider.Factory
From androidx.lifecycle.LifecycleOwner
open Lifecycle
From androidx.savedstate.SavedStateRegistryOwner
SavedStateRegistry
From androidx.lifecycle.ViewModelStoreOwner
open ViewModelStore

Public companion functions

ComposableFragment

Added in 2.8.0
fun ComposableFragment(fullyQualifiedName: String): ComposableFragment

Creates a new ComposableFragment instance that will wrap the Composable method loaded via reflection from fullyQualifiedName.

Parameters
fullyQualifiedName: String

the fully qualified name of the static, no argument Composable method that this fragment should display. It should be formatted in the format com.example.NameOfFileKt/$MethodName.

Public functions

onCreateView

open fun onCreateView(
    inflater: LayoutInflater,
    container: ViewGroup?,
    savedInstanceState: Bundle?
): View

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null. This will be called between onCreate and onViewCreated.

A default View can be returned by calling Fragment in your constructor. Otherwise, this method returns null.

It is recommended to only inflate the layout in this method and move logic that operates on the returned View to onViewCreated.

If you return a View from here, you will later be called in onDestroyView when the view is being released.

Parameters
inflater: LayoutInflater

The LayoutInflater object that can be used to inflate any views in the fragment,
container: ViewGroup?

If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
savedInstanceState: Bundle?

If non-null, this fragment is being re-constructed from a previous saved state as given here.
Returns
View

Return the View for the fragment's UI, or null.