iviva UI Sandbox Sync README
This extension lets users who have created/using a UI sandbox from iviva dashboard, to write code in Visual Studio Code and sync the changes with the remote view. This helps users to see the preview fullscreen, without having the web code editor blocking it.
Features
The extension allows you to handle multiple simultaneous sync. So, if you have 5 UI's that you are working on, you can live sync with 5 different tabs.
Requirements
This assumes that you know what iviva & Visual Studio Code is and are familiar working with it.
Usage
- To initialise the extension, from an active tab select
iviva: Start Sync command from the command palette or right click the tab header and choose the same (should be at the bottom)
- Once initialized, you will be asked to provide a Unique ID, you can get that ID from the save menu in the UI sandbox web page
- To stop the extension, from an active tab select
iviva: Stop Sync command from the command palette or right click the tab header and choose the same (should be at the bottom)
Note
- For tabs that are in sync, there is a status bar item visible which shows the sync status like,
- Active - if you've just started sync
- Synching - if a sync is in progress (after a file save)
- Synched - if sync is completed
- Not Synched - if there were any errors during the sync
- Same file can't be synched if it already is. For ex: if ui.xml is in sync, you can't sync the same again
- Same Unique ID can't be used if it already is. For ex: if asdf-asdfb-123-asdf is being used to track ui.xml, then it can't be used again
- Now you can now provide a Unique ID in the following ways,
Extension Settings
This extension contributes the following settings under title iviva Sync Configuration. You can find them either in User/Workspace settings.
iviva.remote.url: Remote url to sync the changes toiviva.remote.apikey: Api key to be used for authentication
To help you configure the settings, follow the instructions.
- There will be a single entry when you choose iviva Sync Configuration from the settings - iviva: Remote
- Click on Edit in settings.json
- Then, you should see
"iviva.remote": {}
- Click on the edit icon and choose Copy to Settings. Note: If the setting is already present, then you will see Replace in Settings instead
- In the settings editor, within
{} from iviva.remote key, fill the values for properties url and apikey
Once done, your final setting should look like the following,
"iviva.remote": {
"url": "http://testaccount.ivivacloud.com/api/System/SandboxUIView/TempUpdate",
"apikey": "SC:testaccount:f7f432287f3c613a"
}
If you still have troubles setting it up, the internet is always there to help you out.
Known Issues
No issues identified so far.
Release Notes
1.0.0
Initial release of the extension.
1.1.0
- Ability to provide Unique ID as
URL or Hash
Enjoy!
