MenuProvider API— Android

Blog Infos

Author

Nav Singh

Published

27. August 2023

Topics

API

Author

Nav Singh

Published

27. August 2023

Topics

API

In this article, we will learn how to use the MenuProvider API to add the Options menu to the toolbar.

Major components

MenuHost
MenuProvider
LifecycleOwner
LifecycleOwner.State

`setHasOptionsMenu()` , onCreateOptionsMenu(), onOptionsItemSelected() — Deprecated 🛑

https://developer.android.com

MenuProvider

It’s an interface that contains four methods

onCreateMenu: Here we inflate the menu for the Options
onMenuItemSelected: Here we handle what happens when the user clicks on one of the items in the Options menu
onPrepareMenu: For customizing menu items, you need to put the code here.
You can, for example, change the visibility of a view or customize the layout of menu items.
onMenuClosed: Its called when the menu is closed

MenuHost

Interface implemented by ComponentActivity, AppCompactActivity which provides us with various methods to control the Menu added using the MenuProvider

It has the following threemethods:

addMenuProvider(): It has three different variants

	// 1. It only takes 1 parameter - [MenuProvider]

	/*
	* We need to manually remove the MenuProvider by calling removeMenuProvider().
	* */
	addMenuProvider(object : MenuProvider {
	override fun onCreateMenu(menu: Menu, menuInflater: MenuInflater) {
	menuInflater.inflate(R.menu.main_menu, menu)
	}
	override fun onMenuItemSelected(menuItem: MenuItem): Boolean {
	return when (menuItem.itemId) {
	R.id.settings -> {
	true
	}
	else -> false
	}
	}
	})

	// 2. It takes 2 parameters - [MenuProvider, LifeCycleOwner]

	/*
	* Adds the given MenuProvider to the MenuHost.
	MenuProvider will be removed once the given LifecycleOwner receives an Lifecycle.Event.ON_DESTROY event.
	* */
	addMenuProvider(object : MenuProvider {
	override fun onCreateMenu(menu: Menu, menuInflater: MenuInflater) {
	menuInflater.inflate(R.menu.main_menu, menu)
	}
	override fun onMenuItemSelected(menuItem: MenuItem): Boolean {
	return when (menuItem.itemId) {
	R.id.settings -> {
	Toast.makeText(this@MainActivity, "Settings...", Toast.LENGTH_SHORT).show()
	true
	}
	else -> false
	}
	}
	}, /lifecycleOwner/ this)


	// 3. It takes 3 parameters - [MenuProvider, LifeCycleOwner, Lifecycle.State]

	/*
	* Adds a MenuProvider to the MenuHost when a given LifecycleOwner reaches a given Lifecycle.State.
	LifecycleOwners will be removed once they reach a lower Lifecycle.State.
	* */
	addMenuProvider(object : MenuProvider {
	override fun onCreateMenu(menu: Menu, menuInflater: MenuInflater) {
	menuInflater.inflate(R.menu.main_menu, menu)
	}
	override fun onMenuItemSelected(menuItem: MenuItem): Boolean {
	return when (menuItem.itemId) {
	R.id.settings -> {
	Toast.makeText(this@MainActivity, "Settings...", Toast.LENGTH_SHORT).show()
	true
	}
	else -> false
	}
	}
	}, /lifecycleOwner/ this, /Lifecycle.State/ Lifecycle.State.RESUMED)

view raw AddMenuProvider-variants.kt hosted with ❤ by GitHub

Adding menu from Activity

addMenuProvider(object : MenuProvider {
    override fun onCreateMenu(menu: Menu, menuInflater: MenuInflater) {
        menuInflater.inflate(R.menu.main_menu, menu)
    }
    override fun onMenuItemSelected(menuItem: MenuItem): Boolean {
        return when (menuItem.itemId) {
            R.id.settings -> {
                Toast.makeText(this@MainActivity, "Settings...", Toast.LENGTH_SHORT).show()
                true
            }
            else -> false
        }
    }
})

Adding menu from Fragment

Job Offers

Writing Maintainable and Readable Tests with MockK Part 5 of 5

APPLY NOW

Design User Authentication System in Android App

APPLY NOW

Mocking Suspend Functions and Flows with MockK Part 4 of 5

APPLY NOW

Job Offers

There are currently no vacancies.

OUR VIDEO RECOMMENDATION

API, Compose, droidcon London

Designing scalable Compose APIs

droidcon

As more and more apps and teams migrate to Compose, it’s important to establish clear guidelines for writing high-quality Compose code.

Watch Video

Designing scalable Compose APIs

Simona Milanovic

Android Developer Relations Engineer

Google

Designing scalable Compose APIs

Simona Milanovic

Android Developer Re ...

Google

Designing scalable Compose APIs

Simona Milanovic

Android Developer Relatio ...

Google

Jobs

Lincolnshire, Illinois, United States, Holtsville, New York, United States

Marketing Developer, II

Full Time

APPLY NOW

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)
    // Add options menu to the toolbar
    requireActivity().addMenuProvider(object : MenuProvider {
        override fun onCreateMenu(menu: Menu, menuInflater: MenuInflater) {
            menuInflater.inflate(R.menu.main_menu, menu)
        }
        override fun onMenuItemSelected(menuItem: MenuItem): Boolean {
            return when (menuItem.itemId) {
                R.id.settings -> {
                    true
                }
                else -> false
            }
        }
    }, viewLifecycleOwner)
}