Skip to main content
Home  › ... Razor

Customize Edit UI/UX

Tutorial HomeCustomize Edit UX

2sxc Custom Color-Picker Input Field - Configurable

Input fields may expect some configuration - like default colors or WebApi endpoints. To enable such a configuration, we need a Content-Type which defines all the fields that can be configured. This can be in the app-data, or it can be stored in a subfolder of the field-extension, to make redestribution easier.
This example contains the json-exported content-type in the folder /system/field-string-app-color-pickr-pro/.data/contenttypes/ so you could just copy the extension folder to another app and use it from there.

So in this tutorial you'll learn how to:

  • To see how the UI changes based on field configuration
  • How to access such pre-configured settings with connector.field.settings
  • The Content-Type for configuration is included in the extension folder

Configurable Color-Picker Input Field

Output

This example shows two color-picker fields, with different initial configurations.
Hit this edit button to have a look:

    <p>
      This example shows two color-picker fields, with different initial configurations. <br>
      Hit this edit button to have a look: 
    </p>
    @Kit.Toolbar.Empty().New("UiStringColorPickrPro").AsTag()

    Source Code of ../system/field-string-app-color-pickr/index.js

    /*
      This examples shows a plain JS WebComponent which has has a Pickr color-picker
      Uses the neat Pickr from https://simonwep.github.io/pickr/
      This simple picker has a predefined set of colors and doesn't allow field configuration
    */
    
    // always use an IFFE to ensure you don't put variables in the window scope
    (() => {
    
      const tagName = 'field-string-app-color-pickr';
      const pickrJsCdn = 'https://cdn.jsdelivr.net/npm/@simonwep/pickr/dist/pickr.min.js';
      const html = `
      <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@simonwep/pickr/dist/themes/classic.min.css"/>
      <div class="pickr-container"></div>`;
    
      class StringColorPicker extends HTMLElement {
    
        /** connectedCallback() is the standard callback when the component has been attached */
        connectedCallback() {
          this.innerHTML = html;
          // if the window.Pickr doesn't exist yet, load the JS from the CDN () and then do a callback
          this.connector.loadScript('Pickr', pickrJsCdn, () => { this.initPick() });
        }
    
        /** disconnectedCallback() is a standard callback for clean-up */
        disconnectedCallback() {
          if (this.pickr) this.pickr.destroyAndRemove();
        }
    
        /** This is called when the JS is loaded from loadScript - so Pickr is ready */
        initPick() {
          this.pickr = new Pickr({
            el: '.pickr-container',
            theme: 'classic',
            default: this.connector.data.value || null,
            defaultRepresentation: 'HEXA',
            swatches: this.getSwatches(),
            components: {
              // Main components
              preview: true,
              opacity: true,
              hue: true,
    
              // Input / output Options
              interaction: {
                hex: true,
                rgba: true,
                hsla: true,
                hsva: true,
                cmyk: true,
                input: true,
                cancel: true,
                clear: true,
                save: true,
              },
            },
          });
          
          // remember if we're working empty as of now
          this.cleared = !this.connector.data.value;
    
          // bind events for changes etc. to live-update the preview
          this.pickr.on('change', (color, instance) => this.applyColor(instance));
          this.pickr.on('changestop', (instance) => this.applyColor(instance));
          this.pickr.on('swatchselect', (color, instance) => this.applyColor(instance));
    
          this.pickr.on('save', (color,instance) => instance.hide());
          this.pickr.on('hide', (instance) => this.update(instance));
          this.pickr.on('clear', (instance) => {
            this.cleared = true;
            this.update();
          });
        }
    
        /** Update the preview */
        applyColor(instance) {
          this.cleared = false;
          instance.applyColor(true);
        }
    
        /** Update the value */
        update(instance) {
          // if it's still cleared, just save null
          if (this.cleared) {
            return this.updateIfChanged(null);
          }
          // otherwise get the current color
          var color = instance.getColor();
          if (color) color = color.toHEXA().toString();
          this.updateIfChanged(color);
        }
    
        /** Only update the value if it really changed, so form isn't dirty if nothing was set */
        updateIfChanged(value) {
          var data = this.connector.data;
          if (data.value === '' && value == null) return;
          if (data.value === value) return;
          data.update(value);
        }
        
    
        /** Create the default color recommendations for the color picker */
        getSwatches() {
          return [
            'rgba(244, 67, 54, 1)',
            'rgba(233, 30, 99, 0.95)',
            'rgba(156, 39, 176, 0.9)',
            'rgba(103, 58, 183, 0.85)',
            'rgba(63, 81, 181, 0.8)',
            'rgba(33, 150, 243, 0.75)',
            'rgba(3, 169, 244, 0.7)',
            'rgba(0, 188, 212, 0.7)',
            'rgba(0, 150, 136, 0.75)',
            'rgba(76, 175, 80, 0.8)',
            'rgba(139, 195, 74, 0.85)',
            'rgba(205, 220, 57, 0.9)',
            'rgba(255, 235, 59, 0.95)',
            'rgba(255, 193, 7, 1)',
          ]
        }
      }
    
      // Register this web component - if it hasn't been registered yet
      if (!customElements.get(tagName)) customElements.define(tagName, StringColorPicker);
    })();

    Source Code of ../system/field-string-app-color-pickr-pro/.data/contenttypes/System.Fields.459d4ce3-b96b-4664-9947-75e46df9d33e.json

    {
      "_": { "V": 1 },
      "ContentType": {
        "Id": "459d4ce3-b96b-4664-9947-75e46df9d33e",
        "Name": "@string-app-color-pickr-pro",
        "Scope": "System.Fields",
        "Description": "",
        "Attributes": [
          {
            "Name": "Swatches",
            "Type": "String",
            "InputType": "string-default",
            "IsTitle": true,
            "Metadata": [
              {
                "Id": 74876,
                "Version": 2,
                "Guid": "47026444-2298-4f78-8210-d088ec1ea14c",
                "Type": { "Name": "@All", "Id": "@All" },
                "Attributes": {
                  "String": {
                    "CustomJavaScript": { "*": "" },
                    "DefaultValue": { "*": "" },
                    "InputType": { "*": "string-default" },
                    "Name": { "*": "Swatches" },
                    "Notes": {
                      "*": "<p>Place recommended color codes - one on each line. Use HEXA format, like #770088aa</p>"
                    },
                    "ValidationRegExJavaScript": { "*": "" }
                  },
                  "Entity": { "Errors": { "*": [] }, "Warnings": { "*": [] } },
                  "Boolean": {
                    "Disabled": { "*": false },
                    "Required": { "*": false },
                    "VisibleInEditUI": { "*": true }
                  }
                },
                "Owner": "dnn:userid=1"
              },
              {
                "Id": 74877,
                "Version": 1,
                "Guid": "75e73a53-b6cc-4f65-9cf8-22cdcb8fbc7f",
                "Type": { "Name": "@String", "Id": "@String" },
                "Attributes": {
                  "String": {
                    "DropdownValues": { "*": "" },
                    "InputType": { "*": "" }
                  }
                },
                "Owner": "dnn:userid=1"
              },
              {
                "Id": 74878,
                "Version": 1,
                "Guid": "dea3bf2f-3a95-4a05-adcf-353de7ec07c0",
                "Type": { "Name": "@string-default", "Id": "@string-default" },
                "Attributes": { "Number": { "RowCount": { "*": 10.0 } } },
                "Owner": "dnn:userid=1"
              }
            ]
          }
        ],
        "Metadata": []
      }
    }
    Important: We opened permissions that you can experience the edit dialog - so you can save, but it will just create draft data 😉.

    Source Code of this file

    Below you'll see the source code of the file. Note that we're just showing the main part, and hiding some parts of the file which are not relevant for understanding the essentials. Click to expand the code

    @inherits Custom.Hybrid.Razor14
    <!-- unimportant stuff, hidden -->
    
    
    <div @Sys.PageParts.InfoWrapper()>
      @Html.Partial("../shared/DefaultInfoSection.cshtml")
      <div @Sys.PageParts.InfoIntro()>
        <h2>2sxc Custom Color-Picker Input Field - Configurable</h2>
        <p>
          Input fields may expect some configuration - like default colors or WebApi endpoints. To enable such a configuration, we need a Content-Type which defines all the fields that can be configured. This can be in the app-data, or it can be stored in a subfolder of the field-extension, to make redestribution easier. <br>
          This example contains the json-exported content-type in the folder <code>/system/field-string-app-color-pickr-pro/.data/contenttypes/</code> so you could just copy the extension folder to another app and use it from there. 
        </p>
    
        <p>So in this tutorial you'll learn how to:</p>
        <ul>
          <li>To see how the UI changes based on field configuration</li>
          <li>How to access such pre-configured settings with <code>connector.field.settings</code></li>
          <li>The Content-Type for configuration is included in the extension folder</li>
        </ul>
      </div>
    </div>
    
      @Html.Partial("../shared/WarnAnonymousIfFeatureIsOff.cshtml")
    </hide>
    
    <div class="alert alert-success">
      <h2>Configurable Color-Picker Input Field</h2>
    
      <p>
        This example shows two color-picker fields, with different initial configurations. <br>
        Hit this edit button to have a look: 
      </p>
      @Kit.Toolbar.Empty().New("UiStringColorPickrPro").AsTag()
    
    </div>
    
    
    @Html.Partial("warning.cshtml")
    @* Footer *@
    @Html.Partial("../Shared/Layout/FooterWithSource.cshtml", new { Sys = Sys })