Crestron Components Lib - Showcase App

ch5-button: iconUrl, iconPosition, receiveStateIconUrl

The iconUrl attribute with SVG icons and PNG Icons

You can pass only one url in the iconUrl attribute

With image icon:

<div>
    <p>With image icon:</p>
    <div>
        <ch5-button
                type="text"
                shape="rectangle"
                label="PNG Icon Button"
                iconUrl="https://img.icons8.com/material/24/000000/search.png"
        ></ch5-button>
        <ch5-button
                type="text"
                shape="rectangle"
                label="SVG Icon Button"
                customClass="svg-btn-color"
                iconUrl="./img/nav_icon.svg"
        ></ch5-button>
    </div>
</div>

The iconPosition attribute

You can pass only one url in the iconUrl attribute

<ch5-button type="text" shape="rectangle" label="Icon First" iconUrl="https://img.icons8.com/material/24/000000/chevron-left--v1.png" iconPosition="first"></ch5-button>
<ch5-button type="text" shape="rectangle" label="Icon Last" iconUrl="https://img.icons8.com/material/24/000000/chevron-right--v1.png" iconPosition="last"></ch5-button>
<ch5-button type="success" shape="rectangle" label="Icon Top" iconUrl="./img/volume_unmute.svg" iconPosition="top"></ch5-button>
<ch5-button type="success" shape="rectangle" label="Icon Bottom" iconUrl="./img/volume_unmute.svg" iconPosition="bottom"></ch5-button>
Emulator Scenario (click to expand)
{
  "cues": [
    {
      "type": "boolean",
      "event": "trigger_icon_change_mute",
      "trigger": true,
      "actions": [
        {
          "state": "current_svg",
          "type": "s",
          "logic": "set",
          "value": "./img/volume_mute.svg"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "trigger_icon_change_unmute",
      "trigger": true,
      "actions": [
        {
          "state": "current_svg",
          "type": "s",
          "logic": "set",
          "value": "./img/volume_unmute.svg"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "trigger_icon_change_user",
      "trigger": true,
      "actions": [
        {
          "state": "current_png",
          "type": "s",
          "logic": "set",
          "value": "https://img.icons8.com/material/24/000000/user--v1.png"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "trigger_icon_change_connect",
      "trigger": true,
      "actions": [
        {
          "state": "current_png",
          "type": "s",
          "logic": "set",
          "value": "https://img.icons8.com/material/24/000000/share-2.png"
        }
      ]
    }
  ],
  "onStart": [
    {
      "state": "current_svg",
      "type": "s",
      "value": "./img/volume.svg"
    },
    {
      "state": "current_png",
      "type": "s",
      "value": "https://img.icons8.com/material/24/000000/search.png"
    }
  ]
}

Press the Load button to load the scenario.

Press the Run button to run the scenario. You only need to do this if the scenario (the json) has an onStart key.

The Emulator Scenario JSON contains an array of cues and an optional array onStart A cue is defined by: type:string, signal:string, trigger:boolean|string|number, actions:array. An action is defined by: type:string, signal:string, logic:string ... plus other fields ( depending on type)

type for cue or for action can be the string:

  • b or boolean - for a boolean signal
  • n or number or numeric - for a number signal
  • s or string - for a string signal
  • o or object - for an object signal

signal for cue or for action is a string representing the name of the signal:

trigger can be either a fixed value of the same type as the signal, or the string "&change". If it is a fixed value then, when the emulator detects that the signal has changed to the value given in trigger then it also executes the actions for that signal. If the value is the string "&change", regardless of signal type, then the actions are executed on any change in the value of the signal.

logic can be:

  • link - passes the value received on the incoming join through to the outgoing join. Using this between incompatible join types will attempt to cast the value. In the event of a cast failure the value will be set to false, 0 or "" (empty string)
  • set - assigns a specific value to the join. This requires a 5th key of 'value' and the specific value to assign. ie. {"signal":"light_level", "type":"n", "logic": "set","value":5}. If the 5th key is omitted, the default value will be sent (false, 0, "" or {})
  • toggle - (boolean Only) reads the current state and changes it to the opposite state
  • pulse - (boolean Only) value goes high and then low.
  • increment - (Numeric Only) reads the current value of the analog and adds an offset. This logic accepts an optional 5th key of 'offset which determines how many to incrementby. ie. {"signal":"volume_level","type":"n", "logic":"increment","offset":5}. If this 5th key is omitted, the default offset of 1 will be applied.
  • decrement - (Numeric Only) reads the current value of the analog and subtracts an offset. This logic accepts an optional 5th key of 'offset which determines how many to decrement by. ie. {"signal":"volume_level","type":"n", "logic":"decrement","offset":5}. If this 5th key is omitted, the default offset of 1 will be applied.

RCB logic can be accomplished by defining an action containing an object signal of RCB type:
{ "rcb":{ "value": numeric_value, "time": duration_in_ms } }
Scenario example:


    {
      "cues": [
        {
          "type": "boolean",
          "signal": "trigger",
          "trigger": true,
          "actions": [
            {
              "signal": "action1",
              "type": "boolean",
              "logic": "toggle"
            },
            {
                "signal": "rcb_signal",
                "type": "object",
                "logic": "set",
                "value": {
                    "rcb":{
                        "value": 101,
                        "time": 1500
                    }
                }
            }
          ]
        }
      ],
      "onStart": [
      ]
    }
    

Use receiveStateIconUrl attributes in order to change the icon through signal

The icon for the bellow button will be changed


Click on the button bellow in order to change the icon
<div>
  <h3>The icon for the bellow button will be changed</h3>
  <ch5-button type="success" shape="rectangle" label="SVG Icon" receivestateiconurl="current_svg"></ch5-button>
  <ch5-button type="text" shape="rectangle" label="PNG Icon" receivestateiconurl="current_png"></ch5-button>
</div>
<br />
<div>
  <h5>Click on the button bellow in order to change the icon</h5>
  <ch5-button type="success" shape="rectangle" label="Mute SVG" iconurl="./img/volume_mute.svg" sendeventonclick="trigger_icon_change_mute"></ch5-button>
  <ch5-button type="success" shape="rectangle" label="Unmute SVG" iconurl="./img/volume_unmute.svg" sendeventonclick="trigger_icon_change_unmute"></ch5-button>
  <ch5-button type="text" shape="rectangle" label="User PNG" iconurl="https://img.icons8.com/material/24/000000/user--v1.png" sendeventonclick="trigger_icon_change_user"></ch5-button>
  <ch5-button type="text" shape="rectangle" label="Connect PNG" iconurl="https://img.icons8.com/material/24/000000/share-2.png" sendeventonclick="trigger_icon_change_connect"></ch5-button>
</div>