Superfish for Drupal 8

Hey there,

Thank you for this :) but I've ported it to D8 already; a beta will be available right after API freeze (i.e. D8 RC1), and it's much more than just porting to D8, comes with new features, new SF library, etc.
thanks again, much appreciated.

@mehrpadin, could you please post what you've ported to a dev release? I REALLY want to be using and testing this at this point so I would like to have access to your work.

@mehrpadin - yes a dev would be nice to test ...

Hey everybody,

I will very soon! sorry for keep you all waiting :)

Please add 8 dev version - i think that i am not only one who will help testing.

I will definitely help test the D8 module as soon as it becomes available. For a new D8rc2 site I will have to set up on Nice Menus, but Superfish looks much more promising & would switch to it ASAP. Question: is there any update to this pledge relative to the full release date announcement of November 19, 2015?

If you need a menu that works today, then Ultimenu is your best bet. It can be configured through UI, and the only coding you need to do is some CSS (see the README) and (optionally) adding regions to your themes .info.yml.

I am not affiliated with the project. But after much research it's the most functional of the "mega menus" for D8.

That said, I will be excited to see a Superfish for Drupal 8.

Hey there! :)

I'm so sorry! been terribly terribly busy with commercial projects all the past few years, but I'm here now! :) and I'll commit the D8 version very soon! indeed before Nov 19th :)

Viva Drupal 8!

@mehrpadin, may we expect any progress til the ufficial D8 release date? would be happy!

Sorry for keeping you all waiting, terribly busy, committed what I've, please try it and let me know what do youse think :)

Also please note, Superfish library 2.x branch should be used.

PS: I have "retired" some features in favor of CSS3 alternatives (e.g. pseudo-elements etc) if anybody has any good reason I can port them too, will provide a list plus reasons soon in the documentation.

@mehrpadin You may want to consider changing your master branch in GH repo settings.

Also please note, Superfish library 2.x branch should be used.

It looks like its on drupal.org too, thanks.

Thanks for porting the module! I've installed it on a testsite, and generally it works quite fine, but I noticed two problems.

(On drupal.org/node/add/project-issue/superfish I was advised to report issues related to Drupal 8 in this thread.)

(1) Status report

Location: admin/reports/status

It appears the following message:

Not supported
The Superfish library requires an update. You can find the update instructions on %url.

Regarding the version, superfish.install, line 40 should be changed:

