Extension settings

Konstantin007

Hello to everyone! Is there any guidance about how to create modal form for extension settings? Tryed code according existing extensions (like twitter auth) but on extensions page there is no "settings" dropdown button. Thanks! Link: https://github.com/Konstantin007/flarum-wordpress-auth

luceos

I've been out of practice for a while, but I guess you're missing a Gulpfile amongst others:

https://github.com/flagrow/flarum-ext-analytics/blob/master/js/admin/Gulpfile.js

That's how we implemented it previously ? The gulpfile defines the namespace for your javascript code.

Konstantin007

luceos Yeah? Gulpfile was in js/admin/ directory, I just not push it. All namespaces are fine. Infact, if I call "app.extensionSettings'arma-auth-wp'" from browser console, my settings modal will appear. For some reason dropdown button not appear under my extension. This is strange? In many extensions there is "scripts directory" with some compile.sh. What is its purpose?

luceos

Konstantin007 the compile.sh is used to create a dist file for js, which generates the extension.js. Seems you already have that. Did you re-enable any random extension to flush cache already?

vivex

Konstantin007 I am facing same issue as yours, calling the method from browser console pops up the setting page, but its not happening automatically (when user enables extension). You found any solution ?

Toby

vivex There was a relevant bug fixed in beta 6:

Fix settings not automatically showing when an extension is enabled.

vivex

Toby i am using v0.1.0-beta.6 only. still facing this issue, i am new to flarum extension, maybe did some configuration mistake or something.

tankerkiller125

I've also run into this issue. A close look at the console app.extensionSettings and then looking the object for my extension it seems that the caller part of the object created doesn't work giving the following issue. TypeError: 'caller' and 'arguments' are restricted function properties and cannot be accessed in this context. at Function.remoteFunction (<anonymous>:3:26) anyone have an idea as to why this might be?
(BTW I used the GitHub authenticator as a template)

jitinp

hey @Konstantin007 @vivex were you able to find solution for this? Even I am facing a similar issue.

jitinp

@luceos I tried replicating Flarum's Facebook Auth extension in Workbench and still facing the same issue. I made sure Gulp and main files point to the correct path. Still I don't see the Modal window.

Can you help me understand if I am missing something? Here's the replicated codebase - https://github.com/jitinp/facebook-extension-main

Thanks in advance!

Kyrne

jitinp did you run "gulp"? Those files don't do anything on their own.

jordanjay29

jitinp Btw, looks like you uploaded all the node_modules src to your repository. Consider making a .gitignore file to avoid this, it will use up space that you don't need to waste.

jitinp

Kyrne Yes I did.

jitinp

jordanjay29 ah yes! My bad. Thanks for bringing this to my notice

jitinp

Hey guys, still no luck with this ?
Any ideas?

Kyrne

jitinp In your main.js change

app.extensionSettings['flarum-auth-facebook']

app.extensionSettings['blitzz-jitin-ext-main-facebook']

jitinp

Kyrne Thank you so much! Its working perfectly now.

riverlet

Finally, I found the solution after struggling for the whole day:

just make sure

app.extensionSettings['HERE-IS-YOUR-EXTENSION-ID']

you can find your EXTENSION-ID in the extensions_enabled column of your settings table.

in my extension's composer.json, the package name is "riverlet/flarum-ext-sso" ， but the EXTENSION-ID is riverlet-sso in flarum. a little weird.

cljk

riverlet OMG ... thank you(!)
Thought I was too stupid to find my mistake.... I used the wrong identifier.

My project is (in composer) "vgb/flarum-misc-adaptions" and in the Gulpfile it´s the same.... the system made up the id "vgb-misc-adaptions" .... how could I know that?!

Should be documentended somewhere?

€dit:
Perhaps it´s stripping out package-names beginning with "flarum-" ???

clarkwinkelmann

The Flarum convention is to name composer packages vendor/flarum-ext-package, vendor/flarum-package or vendor/package. The string flarum-ext- or flarum- is removed to get the package ID. These 3 examples would result in the package ID vendor-package.

cljk Should be documentended somewhere?

Unortunately most of Flarum is still left undocumented. But a quick look at the code often answers the questions. For example the code responsible for the package ID is here https://github.com/flarum/core/blob/v0.1.0-beta.7.1/src/Extension/Extension.php#L101

cljk

clarkwinkelmann This explains everything ;-)