[Add new funcionalities to Kura Web UI]

[alexcorvis84]

I would like to try to add new functionalities to the Kura Web User Interface. I am thinking for example in a new option under System... is this possible? where could I start to check in the source code some references that I could use as examples/guide?

Not sure, but maybe the best approach I'm proposing... would be to create that new functionality under Services, as a configurable component? 🤔

I followed the Configurable Application tutorial and managed to run the configurable component example...

P.S. I think I found an error in the documentation under Create Component Class step.

“After the Component class has been created, it will open in the Workspace. On the Services tab, click the Add button under Provided Services. Enter “configurable” and select the interface “org.eclipse.kura.example.configurable”. This is required for components that are configurable through the Kura ConfigurationService, so that they expose a Service”.

However as I have checked and tested, the interface to be configured should be “org.eclipse.kura.configuration.ConfigurableComponent” and not “org.eclipse.kura.example.configurable” as mentioned.

Thanks in advance.

Regards

[alexcorvis84]

I continued my research and found among the examples, the project org.eclipse.kura.web2.ext.

I was able to compile and run it, and I think it is what I was looking for... The problem is that I can't find any further documentation on it, on how to add for example, more elements to the same addSidenavComponent

If you could please give me some references to continue with this type of development, I would appreciate it.

Thanks in advance!

[mattdibi]

Hello there @alexcorvis84,

May I ask you what you're trying to achieve? What's your end goal? That would help us provide you better informations.

At the high level what you're doing is correct: to add new features under "System" you'll need to change the web2 sources. Those elements are hardcoded in the UI codebase as opposed to "Configurable Component" which are more flexible and meant to extend the Kura UI.

Regarding documentation there's not much on how to do that. You can look at the sources of the other "System" components and see what they do. Additionally take a look at the GWT documentation

[alexcorvis84]

Hi @mattdibi ,

My goals are start with something basic (i.e: add a new panel with a button to restart Kura). Then I'd like to move forward with sth more complicated, i.e: add a new panel with the possibility of adding charts.

Meanwhile, I'm trying to compile the org.eclipse.kura.web2.ext isolated without success. Seems it inherits components from other parent? (I'm not an expert in maven...I'm learning by testing, and this is what I have found by investigating the errors encountered)

So, my first question is, how can I compile (isolate) the (new) project with the necessary components so that it can be isolated from the kura source project? is it possible?

Thank you in advance!

[salvatore-coppola]

Hi @alexcorvis84, starting with Kura 6.0.0 we will remove the `web2.extU module.
If you want to customise the web ui, I suggest you work directly on the web2 module source.
I would like to warn you that the current webui will be deprecated and removed in the future.

[alexcorvis84]

Hi @alexcorvis84, starting with Kura 6.0.0 we will remove the `web2.extU module. If you want to customise the web ui, I suggest you work directly on the web2 module source. I would like to warn you that the current webui will be deprecated and removed in the future.

HI @salvatore-coppola,

Thanks for the notice.

I take the opportunity to ask, is it due to any reason? Will the kura UI be updated/moved away from GWT to a new modern UI framework in next 6.0.0 release? 🤔 Is there ETA of first release 6.0.0 RC?

Thank you so much in advance.

[salvatore-coppola]

Well, at the moment they don't have a fixed schedule for a new webui, but it's something that will come sooner or later :)

The ETA for Kura 6.0.0 RC is probably end of the month