Widget Sample
Path: alkami.sdk.samples/Widgets
Each of the sample widgets are name spaced as “Sample.Client.Widget.[Name]” and will deploy to the C:\Orb\WebClient\Areas directory as “Sample[Name]“.
The widgets are ready to go out of the box, build each project to deploy the content and libraries to the ORB folder.
Microservice Integrated Widgets - These projects are paired with the above Microservice, it demonstrates an end to end integration with a custom microservice.
| Widget | Description |
|---|---|
| Accounts | The Accounts widget is integrated with two microservices, Security and Accounts, and will demonstrate how to fetch account information. |
| Caching | The subject of a webinar on July 24th, 2019, this widget will show how to use Alkami’s ICache and SessionCache features to create a performant web experience. |
| Exchange Rates | Exchange Rates are fetched using an integrated microservice and displayed on the screen, demonstrating how to fetch data from a provider based service. |
| Get Settings | Configurable settings are really useful and can be self served from the Admin portal, this widget will read from an integrated provider based service |
| View Documents | Need to display a PDF or other document type? This widget will show how to render a PDF in the browser window |
| Web Fetch | Another widget that demonstrates reaching the world wide web and returning content to the browser using an integrated sample microservice |
| Change Address | An introductory widget that recreates the functionality found in the Alkami Settings widget. Presents a simple form and allows the user to change their address. This does use UserContacts microservice to retrieve as well as add/update an address. |
Standalone Widgets - These projects are standalone can be installed without any dependent MicroService.
| Widget | Description |
|---|---|
| Before Login | Not all widgets require authentication, if that’s the case then you can see how to make a widget available before a user logs into the platform. |
| Custom CSS and JS | Sometimes it’s necessary to use custom CSS and JavaScript, we have created patterns for these front end assets and have demonstrated how best to configure and use your custom CSS/JS |
| Dashboard Module | Alkami’s Dashboard v2 can render a partial view of another widget on it’s landing page. This is helpful when users need a quick view of partial data without navigating to the widget itself. |
| Disclosure | Disclosure forms are managed and edited in the Admin Portal. This widget will show how to display and require the user to click past a disclosure they have not seen before. |
| File Upload | Uploading files in Alkami’s platform is restricted to a certain very small file size. We’ll use JavaScript to post file chunks and then reassemble the file for use within the widget’s controller |
| Interstitial Page | It’s possible to show a click through page, or interstitial page, when a user first logs into the site. This is helpful for marketing campaigns or requiring an action from the user before they can begin using the platform |
| Mobi Nav | The mobile navigation window is a little different than the traditional desktop list of icons and links. Learn more about how to make the mobile navigation menu work for you. |
| OAuth | It may be preferable to use OAuth when talking to a third party vendor, we have an example on how to implement that pattern using Alkami’s system |
| Secure Message | The secure message system is great for collecting user input, problems with features or secure data. Send a secure message from your widget so that admin users can address communications from your SDK widget. # |
| Send An Email | Using an SMTP server with Alkami is easy and not difficult to setup locally. |
| Site Text | Alkami has a configurable, accessibility enabled system for replacing configurable text on screen and within readers. The SiteText feature is one of our most powerful technologies that keeps you from editing code! |
| SymConnect | A sample demonstrating SymConnect integration utilizing RepGen, and reading tracking records, etc. |
| Tab Navigation | Create content tabs within your widget to separate views and create a rich SPA for your users expecting a modern look to your views |
| Travel Notifications | Trigger notifications by accessing the core and flagging different cards for travel restrictions and approvals. |
| NativeSamples | Currently only has an example of how to do SSO on Native/Desktop. The intent is to add more native samples to this project in the future. |
| Still Here | Shows how to prevent the client side are you still here window when working in an Iframe |
| Savings Pod | A sample demonstrating Vue Components and vueChart libraries |