Examples Overview
Have you seen enough and want some examples to help you get started? Or do you maybe just want to download a sample you can keep as a reference for yourself to base your development on?
We created two sample solutions for you: jigx-samples and jigx-widgets that contain all examples from this documentation (jigx-samples) and a showcase of dozens of widget types (jigx-widgets). There are three options for how you can get access to this solution:
Option 1: Add the jigx-samples or jigx-widgets Quick Start solution to your organization
The easiest way to get the jigx-samples or jigx-widgets solution working on your device is to add the solution to your organization from the Quick Start area in .
Step 1: Find the jigx-samples or jigx-widgets solution in the Quick Start area
- Click on Add to my organization
Step 2: Add the jigx-samples or jigx-widgets solution to your organization
- Keep or change the solution name for your organization. Make sure, that there is no existing solution in your organization with that exact name.
- Make sure, the Include sample data option is checked on
- Click on Verify name at the bottom
- Now click Add
Option 2: Clone jigx-samples or jigx-widgets from GitHub
Follow the steps below to clone the sample projects:
Step 1: Navigating to the Github sample(s)
Wherever you find yourself within the documentation, you will find the Samples on GitHub link located in the top right corner of the page.
To access the repo as a whole, you can click on this link. When you have clicked on this, the jigx-samples repository will open.
Throughout the documented examples section you will also find specific examples relating to Jig types, components, etc. You can also follow the links to open those specific examples. For the purpose of this demonstration, we will guide you on accessing the repo as a whole.
Step 2: Access and copy link to repo
With the repo open, click on the code button to expose the code options.
Here you have the option to access the code via the below links:
- HTTPS
- SSH
- Github CLI
Depending on your setup, you can go to the option that suits your needs best and click on the copy to clipboard icon right next to the link.
Step 3: Creating a folder
Once you have copied the link, create a folder where you would like the samples hosted on the local machine.
Then, right-click on the folder to open Terminal or Windows console directly from the folder. You can also open Terminal / Windows console and manually navigate to the folder.
Step 4: Cloning the repo
When you have opened the terminal / console in the folder as the root, you can start with the cloning process.
Start by typing git clone and then paste the copied link next to it. Once you are done you can press Enter to execute the command.
Once the command has kicked off, you will see a notification stating Cloning into 'jigx-samples'.
Step 5: Finalising the Cloning process
Once the clone command has been concluded, it will be indicated as being completed in the Terminal / Console. You will notice that it will have a done status in numerous areas as well returning the same command line it started out with.
You can now navigate to the folder in Finder (Mac) or Windows Explorer (Windows). You will notice the relevant folders and samples have been cloned there.
The samples folder hosts the main jigx-samples and jigx-widgets solutions.
Step 6: Keeping the samples updated
There are some steps you should occasionally perform in order to ensure that you always have the latest version of the samples to work from.
The easiest way to perform this is as follows:
Step 1: Open the folder where you cloned the solution in VS Code
Step 2: Navigate to the source control section
Step 3: Click on the ellipsis (...) and select Pull to get the latest code from the repository
Alternatively, you can follow the steps below:
Step 1: Open the folder where you cloned the solution in VS Code
Step 2: Navigate to the terminal section
Step 3: Type git pull and enter to run the command
Once you have your sample ready, be sure to check out Setting up your sample solution for instructions on how you can set up this sample.
Option 3: Download jigx-samples or jigx-widgets from Github
To download jigx-samples from GitHub, follow these steps:
Step 1: Navigating to the Github sample(s)
Wherever you find yourself within the documentation, you will find the Samples on GitHub link located in the top right corner of the page.
To access the repo as a whole, you can click on this link. When you have clicked on this, the jigx-samples repository will open.
Throughout the documented examples section, you will also find specific examples relating to Jig types, components, etc. You can also follow the links to open those specific examples. For the purpose of this demonstration, we will guide you on accessing the repo as a whole.
Step 2: Access and download samples
With the repo open, click on the code button to expose the code options.
Click on the Download ZIP folder to download the samples locally.
The folder will download and you can now access the contained folders and samples as you require.
Once you have your sample ready, be sure to check out Setting up your sample solution for instructions on how you can set up this sample.
