Creating gists for the catalog app

Bridge developers notes

6.9 Creating gists for the catalog app

Introduction

Note: this article is written for bridge developers only. Creating and using gists for application developers that use the bridge is described here

We recently added the feature to run each example of each Aurelia component in the Aurelia KendoUI bridge catalog app, using the Aurelia GistRun tool:

Image 1

This GistRun is invoked by a click on the RUN button on the Autocomplete page of the catalog app:

The rest of this article demonstrates the process of adding the **RUN** button to the combobox basic use page.

Step 1

Prepare the file registry.json by adding the basic definition of the gist to be used.

{
  "title": "ComboBox",
  "documentation": "http://docs.telerik.com/kendo-ui/api/javascript/ui/combobox",
  "samples": {
    "basic-use": {
      "route": ["", "basic-use"],
      "gist": "https://gist.run/?id=xxx"
    },
    "api": {
      "title": "API",
      "gist": "https://gist.run/?id=xxx"
    },
    "cascading-combobox": {
      "gist": "https://gist.run/?id=xxx"
    },
    "customizing-templates": {
      "gist": "https://gist.run/?id=xxx"
    },
    "grouping": {
      "gist": "https://gist.run/?id=xxx"
    },
    "server-filtering": {
      "gist": "https://gist.run/?id=xxx"
    },
    "virtualization": {
      "gist": "https://gist.run/?id=xxx"
    },
    "events": {
      "gist": "https://gist.run/?id=xxx"
    }
  }
}

Step 2

Create the gists for each of the sample used on this page of the catalog app

To avoid the repetition, we will show the creation of just the ComboBox basic use gist.

Step 2.1 - create a new Gist

Go to https://gist.github.com/ to create a new, empty Gist

Image 2

Step 2.2 - populate the Gist

Drag the four prepared files shown below

Image 3

and drop them on top of the GitHub Gist page which was empty so far, shown on Image 2. Note that this "drag and drop" use is the best workaround for the current lack of GistRun tool's to support the import of the whole project for the gist.

Now, we have these files added to the the gist:

Image 4

Note that we also added the Gist title (top of the gist window) "ComoboBox: basic use".

At this point we need to explain what are these four "prebuilt" files we just added to the gist:

index.html

<!doctype html>
<html>
  <head>
    <title>Aurelia KendoUI bridge</title>
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <link rel="stylesheet" href="https://kendo.cdn.telerik.com/2016.1.226/styles/kendo.common.min.css">
    <link rel="stylesheet" href="https://kendo.cdn.telerik.com/2016.1.226/styles/kendo.rtl.min.css">
    <link rel="stylesheet" href="https://kendo.cdn.telerik.com/2016.1.226/styles/kendo.default.min.css">
    <link rel="stylesheet" href="https://kendo.cdn.telerik.com/2016.1.226/styles/kendo.mobile.all.min.css">
    <script src="https://kendo.cdn.telerik.com/2016.1.226/js/jszip.min.js"></script>
  </head>
  <body aurelia-app="main">
    <h1>Loading...</h1>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.6/system.js"></script>
    <script src="https://rawgit.com/aurelia-ui-toolkits/aurelia-kendoui-bundles/0.3.5/config2.js"></script>
    <script>
      System.import('aurelia-bootstrapper');
    </script>
  </body>
</html>

This is the standard "beginning" of any Aurelia application - with a very big difference, caused by the line:

<script src="https://rawgit.com/aurelia-ui-toolkits/aurelia-kendoui-bundles/0.3.5/config2.js">

which tells the GistRun tool to fetch the complete, bundled Aurelia runtime modules set from the https://rawgit.com server. The actual bundle was prepared by Aurelia-UI-Toolkits team and is being maintained here

main.js

export function configure(aurelia) {
  aurelia.use
    .standardConfiguration()
    .developmentLogging()
    .plugin('aurelia-kendoui-bridge', kendo => kendo.pro());

  aurelia.start().then(a => a.setRoot());
}

This is the standard Aurelia configuration function which requires the presence of the Aurelia-KendoUI bridge. That presence is of course ensured by specific content of the aurelia-kendoui-bundles repository

app.html - the HTML tab from Code Preview on this page

<template>
    <div id="example">
        <div id="cap-view" class="demo-section k-content">
            <h4>Customize your Kendo T-shirt</h4>
            <img src="http://demos.telerik.com/kendo-ui/content/web/combobox/tShirt.png" id="tshirt"/>

            <h4>T-shirt fabric</h4>
            <ak-combobox k-data-text-field="text"
                              k-data-value-field="value"
                              k-data-source.bind="data"
                              k-value.two-way="fabric"
                              k-filter="contains"
                              k-suggest.bind="true"
                              style="width: 100%;">
            </ak-combobox>

            <h4 style="margin-top: 2em;">T-shirt Size</h4>
            <ak-combobox k-value.two-way="size">
              <select style="width: 100%;">
                <option>X-Small</option>
                <option>Small</option>
                <option>Medium</option>
                <option>Large</option>
                <option>X-Large</option>
                <option>2X-Large</option>
              </select>
            </ak-combobox>

            <button class="k-button k-primary" click.delegate="buyCap()" style="margin-top: 2em; float: right;">Customize</button>
        </div>
    </div>
    <style>
      #tshirt {
           display: block;
           margin: 2em auto;
       }
       .k-readonly
       {
           color: gray;
       }
    </style>
</template>

app.js - the Javascript tab from Code Preview on this page

export class BasicUse {
  data = [
    { text: 'Cotton', value: '1' },
    { text: 'Polyester', value: '2' },
    { text: 'Cotton/Polyester', value: '3' },
    { text: 'Rib Knit', value: '4' }
  ];

  fabric = '3';

  buyCap() {
    alert(`Thank you! Your Choice is:\n\nFabric ID: ${this.fabric} and Size: ${this.size}`);
  }
}