- if (superfish_library_version() != '1.2-beta2') {
+ if (superfish_library_version() != '2.0') {

Regarding the missing %url value, I don't have a solution.

(2) SF-Smallscreen Plugin vs. window width

Location: admin/structure/block/manage/MY-SUPERFISH-BLOCK > Superfish Plugins > SF-Smallscreen > Enable jQuery sf-Smallscreen plugin for this menu depending on the user's Web browser window width. (Standard)

I inserted a value for the window width, but Superfish doesn't save the value. The field remains empty after saving. While the plugin works generally, it doesn't work in this case.

@dpi I'll update it soon, thanks!

@Olafski Thanks for reporting these, fixed them, please keep testing! :)

Details: lines #15 and 17 of superfish.install say "Black layout" not "Block layout"

Thanks for reporting this! corrected.

For some reason at admin/config/user-interface/superfish I only have the option to set the Path to Superfish library. There is no option for the number of blocks to create. Drupal 8 RC4.

That's right, you can now add as many as you want through Structure > Block layout > Place block, just like the Menu Block module.

@mehrpadin, thanks again! As I saw, the errors mentioned in #13 are fixed. Tested with superfish 8.x-1.0-rc1.

On admin/reports/dblog there are four PHP notices:

Undefined index: cloned_parent in template_preprocess_superfish_menu_items() (line 138 of MY-SITE/modules/superfish/superfish.theme.inc).
Undefined variable: multicolumn_wrapper in template_preprocess_superfish_menu_items() (line 251 of MY-SITE/modules/superfish/superfish.theme.inc).
Undefined variable: multicolumn_content in template_preprocess_superfish_menu_items() (line 252 of MY-SITE/modules/superfish/superfish.theme.inc).
Undefined variable: multicolumn_column in template_preprocess_superfish_menu_items() (line 254 of MY-SITE/modules/superfish/superfish.theme.inc).

Test environment:

• Drupal 8.0.0-rc4
• Superfish 8.x-1.0-rc1
• PHP 5.6.13

Sorry, another one: On my test site, the custom accordion menu title doesn't work. When I fill in a custom title under SF-Smallscreen > Accordion settings, the toggle caption on small screen remains the default value (block title).

WOW! there's always something to miss! thank you for reporting these! updated and had to create RC2 also as they are important bugs. Please keep testing! thanks! :)

Issue with the "Path to Superfish library". Looks as the edited paths are not being accessed by the superfish module. Example: Source shows localhost/modules/superfish/../../sites/all/libraries/superfish/superfish.js I have it changed in admin to libraries/superfish/superfish.js as I put my libraries folder on the same level as the modules and themes directories.

I moved libraries directory to sites/all/libraries and solved my problem, but for some reason disabled menu items are displayed. In a normal menu block the same items are not displayed. Using the latest dev version here.

Edit: For now just deleting those menu items works. I think in Superfish 7 the disabled setting was honored.
Other than these trivial issues it's working fine.

Thank you for fixing! #20 and #21 are OK now in the following environment.

• Drupal: 8.0.0
• Superfish 8.x-1.0-rc2
• PHP 5.6.13

(And, I can confirm #23 and #24.)

Missing active-trail class

While I see some relevant code, e.g. in superfish.theme.inc, Superfish doesn't seem to generate active-trail classes. Should the class be set in templates/superfish-menu-items.html.twig? If yes, is it missing there intentionally? And/or do you have an advice how to set the mentioned class in the template file?

Is there a reason why all D8 issues are being dumped in this thread now that there is a tag to file against?

I think followers of this issue are interested only in Drupal 8 work at a high level. Rather than individual issues.

Library Path
@mermentau Thank you, I've just removed the settings page altogether, I'll remove the "Library Path" option from the D7 as well, if anybody is curious why: not only has the way Drupal handles JavaScript (and CSS) changed completely and as a result loading JS and CSS the old D7 way becoming impossible (or at least I couldn't figure out how) but also back then when I added that "Library Path" option there was no way - or I didn't know one - to prevent for example jQuery hoverIntent used by another module from being loaded, twice on the same page and so on, that's why that option came to exist, to allow site developers decide what JavaScript file this module should load and so on, but now that there is a way to figure that out, that option only causes trouble, especially during module upgrades.

Disabled links
I couldn't reproduce it, works for me, even with cache.

active-trail
@olafski Thank you! I think I've fixed it (dev), I'm sure I've yet to figure out how exactly active trail works on D8!

This issue
@dpi Thanks, you're right, maybe we should create another ticket for the pre-stable period but having one ticket per bug/problem before the 1.0 stable is not a good idea.

Thank you all! please keep testing!

The library paths work on localhost xampp, but not on live site. Check my Mayo theme demo site and do view source for the urls to the library files. Also notice the main menu (horizontal) which is a superfish block. Most of those links are disabled in menu settings. The last 6 are disabled.

This gives me a 404 http://drupal8.balnu.com/sites/all/libraries/superfish/superfish.js

For the disabled links, could you please email me admin credentials?

My bad on the libraries. I forgot in my haste installing the superfish libraries. I'll email you access account info.

Thanks, just checked, you're right they are disabled yet included, it's strange!

I'm placing this here, but I can not vouch for the matter. I upgraded my Superfish module using drush 8.0.0. Afterwards, I've been met with these errors:

Invalid placeholder: !default FormattableMarkup.php:240 [error] (this repeats 51 times)
Invalid placeholder: !fields FormattableMarkup.php:240 [error] (once)
Invalid placeholder: !other FormattableMarkup.php:240 [error] (repeats 33 times)
Invalid placeholder: !type FormattableMarkup.php:240 [error] (repeats 8 times)

I'm "starting over" on a fresh install, and using migrate for the content, since I'm still in the early phases. Superfish is the only non-core module I'm using now. On the fresh D8/Superfish RC2 site, I do not see these errors. If warranted I can make this it's own ticket.

active-trail, @mehrpadin: I've updated to 8.x-1.0-rc2+1-dev and cleared cache but still see no active-trail class.

Invalid placeholder, @Screenack: The errors seem to be a Drush issue, see Update rc3 to rc4 fails and https://github.com/drush-ops/drush/issues/1739.

@Olafski — I googled the matter yesterday, but I failed to mention here that I upgraded Drush to stable 8.x prior to upgrading superfish, (no invalid placeholder errors) so I do not believe drush is the culprit.

@Olafski, There was a commit late yesterday. active-trail seems to be working here.

@mermentau, thank you! On https://www.drupal.org/node/2617602 I read "Last updated: November 21, 2015 - 17:23". Is there another place to get the release including the mentioned commit?

@Olafsi, I see what you are talking about, but under the commits you can see 3 on the 21st. I pulled it with git.

FYI: I've reloaded my site into a "fresh" Drupal 8 core + Superfish 8-rc-2 and I no longer see the invalid placeholder error messages. Sorry for the noise.

active-trail works with the version mentioned by mermentau, nice!

One suggestion: While Superfish seems to provide the active-trail class only to items which are menu parents, Drupal's Classy theme provides menu-item--active-trail also to 'active' menu items, which don't have children. (Additionally, it provides the class is-active to the link.) I would very much appreciate the Drupal/Classy behaviour in Superfish, is that possible? It would simplify the styling of active menu items a lot.

(Just a quick note before I make some time and respond: The 8.x development snapshot has the latest commits, RC2 is a little behind.)

@Msbuv: You don't have to put it in /sites/all, use the "Libraries API" module, put it anywhere you want, it'll find it :)

@Olafski: I'll check Classy soon and let you know.

@Screenack & @mermentau Thank you very much pals!

@Msbuv: You don't have to put it in /sites/all, use the "Libraries API" module, put it anywhere you want, it'll find it :)

I couldn't get it to work like this with the Libraries API. It worked for me using the attached patch and the library files in /libraries/superfish.

Sorry @mehrpadin, my statement in #41 regarding the active-trail provided only to menu parents was made erroneously. Instead of that, Superfish provides the class also to 'active' menu items without children. I must have overlooked it in the first moment! As I don't need the link class is-active for now, I'm fine with the current state.

(I however tried to explore how the menu is themed in Classy. While I couldn't find the is-active part there, the menu-item--active-trail part in classy/templates/navigation/menu.html.twig seems quite straightforward.)

Shows disabled Home link: Thanks for getting this module ready to go; really appreciated. Using version 8.x-1.0-rc2+1-dev (re: the above discussion, I believe the most recent?) and core 8.0.0.

Problem: Superfish "Main navigation" block shows all my <Main navigation> menu links, but still shows the default Home link even though I have it marked disabled in /admin/structure/menu/manage/main.

I am able to work around the problem by removing the Home link from its default position to a non-public-facing menu like <Development>. Please let me know if there is something I am missing.

Contextual links: In my environment, in contrast to a standard Drupal menu block, Superfish doesn't display the "Edit menu" link in the contextual links area but only the "Configure block" link.

I found the following page on the topic, hope it's helpful: Providing module-defined contextual links

Can't reorder submenu links: as far as I can tell, the "Main navigation" module of Superfish ignores the menu weights in a second level menu. I have recreated this menu a couple of times, and no matter what I do it only displays menu items in the same order that the menu links were created.

I tried a number of cases: creating them in a different menu & moving them in, creating some with manually set weights and some with default weight 0, with all the same result. Setting weights manually & dragging and dropping in the Menu interface, clearing all / menu caches from D8 or drush: no effect.

I have not yet tried to fix the problem by uninstalling & reinstalling Superfish, but will probably have to do that soon to clean up the menu in a new site build & will post that result when I do.

@rphair

Any luck with this? I'm having the same issue.

@lukejoliat: I can see you have posted https://www.drupal.org/node/2627460 (I am inclined to agree with @dpi in #27 about using the issue queue but I am respecting the developer's wishes). In that posting @mermentau suggests the problem is in the core menu module.

I would tend to agree since I've uninstalled the Superfish module, which would have deleted everything in its own database, and reinstalled it (8.x-1.0-rc2+1-dev) and it still has the menu links in creation order rather than the menu order shown in the UI.

The implication is that this isn't a Superfish problem. Unfortunately I can't get Expanded Menus to show even when those boxes are ticked (maybe that's a related problem), so I still don't have evidence against the menu module itself. My only workaround so far is to delete & recreate submenus in the desired order.

@rphair: I don't agree that the problem of reordering submenu items is the core menu module. If I use an additional menu provided by core, there the custom submenu order is fine. (To get expanded menu items to show, I changed my CSS, but depends on the theme, I guess.)

Dear module maintainers, do you have any idea or suggestions what to do regarding the ordering of sub menu items?

Submenu order issue also happened to me. Reinstalled module, same thing. One thing to note though is that my menus were from a D6 to D8 migration. If not using module block, order is fine. I redid the menu manually and order then worked.

I'm using last version of Drupal 8 with Bootstrap theme and I've installed correctly Superfish module. I see it in the superfish blocks and I'm able to add them but unfortunatelly, superfish.css is not loaded. Could you please help me or tell me any hint I can check?

Thank you
Regards

Please create a new issue. Do not hijack existing issues.

Title cleanup now that release has passed.

Sorry DPI, I will consider it for the next one because after several hours of investigation I found that there were a problem on superfish.libraries.yml and how the path of js & css libraries are parsed. I've just added a "../../" characters by just "/" and now everything is working as expected. Thank you. Regards

Had the same issue as #44 and #56. Raised a new issue #2638598: Superfish libraries.yml definition assumes it will be always be installed in /modules folder with a simpler patch attached, even though I think #44 is the right way to go since sites/all/libraries in D8 would be an anomaly.

Hey everybody,

Updated the development release just now, the disabled links and link order issues should be fixed, please test and let me know, time for a new RC, thanks.

Looks good on my test. Disabled links, link order, and /libraries path all OK.

Great, thanks for testing!
Note: haven't changed the /libraries, it's in my to-do list.

Note: haven't changed the /libraries, it's in my to-do list.

OK I see my patch #44 wasn't overridden with the git pull.

@mehrpadin: Sorry my late answer: I tested version 8.x-1.0-rc2+5-dev in two environments. Unfortunately, the link order in sub menus issue is not fixed there. If I change the link order of second level menu items in admin/structure/menu/manage/main, the order in the frontend menu doesn't reflect these changes, even when I clear the cache several times.

@mermentau: Do you have a different environment? (I tested with Drupal core 8.0.1 and Bartik.)

@Olafski, I test with Drupal core 8.0.1 and Mayo theme. I have a live demo here and then the same set up on xampp localhost. In the live site I just reversed the 2 children of the "crawroc" menu parent and it worked fine.

Link order in sub menus: Now I see, that the issue is fixed, but at the time being only in the Git version of the module. Interestingly, the fix does not appear in version 8.x-1.0-rc2+5-dev of December 22nd, that's why it wasn't fixed in my environments.

Thank you all, and happy new year!

I am not sure if this the correct place to put this but I am trying to make superfish work.
I have tried the newsflah and mayo theme and I can not get the drop down to work
I have install the Superfish-for-Drupal-2.x in /libraries/superfish and I have installed the
superfish module /module/contrib/superfish

I have followed this https://www.drupal.org/node/1125896 to configure my superfish

It shows the menu and the submenus all the time. Like a list of items

#63 his link shows a site running mayo and his drop down works, arghhhhhh

What am I missing to make the superfish work as a drop down menu?

I've got the same issue, expanded menus all the time, etc. and can't seem to make anything work.

Item 4 of the Drupal 8 installation instructions says "... use any of the 'Place block' buttons to create a Superfish block."
I click on the a "Place Block" button but then I cannot see how to create a Superfish block. What do I do? Am I missing something obvious?

I had missed the obvious ... there are several Superfish block types available. Their names are not obvious ... look in the block type column to see which ones are available.

I fixed by editing the superfish.libraries.yml and removing the '../..' from the paths
and making sure that it pointed to /sites/all/libraries

Thanks to to in the #drupal-support IRC channel.

Will the D8 superfish have responsive RTL menus?

Any update on the sub-menu weight order block issue?

Is the only solution to delete existing menu items and redo from scratch?

Yes, I'd be interested in hearing the status on the weight issue as well.

Here is a little patch for adding 'first, middle, last' classes to 'li' items.
The option was available on the D7 port of the module and I've missed them.
The patch is based on the current 8.x-1.x-dev version.

The option can be enabled on the block configuration.
Perhaps it will help some of you.
- no warranty - ;)

My superfish menu is not following the weight rules at all.

It seems that it is following a chronological rule where
the last menu to be added is the one that displays last

Sub-menu weight order issue: As I noticed in #64, the issue is fixed, but up to now the fix doesn't appear in the drupal.org versions of the module, neither 8.x-1.0-rc2 nor 8.x-1.x-dev of 2015-Dec-22. You can get the fixed version via Git (see link in #64).

@mehrpadin: Can you include the last fixes from the Git version into the version hosted on drupal.org? That would be very helpful, and I guess this issue could be closed afterwards, as the most of the last reports relate to sub-menu weight. What do you think about it?

@quindio: Up to now, the weight order issue was reported to appear in sub-menus (second-level menu items). When you speak of "weight rules at all", do you intend also first-level menu items?

Hmmm sorry I think something went wrong with my comment and the attatched patch.
superfish-addingHelperClasses-2123317-72.patch
The patch brings back the option for adding
first, middle, last classes to li items.
Its portet from D7 Superfish with minor changes.
Maybe it helps some of you.

I hope this time the comment is shown.

Btw.: The Git version with the fixed weight order issue works for me.

Yes, the submenu weight is not enforced.

I am sorry but how do I apply the patch to my current version?
or
how do I download the git version?

I believe you are talking about this:
http://cgit.drupalcode.org/superfish/tree/

Thanks,

@quindio, there are other approaches, but I cloned the Git repository locally via command line and uploaded it to the remote server. Unfortunately I don't remember which URL I used and don't find relevant documentation. (Does anyone know which URL to use?)

First - Please excuse my bad English. ;)
To clone the Git repository:

git clone --branch 8.x-1.x git://git.drupal.org/project/superfish.git

Using patches:

From Drupals official applying patches guide:
Warning: Patching is something that should never be done on your production site unless you first have a complete backup of your site, and you have tested that backup: First. While patching itself is relatively easy, understanding the implications of a patch is not. Patching your system can lead to loss of data and/or site instabilities.

1. go to the module base folder
2. get the patch via wget or something like that
3. apply the patch

For me it is:

cd modules/contrib/superfish
wget https://www.drupal.org/SOME-URL-PATH/XYZ.patch
patch -p1 --dry-run < XYZ.patch
patch -p1 < XYZ.patch

The third line with --dry-run option is optional. It validates the Patch without Applying (Dry-run Patch File). If any error occurred, don't use the patch, if you are not exactly know what to do.
Fourth line simply applies the patch.
If you are receive information from --dry-run like below, it indicates that there are some lines of offset. This is mostly harmless.

Hunk #1 succeeded at 96 (offset 4 lines).
Hunk #2 succeeded at 153 (offset 7 lines).

To undo / reverse a patch use:

patch -p1 -R < XZY.patch

Click for more about patches

Hope it helps!

I just installed Superfish 8.x-1.0-rc2 on Dupal 8.0.5. I don't see the superfish block on list when I tried to place a block.

Do you have cleared the cache?

@priyanka12chavan

You'll need to click place block, and then search for Category "Superfish". The Superfish Menu names are the same as the Drupal core menu items.

sideswitch, Thank you for the screenshot; however, I'm not seeing the Category "Superfish" anywhere. Any thoughts? I have the module installed correctly and the superfish library installed correctly, as far as I can tell.

(edit) - Never mind -- I figured it out! Thank you again for posting that screenshot :)

