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

Add guidelines for developing the frontend of extensions #111

Merged

Conversation

arnaugiralt
Copy link
Member

Added basic guidelines to develop the frontend for extensions.

Also ran the text through a grammar checker and fixed the issues that it caught.

maxipavlovic
maxipavlovic previously approved these changes Feb 6, 2024
irinanic88
irinanic88 previously approved these changes Feb 7, 2024
nerimartinez
nerimartinez previously approved these changes Feb 7, 2024
### Development
In the Connect team, we use [Vue 3](https://vuejs.org/) to develop the frontend for our extensions, but this is not binding; any framework (or even vanilla JS) can be used. Vue 3 is not included in the extensions bootstrapped via the Connect CLI.

We also use the [Connect UI Toolkit](https://github.com/cloudblue/connect-ui-toolkit) library to deal with the communication from the extensions to the Connect Portal, such as requesting data from the Connect Portal, sending events or performing navigation from the extensions to the Connect Portal. This library also exposes multiple web components that can be used in the extensions, such as icons, cards, or navigation components, among others, and other useful tools, and it is included by default in the extensions bootstrapped via the Connect CLI.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe it is a good idea to highlight that the components on the ui toolkit has spa like styles. wdyt?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, makes sense to clarify that

riazhski
riazhski previously approved these changes Feb 7, 2024
@arnaugiralt arnaugiralt force-pushed the adding-guidelines-for-extensions-developing-frontend branch from 7dd81e8 to 07290fa Compare February 7, 2024 09:48
Copy link

sonarcloud bot commented Feb 7, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@arnaugiralt arnaugiralt merged commit 652e28a into master Feb 7, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants