Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: faq and guide updates #2900

Merged
merged 10 commits into from
Nov 15, 2024
2 changes: 1 addition & 1 deletion modules/applications/applications-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
**** xref:ui-builder/version-control-with-git/resolve-merge-conflicts.adoc[Resolve merge conflicts in Git]
*** xref:ui-builder/how-tos-builder.adoc[Guides]
**** xref:ui-builder/how-to-interact-with-tasks.adoc[How to interact with tasks]
**** xref:ui-builder/how-to-share-data-across-pages.adoc[How to share data across pages]
**** xref:ui-builder/how-to-share-data-across-pages.adoc[How to store and share data across pages]
**** xref:ui-builder/how-to-control-visibility-of-widgets.adoc[How to control visibility of your widgets]
**** xref:ui-builder/how-to-handle-pagination.adoc[How to handle server-side pagination]
**** xref:ui-builder/how-to-create-editable-tables.adoc[How to create editable and powerful Tables]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Two applications cannot share the same slug. To resolve this, you can modify one

====

As you can see on the screenshot above, both UI Designer applications (declared with an `application` tag) and UI Builder applications (declared with an `applicationLink` tag) can coexist on the application descriptor and on the same runtime.

Once your application descriptor is done, don't forget to deploy it by clicking the `deploy` button in the Studio.


Expand Down
5 changes: 5 additions & 0 deletions modules/applications/pages/ui-builder/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ Yes, it is. Reach out to your customer service representative to explore how you

== Features and Technical

=== Can I have applications made with UI Designer and UI Builder coexist on the same runtime?
Yes you can! You will need to declare both kind of applications in the xref:builder-declare-interface-in-bonita.adoc[application descriptor].
However, we do not recommend embedding a UI Designer application inside an iframe widget within a UI Builder application.


=== Are the interfaces made with Bonita UI Builder compatible with platform mode and self-contained applications?
Yes, they are compatible with both deployment modes.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
= How to share data across pages
= How to store and share data across pages
:page-aliases: applications:how-to-share-data-across-pages.adoc
:description: Learn how to send data through you application's pages
:description: Learn how to store and send data through you application's pages

{description}

* Difficulty: beginner
* Prerequisites: have an xref:create-an-interface.adoc[interface created] on Bonita UI Builder
* Estimated time: 5 minutes

== Using query parameters
== Send data using query parameters

Let’s say you want to send parameters to another page using what was typed in a text widget.

Expand All @@ -20,20 +20,23 @@ image:ui-builder/guides/configure-query-params.png[configure-query-params]
The `navigate to` function will redirect to the chosen page. The query params will be passed between the source and the target page's URL: `your-application/target-page/edit?xx=value`


== Using JavaScript objects
== Store data using Store functions

You can also create a JS object to store key-value pairs within the local storage:
The `storeValue()` function stores the data in the browser’s local storage as key-value pairs that represent storage objects and can be later accessed anywhere in the application.

If you want to store the text of an input widget, you can use `storeValue()` as shown below:
[source, JS]
----
export default {
populate_store () {
storeValue('keyName', 'value', true);
return appsmith.store.name;
}
}
{{storeValue('email',input1.text)}}
----

Once done, retrieve data using: `{{appsmith.store.keyName}}` in your queries and other widgets.
Here, `email` is the key where the value is stored, and `input1.text` is the value in the input widget that's saved in the storage object.

Once done, retrieve stored data using `{{appsmith.store.email}}` in your queries and other widgets.

Instead of writing code, you can also store data from the widget's settings, see our xref:how-to-control-visibility-of-widgets.adoc#_using_the_storevalue_function[other guide] for more details.

Please note that you can use the `clearStore()` function which clears all the data that was stored in the local storage of the browser, as well as the `removeValue()` function which clears the value associated with a specified key.
marcobonita marked this conversation as resolved.
Show resolved Hide resolved

For more details, see this https://docs.appsmith.com/reference/appsmith-framework/widget-actions/store-value[dedicated guide].

Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@
Version control in Bonita UI Builder requires a Git hosting service that supports SSH protocol and deploys keys. HTTPS connections are not currently supported.
====

[NOTE]
====
Currently, a remote Git repository can be linked to one UI Builder application only. Of course, you can use multiple repositories to connect to multiple applications.
====

[WARNING]
====
The Git repository must be empty for the connection to be successful.
Expand Down Expand Up @@ -93,4 +98,4 @@ Your application is now connected to your chosen Git provider.

== See also

* xref:applications:git-settings.adoc[Git Settings]
* xref:applications:git-settings.adoc[Git Settings]