Dear maintainers, I'm still missing the important fixes of the module which appear on http://cgit.drupalcode.org/superfish but not in 8.x-1.0-rc2+5-dev of 2015-12-22 hosted on the project page, see my comments #64 and #76.

Is there any reason to not update the Dev version?

I'd prefer to use the version hosted on the project page because the Git version is lacking the "Information added by Drupal.org packaging script" in the .info.yml file and doesn't appear on the page admin/reports/updates. (Actually, I don't know if that is the regular behaviour when you use modules without packaging script.)

After 5 months since last maintainer input this module is starting to feel abandoned.

Hi,
i noticed that superfish.libraries.yml searchs for libraries in sites/all/libraries
actually in the Drupal 8 the new standard place for libraries is /libraries (like /modules instead of Drupal 7 sites/all/modules and /themes instead of Drupal 7 sites/all/themes)

Here is a patch to fix that.

Thanks

Here is a better patch than #88 (more replacements of sites/all to be accurate with new Drupal 8 standars)

oups,
Here is the correct patch

@izus new issue please.

ok dpi

Closing this since the module has a stable Drupal 8 branch.

If the maintainer wishes to inform the ~30 followers of general news for this module, he can re-open.

@dpi, perhaps this issue (Superfish for Drupal 8) should be left open until the current Dev and RC version are ready for production.

It seems to me that in order to effectively use the Superfish module in production, at minimum one needs a patched version of the Dev module so closing this as fixed is a bit premature.

Full disclosure, I'm using a patched version of Superfish in several production D8 sites and have been for about 6 months but would like to have something more stable.

Andrew

at minimum one needs a patched version [...] I'm using a patched version of Superfish

Perhaps this information is better suited to a new or existing issue. If this issue remains open then your insight will become buried over time.

The module maintainer has been away from d.o for some time now, has anyone attempted to contact him?

Does anyone want to commit to becoming [a co/the]maintainer

I just sent him a contact message. This module isn't my main area of interest but I'll do what I can to help out. It looks to me like the module has a lot of interest from the community so it's probably going to be about 80% administering the issues and fixes to get it on track with D8.

Hi! I'm using superfish-8.x-1.0-rc5 I'm not able to see the menu parent option in the configuration of the superfish block. Not sure about posting this here .... sorry.

Hi ! I am using 8.x-1.0-rc6 in a Bootstrap theme.

I have Site branding in Region Navigation and User Menu and Main Menu (superfish) in Region Navigation(Collapsible).

Main Menu is working but I cannot click on User Menu, Site logo or Sitename. I see them but not clickable.

If I move Main Menu to another Region everything is working but if I move User Menu there too that one is not working.

Is this a problem with Superfish or a problem with Bootstrap?