Responsive Navigation Block

Description

This Plugin allows you to display and apply alternative styling to different navigation menus based on the screen size using the WordPress Navigation block.

?Video Walkthrough

Features

• Two new Navigation Block (variations) for:
  • Mobile
  • Desktop
• Style your menu differently depending on screen size.
• Use a different menu for each screen size.
• Customize the “breakpoint” (where you switch between mobile and desktop).
• Automatically switch editor to “mobile” preview when editing the mobile navigation.

Usage

This Plugin creates two block variations from the Navigation block which will be automatically hidden/shown at the configured screensize (breakpoint):

• Navigation (Mobile) – will be displayed only on smaller screen sizes.
• Navigation (Desktop) – will be displayed only on larger screen sizes.

This affords the ability to independently style mobile vs desktop navigation and even allows for completely different menus to be used.

The Plugin should be used as follows:

• Install and Activate the plugin – two new block variations will be automatically registered for “Mobile” and “Desktop”.
• Go to the Editor and remove any existing Navigation block.
• Add the “Desktop Navigation” block – style and configure the menu for “desktop” as required.
• Add the “Mobile Navigation” block – style and configure the menu for “mobile” as required.
• View the front of your website and resize your browser to see the navigations swap out at the appropriate breakpoint/screensize.

Alternatively you can transform the default Navigation block to either Mobile or Desktop variations via the block’s interface.

Support

Please see FAQs. If you still have an issue please:

• check Github for existing Issue reports.
• (if none) then file a new Issue on Github

Privacy Statement

Responsive Navigation does not:

• use cookies.
• send data to any third party.
• include any third party resources.

Contributing

Contributions to this Plugin are welcome. Please fork the Github repository and submit a PR for review.

Development Setup

This Plugin uses the @wordpress/scripts package.

• Check out the Github repo into the wp-content/plugins directory of a WordPress installation.
• cd into the Plugin’s directory install the dependencies with npm i.
• Running npm start will start the @wordpress/scripts package in watch mode ready to compile the JavaScript on modification.
• PHP files can be edited in the usual manner.

Testing

The Plugin has e2e test coverage for the key features courtesey of @wordpress/scripts and Playwright.

To run the tests – in your terminal of choice:

• npm run build.
• npm run wp-env start.
• Run the tests: npm run test:e2e

Releasing

Releasing the Plugin to the www.remarpro.com Plugin repo is the prerogative of the Plugin owner (@get_dave). The process is as follows:

Test the Plugin

• Commit all changes to trunk branch.
• Push changes to trunk (only) – git push origin trunk.
• In Github:
  • Actions
  • Select the Build Release Zip action.
  • Select the Run workflow dropdown and run the workflow to generate a zip file.
  • When action completes download the generated Plugin zip artifact.
  • Manually install and test the .zip.

Deploy to WP.org

• When ready to deploy.
• Bump Plugin version and tag release – npm run bump-version.
• Push trunk and tags – git push origin trunk --tags
• Deployment to WP.org will be handled automatically.

Screenshots

FAQ

Why is this plugin necessary?

The built in WordPress Navigation block provides limited control over its display on smaller screens. Whilst efforts are underway to implement solutions to this natively within WordPress they are currently still in development.

Until a solution arrives in WordPress Core, this Plugin exists to provide a workaround solution that requires minimal user configuration.

This Plugin was based upon a technique which I originally documented in my YouTube Video: Use a different MENU on MOBILE with the Navigation block in WORDPRESS block editor.

Can I adjust the breakpoint?

By default, the “breakpoint” at which the mobile navigation will switch to show the desktop navigation is 782px. This aligns with the default configuration of the built in WordPress Navigation block. To change this you can:

• Go to the WP Admin Dashboard.
• Go to Settings -> Responsive Navigation.
• Configure the breakpoint value and the required unit. Save.
• The breakpoint will be adjusted to match your new configuration.

Note that you can use relative units such as em, rem and vw.

Styling of my mobile menu doesn’t work

Due to complications with the way the default WordPress Navigation block works you are advised to use the following settings to control the styling of your mobile navigation:

• Mobile overlay
  • background color – Styles -> Color -> Submenu & overlay background.
  • text color – Styles -> Color -> Submenu & overlay text.
• Mobile menu toggle button (“hamburger”):
  • icon color – Styles -> Color -> Text.
  • background color – Styles -> Color -> Background.

Styles for Desktop Navigation can be applied using the standard controls.

Reviews

Such a needed feature, thank you!

Maggie Cabrera October 10, 2024

Thanks for providing a solution to this common problem, it is very helpful

Contributors & Developers