CriticalDepsMirror/clay
1
0
Fork 0
mirror of https://github.com/pebble-dev/clay.git synced 2026-08-27 20:36:33 -04:00
Code Issues Packages Projects Releases Wiki Activity

Rename all appKey references to messageKey

Browse Source
This commit is contained in:
Keegan
2016-06-15 10:58:45 -07:00
parent c3c8de77fc
commit 940c5e2451
11 changed files with 100 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+34 -34
View File
@@ -1,7 +1,7 @@
# Clay # Clay
Clay is a JavaScript library that makes it easy to add offline configuration pages to your Pebble apps. All you need to get started is a couple lines of JavaScript and a JSON file; no servers or HTML required. Clay is a JavaScript library that makes it easy to add offline configuration pages to your Pebble apps. All you need to get started is a couple lines of JavaScript and a JSON file; no servers or HTML required.
Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events traditionally implemented by developers to relay configuration settings to the watch side of the app. This step is not required when using Clay, since each config item is given the same `appKey` as defined in `appinfo.json` (or PebbleKit JS Message Keys on CloudPebble), and is automatically transmitted once the configuration page is submitted by the user. Developers can override this behavior by [handling the events manually](#handling-the-showconfiguration-and-webviewclosed-events-manually). Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events traditionally implemented by developers to relay configuration settings to the watch side of the app. This step is not required when using Clay, since each config item is given the same `messageKey` as defined in `appinfo.json` (or PebbleKit JS Message Keys on CloudPebble), and is automatically transmitted once the configuration page is submitted by the user. Developers can override this behavior by [handling the events manually](#handling-the-showconfiguration-and-webviewclosed-events-manually).
**Clay is still in early development and may be missing some features. We would love your feedback! Please submit any ideas or features via GitHub Issues.** **Clay is still in early development and may be missing some features. We would love your feedback! Please submit any ideas or features via GitHub Issues.**
@@ -108,12 +108,12 @@ Sections help divide up the page into logical groups of items. It is recommended
}, },
{ {
"type": "input", "type": "input",
"appKey": "email", "messageKey": "email",
"label": "Email Address" "label": "Email Address"
}, },
{ {
"type": "toggle", "type": "toggle",
"appKey": "enableAnimations", "messageKey": "enableAnimations",
"label": "Enable Animations" "label": "Enable Animations"
} }
] ]
@@ -134,7 +134,7 @@ Headings can be used in anywhere and can have their size adjusted to suit the co
|----------|------|-------------| |----------|------|-------------|
| type | string | Set to `heading`. | | type | string | Set to `heading`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). | | id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| appKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByAppKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. | | messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| defaultValue | string/HTML | The heading's text. | | defaultValue | string/HTML | The heading's text. |
| size | int | Defaults to `4`. An integer from 1 to 6 where 1 is the largest size and 6 is the smallest. (represents HTML `<h1>`, `<h2>`, `<h3>`, etc). | | size | int | Defaults to `4`. An integer from 1 to 6 where 1 is the largest size and 6 is the smallest. (represents HTML `<h1>`, `<h2>`, `<h3>`, etc). |
| capabilities | array | Array of features that the connected watch must have for this item to be present | | capabilities | array | Array of features that the connected watch must have for this item to be present |
@@ -165,7 +165,7 @@ Text is used to provide descriptions of sections or to explain complex parts of
|----------|------|-------------| |----------|------|-------------|
| type | string | Set to `text`. | | type | string | Set to `text`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). | | id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| appKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByAppKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. | | messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| defaultValue | string/HTML | The content of the text element. | | defaultValue | string/HTML | The content of the text element. |
| capabilities | array | Array of features that the connected watch must have for this item to be present | | capabilities | array | Array of features that the connected watch must have for this item to be present |
@@ -193,7 +193,7 @@ Standard text input field.
|----------|------|-------------| |----------|------|-------------|
| type | string | Set to `input`. | | type | string | Set to `input`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). | | id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| appKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByAppKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. | | messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. | | label | string | The label that should appear next to this item. |
| defaultValue | string | The default value of the input field. | | defaultValue | string | The default value of the input field. |
| description | string | Optional sub-text to include below the component | | description | string | Optional sub-text to include below the component |
@@ -206,7 +206,7 @@ Standard text input field.
```javascript ```javascript
{ {
"type": "input", "type": "input",
"appKey": "email", "messageKey": "email",
"defaultValue": "", "defaultValue": "",
"label": "Email Address", "label": "Email Address",
"attributes": { "attributes": {
@@ -231,7 +231,7 @@ Switch for a single item.
|----------|------|-------------| |----------|------|-------------|
| type | string | Set to `toggle`. | | type | string | Set to `toggle`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). | | id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| appKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByAppKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. | | messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. | | label | string | The label that should appear next to this item. |
| defaultValue | int\|boolean | The default value of the toggle. Defaults to `false` if not specified. | | defaultValue | int\|boolean | The default value of the toggle. Defaults to `false` if not specified. |
| description | string | Optional sub-text to include below the component | | description | string | Optional sub-text to include below the component |
@@ -243,7 +243,7 @@ Switch for a single item.
```javascript ```javascript
{ {
"type": "toggle", "type": "toggle",
"appKey": "invert", "messageKey": "invert",
"label": "Invert Colors", "label": "Invert Colors",
"defaultValue": true "defaultValue": true
} }
@@ -263,7 +263,7 @@ A dropdown menu containing multiple options.
|----------|------|-------------| |----------|------|-------------|
| type | string | Set to `select`. | | type | string | Set to `select`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). | | id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| appKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByAppKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. | | messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. | | label | string | The label that should appear next to this item. |
| defaultValue | string | The default value of the dropdown menu. Must match a value in the `options` array. | | defaultValue | string | The default value of the dropdown menu. Must match a value in the `options` array. |
| description | string | Optional sub-text to include below the component | | description | string | Optional sub-text to include below the component |
@@ -275,7 +275,7 @@ A dropdown menu containing multiple options.
```javascript ```javascript
{ {
"type": "select", "type": "select",
"appKey": "flavor", "messageKey": "flavor",
"defaultValue": "grape", "defaultValue": "grape",
"label": "Favorite Flavor", "label": "Favorite Flavor",
"options": [ "options": [
@@ -304,7 +304,7 @@ If you wish to use optgroups, then use the following format:
```javascript ```javascript
{ {
"type": "select", "type": "select",
"appKey": "flavor", "messageKey": "flavor",
"defaultValue": "grape", "defaultValue": "grape",
"label": "Favorite Flavor", "label": "Favorite Flavor",
"options": [ "options": [
@@ -369,7 +369,7 @@ The color picker will automatically show a different layout depending on the wat
|----------|------|-------------| |----------|------|-------------|
| type | string | Set to `color`. | | type | string | Set to `color`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). | | id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| appKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByAppKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. | | messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. | | label | string | The label that should appear next to this item. |
| defaultValue | string OR int | The default color. One of the [64 colors](https://developer.pebble.com/guides/tools-and-resources/color-picker/) compatible with Pebble smartwatches. Always use the uncorrected value even if `sunlight` is true. The component will do the conversion internally. | | defaultValue | string OR int | The default color. One of the [64 colors](https://developer.pebble.com/guides/tools-and-resources/color-picker/) compatible with Pebble smartwatches. Always use the uncorrected value even if `sunlight` is true. The component will do the conversion internally. |
| description | string | Optional sub-text to include below the component | | description | string | Optional sub-text to include below the component |
@@ -383,7 +383,7 @@ The color picker will automatically show a different layout depending on the wat
```javascript ```javascript
{ {
"type": "color", "type": "color",
"appKey": "background", "messageKey": "background",
"defaultValue": "ff0000", "defaultValue": "ff0000",
"label": "Background Color", "label": "Background Color",
"sunlight": true, "sunlight": true,
@@ -400,7 +400,7 @@ The color picker will automatically show a different layout depending on the wat
```javascript ```javascript
{ {
"type": "color", "type": "color",
"appKey": "background", "messageKey": "background",
"defaultValue": "ffffff", "defaultValue": "ffffff",
"label": "Background Color", "label": "Background Color",
"sunlight": false, "sunlight": false,
@@ -413,7 +413,7 @@ The color picker will automatically show a different layout depending on the wat
```javascript ```javascript
{ {
"type": "color", "type": "color",
"appKey": "background", "messageKey": "background",
"defaultValue": "aaaaaa", "defaultValue": "aaaaaa",
"label": "Background Color", "label": "Background Color",
"sunlight": false, "sunlight": false,
@@ -435,7 +435,7 @@ A list of options allowing the user can only choose one option to submit.
|----------|------|-------------| |----------|------|-------------|
| type | string | Set to `radiogroup`. | | type | string | Set to `radiogroup`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). | | id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| appKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByAppKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. | | messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. | | label | string | The label that should appear next to this item. |
| defaultValue | string | The default selected item. Must match a value in the `options` array. | | defaultValue | string | The default selected item. Must match a value in the `options` array. |
| description | string | Optional sub-text to include below the component | | description | string | Optional sub-text to include below the component |
@@ -447,7 +447,7 @@ A list of options allowing the user can only choose one option to submit.
```javascript ```javascript
{ {
"type": "radiogroup", "type": "radiogroup",
"appKey": "favorite_food", "messageKey": "favorite_food",
"label": "Favorite Food", "label": "Favorite Food",
"options": [ "options": [
{ {
@@ -480,7 +480,7 @@ A list of options where a user may choose more than one option to submit.
|----------|------|-------------| |----------|------|-------------|
| type | string | Set to `checkboxgroup`. | | type | string | Set to `checkboxgroup`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). | | id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| appKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByAppKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. | | messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. | | label | string | The label that should appear next to this item. |
| defaultValue | array of strings | The default selected items. Each value must match one in the `options` array. | | defaultValue | array of strings | The default selected items. Each value must match one in the `options` array. |
| description | string | Optional sub-text to include below the component | | description | string | Optional sub-text to include below the component |
@@ -492,7 +492,7 @@ A list of options where a user may choose more than one option to submit.
```javascript ```javascript
{ {
"type": "checkboxgroup", "type": "checkboxgroup",
"appKey": "favorite_food", "messageKey": "favorite_food",
"label": "Favorite Food", "label": "Favorite Food",
"defaultValue": ["sushi", "burgers"], "defaultValue": ["sushi", "burgers"],
"options": [ "options": [
@@ -571,7 +571,7 @@ you must just remember to divide the received value on the watch accordingly.
```javascript ```javascript
{ {
"type": "slider", "type": "slider",
"appKey": "slider", "messageKey": "slider",
"defaultValue": 15, "defaultValue": 15,
"label": "Slider", "label": "Slider",
"description": "This is the description for the slider", "description": "This is the description for the slider",
@@ -627,9 +627,9 @@ You can also prefix the capability with `NOT_` to negate the capability. Eg: `NO
will only be included in the page if the device does **NOT** support health. will only be included in the page if the device does **NOT** support health.
**Warning:** Items that do not satisfy the capabilities will not be included in the page **Warning:** Items that do not satisfy the capabilities will not be included in the page
at all. You will not be able to use methods like `clayConfig.getItemByAppKey()` to at all. You will not be able to use methods like `clayConfig.getItemByMessageKey()` to
obtain a reference to them. However, this does mean that you will be able to have obtain a reference to them. However, this does mean that you will be able to have
multiple items with the same `appKey`as long as they do not both satisfy the multiple items with the same `messageKey`as long as they do not both satisfy the
same conditions. same conditions.
##### Examples ##### Examples
@@ -682,7 +682,7 @@ Each component has a **manipulator**. This is a set of methods used to talk to t
At a minimum, manipulators must have a `.get()` and `.set(value)` method however there are also methods to assist in interactivity such as `.hide()` and `.disable()`. At a minimum, manipulators must have a `.get()` and `.set(value)` method however there are also methods to assist in interactivity such as `.hide()` and `.disable()`.
**NOTE:** There is currently no way to disable or hide an entire section. You must disable/hide each item in the section to achieve this effect. **NOTE:** There is currently no way to disable or hide an entire section. You must disable/hide each item in the section to achieve this effect.
When the config page is closed, the `.get()` method is run on all components registered with an `appKey` to construct the object sent to the C app. When the config page is closed, the `.get()` method is run on all components registered with an `messageKey` to construct the object sent to the C app.
Many of these methods fire an event when the method is called. You can listen for these events with `ClayItem.on()`. Many of these methods fire an event when the method is called. You can listen for these events with `ClayItem.on()`.
**NOTE** These events will only be fired if the state actually changes. **NOTE** These events will only be fired if the state actually changes.
@@ -780,7 +780,7 @@ Clay is built to allow developers to add their own basic interactivity to the co
## Handling The 'showConfiguration' and 'webviewclosed' Events Manually ## Handling The 'showConfiguration' and 'webviewclosed' Events Manually
Clay will by default, automatically handle the 'showConfiguration' and 'webviewclosed' events. This allows the `appKey` of each config item to be automatically delivered to the `InboxReceivedHandler` on the watch side. If you wish to override this behavior and handle the events yourself, pass an object as the 3rd parameter of the Clay constructor with `autoHandleEvents` set to `false`. Clay will by default, automatically handle the 'showConfiguration' and 'webviewclosed' events. This allows the `messageKey` of each config item to be automatically delivered to the `InboxReceivedHandler` on the watch side. If you wish to override this behavior and handle the events yourself, pass an object as the 3rd parameter of the Clay constructor with `autoHandleEvents` set to `false`.
Example: Example:
@@ -898,7 +898,7 @@ cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000);
| `Clay( [array] config, [function] customFn=null, [object] options={autoHandleEvents: true})` <br> `config` - an Array representing your config <br> `customFn` - function to be run in the context of the generated page <br> `options.autoHandleEvents` - set to `false` to prevent Clay from automatically handling the "showConfiguration" and "webviewclosed" events | `Clay` - a new instance of Clay. | | `Clay( [array] config, [function] customFn=null, [object] options={autoHandleEvents: true})` <br> `config` - an Array representing your config <br> `customFn` - function to be run in the context of the generated page <br> `options.autoHandleEvents` - set to `false` to prevent Clay from automatically handling the "showConfiguration" and "webviewclosed" events | `Clay` - a new instance of Clay. |
| `.registerComponent( [ClayComponent] component )` <br> Registers a custom component. | `void`. | | `.registerComponent( [ClayComponent] component )` <br> Registers a custom component. | `void`. |
| `.generateUrl()` | `string` - The URL to open with `Pebble.openURL()` to use the Clay-generated config page. | | `.generateUrl()` | `string` - The URL to open with `Pebble.openURL()` to use the Clay-generated config page. |
| `.getSettings( [object] response, [boolean] convert=true)` <br> `response` - the response object provided to the "webviewclosed" event <br> `convert` - Pass `false` to not convert the settings to be compatible with `Pebble.sendAppMessage()` | `Object` - object of keys and values for each config page item with an `appKey`, where the key is the `appKey` and the value is the chosen value of that item. This method will do some conversions depending on the type of the setting. Arrays containing strings will have zeros inserted before each item. eg `['one', 'two']` becomes `['one', 0, 'two', 0]`. Booleans will be converted to numbers. eg `true` becomes `1` and `false` becomes `0`. Pass `false` as the second parameter to disable this behavior | | `.getSettings( [object] response, [boolean] convert=true)` <br> `response` - the response object provided to the "webviewclosed" event <br> `convert` - Pass `false` to not convert the settings to be compatible with `Pebble.sendAppMessage()` | `Object` - object of keys and values for each config page item with an `messageKey`, where the key is the `messageKey` and the value is the chosen value of that item. This method will do some conversions depending on the type of the setting. Arrays containing strings will have zeros inserted before each item. eg `['one', 'two']` becomes `['one', 0, 'two', 0]`. Booleans will be converted to numbers. eg `true` becomes `1` and `false` becomes `0`. Pass `false` as the second parameter to disable this behavior |
--- ---
@@ -936,20 +936,20 @@ module.exports = function(minified) {
function toggleBackground() { function toggleBackground() {
if (this.get()) { if (this.get()) {
clayConfig.getItemByAppKey('background').enable(); clayConfig.getItemByMessageKey('background').enable();
} else { } else {
clayConfig.getItemByAppKey('background').disable(); clayConfig.getItemByMessageKey('background').disable();
} }
} }
clayConfig.on(clayConfig.EVENTS.AFTER_BUILD, function() { clayConfig.on(clayConfig.EVENTS.AFTER_BUILD, function() {
var coolStuffToggle = clayConfig.getItemByAppKey('cool_stuff'); var coolStuffToggle = clayConfig.getItemByMessageKey('cool_stuff');
toggleBackground.call(coolStuffToggle); toggleBackground.call(coolStuffToggle);
coolStuffToggle.on('change', toggleBackground); coolStuffToggle.on('change', toggleBackground);
// Hide the color picker for aplite // Hide the color picker for aplite
if (!clayConfig.meta.activeWatchInfo || clayConfig.meta.activeWatchInfo.platform === 'aplite') { if (!clayConfig.meta.activeWatchInfo || clayConfig.meta.activeWatchInfo.platform === 'aplite') {
clayConfig.getItemByAppKey('background').hide(); clayConfig.getItemByMessageKey('background').hide();
} }
// Set the value of an item based on the userData // Set the value of an item based on the userData
@@ -992,10 +992,10 @@ This is the main way of talking to your generated config page. An instance of th
| Method | Returns | | Method | Returns |
|--------|---------| |--------|---------|
| `.getAllItems()` | `Array.<ConfigItem>` - an array of all config items. | | `.getAllItems()` | `Array.<ConfigItem>` - an array of all config items. |
| `.getItemByAppKey( [string] appKey )` | `ConfigItem\|undefined` - a single `ConfigItem` that has the provided `appKey`, otherwise `undefined`. | | `.getItemByMessageKey( [string] messageKey )` | `ConfigItem\|undefined` - a single `ConfigItem` that has the provided `messageKey`, otherwise `undefined`. |
| `.getItemById( [string] id )` | `ConfigItem\|undefined` - a single `ConfigItem` that has the provided `id`, otherwise `undefined`. | | `.getItemById( [string] id )` | `ConfigItem\|undefined` - a single `ConfigItem` that has the provided `id`, otherwise `undefined`. |
| `.getItemsByType( [string] type )` | `Array.<ConfigItem>` - an array of config items that match the provided `type`. | | `.getItemsByType( [string] type )` | `Array.<ConfigItem>` - an array of config items that match the provided `type`. |
| `.serialize()` | `Object` - an object representing all items with an `appKey` where the key is the `appKey` and the value is an object with the `value` property set to the result of running `.get()` on the Clay item. If the Clay item has a `precision` property set, it is included in the object | | `.serialize()` | `Object` - an object representing all items with an `messageKey` where the key is the `messageKey` and the value is an object with the `value` property set to the result of running `.get()` on the Clay item. If the Clay item has a `precision` property set, it is included in the object |
| `.build()` <br> Builds the config page. Will dispatch the `BEFORE_BUILD` event prior to building the page, then the `AFTER_BUILD` event once it is complete. If the config page has already been built, then the `ClayConfig.destroy()` method will be executed prior to building the page again. | `ClayConfig` | | `.build()` <br> Builds the config page. Will dispatch the `BEFORE_BUILD` event prior to building the page, then the `AFTER_BUILD` event once it is complete. If the config page has already been built, then the `ClayConfig.destroy()` method will be executed prior to building the page again. | `ClayConfig` |
| `.destroy()` <br> Destroys the config page. Will dispatch the `BEFORE_DESTROY` event prior to destroying the page, then the `AFTER_DESTROY` event once it is complete. This method wipes the config page completely, including all existing items. You will need to make sure that you re-attach your event handlers for any items that are replaced | `ClayConfig` | | `.destroy()` <br> Destroys the config page. Will dispatch the `BEFORE_DESTROY` event prior to destroying the page, then the `AFTER_DESTROY` event once it is complete. This method wipes the config page completely, including all existing items. You will need to make sure that you re-attach your event handlers for any items that are replaced | `ClayConfig` |
| `.on( [string] events, [function] handler )` <br> Register an event to the provided handler. The handler will be called with this instance of `ClayConfig` as the context. If you wish to register multiple events to the same handler, then separate the events with a space | `ClayConfig` | | `.on( [string] events, [function] handler )` <br> Register an event to the provided handler. The handler will be called with this instance of `ClayConfig` as the context. If you wish to register multiple events to the same handler, then separate the events with a space | `ClayConfig` |
@@ -1012,7 +1012,7 @@ This is the main way of talking to your generated config page. An instance of th
| Property | Type | Description | | Property | Type | Description |
|----------|------|-------------| |----------|------|-------------|
| `.id` | String | The ID of the item if provided in the config. | | `.id` | String | The ID of the item if provided in the config. |
| `.appKey` | String | The ID of the item if provided in the config. | | `.messageKey` | String | The ID of the item if provided in the config. |
| `.config` | Object | Reference to the config passed to the constructer. | | `.config` | Object | Reference to the config passed to the constructer. |
| `$element` | $Minified | A Minified list representing the root HTML element of the config item. | | `$element` | $Minified | A Minified list representing the root HTML element of the config item. |
| `$manipulatorTarget` | $Minified | A Minified list representing the HTML element with **data-manipulator-target** set. This is generally pointing to the main `<input>` element and will be used for binding events. | | `$manipulatorTarget` | $Minified | A Minified list representing the HTML element with **data-manipulator-target** set. This is generally pointing to the main `<input>` element and will be used for binding events. |
@@ -1140,4 +1140,4 @@ While developing components and other functionality for Clay, it is much easier
Most of the magic happens in the `src/scripts/lib` directory. `config-page.js` initializes a new instance of `ClayConfig` and calls the injected custom function (`window.customFn`) with the `ClayConfig` as its context. This allows developers to add extra functionality to the config page, such as setting values of items dynamically or registering small custom components. Most of the magic happens in the `src/scripts/lib` directory. `config-page.js` initializes a new instance of `ClayConfig` and calls the injected custom function (`window.customFn`) with the `ClayConfig` as its context. This allows developers to add extra functionality to the config page, such as setting values of items dynamically or registering small custom components.
Once the `ClayConfig` is initialized, we run the `.build()` method. This iterates over the config and injects each item into the page. Each item is an instance of `ClayItem`. It also indexes the items to later be retrieved with `.getAllItems()`, `.getItemByAppKey()`, `.getItemById()`, `.getItemsByType()`. Once the `ClayConfig` is initialized, we run the `.build()` method. This iterates over the config and injects each item into the page. Each item is an instance of `ClayItem`. It also indexes the items to later be retrieved with `.getAllItems()`, `.getItemByMessageKey()`, `.getItemById()`, `.getItemsByType()`.
dev/config-2.js
+1 -1
View File
@@ -21,7 +21,7 @@ module.exports = [
}, },
{ {
"type": "input", "type": "input",
"appKey": "email", "messageKey": "email",
"defaultValue": "", "defaultValue": "",
"label": "Input Field", "label": "Input Field",
"description": "This is a new field", "description": "This is a new field",
dev/config.js
+8 -8
View File
@@ -38,7 +38,7 @@ module.exports = [
}, },
{ {
"type": "input", "type": "input",
"appKey": "email", "messageKey": "email",
"defaultValue": "", "defaultValue": "",
"label": "Input Field", "label": "Input Field",
"description": "This is a description for the input component. " + "description": "This is a description for the input component. " +
@@ -63,7 +63,7 @@ module.exports = [
}, },
{ {
"type": "slider", "type": "slider",
"appKey": "slider", "messageKey": "slider",
"defaultValue": 15, "defaultValue": 15,
"label": "Slider", "label": "Slider",
"description": "This is the description for the slider", "description": "This is the description for the slider",
@@ -73,20 +73,20 @@ module.exports = [
}, },
{ {
"type": "toggle", "type": "toggle",
"appKey": "cool_stuff", "messageKey": "cool_stuff",
"label": "This is a Toggle", "label": "This is a Toggle",
"defaultValue": false "defaultValue": false
}, },
{ {
"type": "color", "type": "color",
"appKey": "colorTest", "messageKey": "colorTest",
"defaultValue": "FF0000", "defaultValue": "FF0000",
"label": "Standard Color Picker", "label": "Standard Color Picker",
"sunlight": false "sunlight": false
}, },
{ {
"type": "color", "type": "color",
"appKey": "sunnyColorTest", "messageKey": "sunnyColorTest",
"defaultValue": "00FF00", "defaultValue": "00FF00",
"label": "Sunny Color Picker", "label": "Sunny Color Picker",
"sunlight": true "sunlight": true
@@ -110,7 +110,7 @@ module.exports = [
}, },
{ {
"type": "radiogroup", "type": "radiogroup",
"appKey": "radiogroup-test", "messageKey": "radiogroup-test",
"label": "Radio Group", "label": "Radio Group",
"options": [ "options": [
{ "label": "Test thing", "value": "one" }, { "label": "Test thing", "value": "one" },
@@ -120,7 +120,7 @@ module.exports = [
}, },
{ {
"type": "checkboxgroup", "type": "checkboxgroup",
"appKey": "checkboxgroup-test", "messageKey": "checkboxgroup-test",
"defaultValue": ["quote' \"test", "two"], "defaultValue": ["quote' \"test", "two"],
"label": "Checkbox Group", "label": "Checkbox Group",
"options": [ "options": [
@@ -131,7 +131,7 @@ module.exports = [
}, },
{ {
"type": "select", "type": "select",
"appKey": "flavor", "messageKey": "flavor",
"defaultValue": "grape", "defaultValue": "grape",
"label": "Select Menu", "label": "Select Menu",
"options": [ "options": [
dev/custom-fn.js
+3 -3
View File
@@ -10,9 +10,9 @@ module.exports = function() {
*/ */
function toggleBackground() { function toggleBackground() {
if (this.get()) { if (this.get()) {
Clay.getItemByAppKey('colorTest').enable(); Clay.getItemByMessageKey('colorTest').enable();
} else { } else {
Clay.getItemByAppKey('colorTest').disable(); Clay.getItemByMessageKey('colorTest').disable();
} }
} }
@@ -25,7 +25,7 @@ module.exports = function() {
} }
Clay.on(Clay.EVENTS.AFTER_BUILD, function() { Clay.on(Clay.EVENTS.AFTER_BUILD, function() {
var coolStuffToggle = Clay.getItemByAppKey('cool_stuff'); var coolStuffToggle = Clay.getItemByMessageKey('cool_stuff');
toggleBackground.call(coolStuffToggle); toggleBackground.call(coolStuffToggle);
coolStuffToggle.on('change', toggleBackground); coolStuffToggle.on('change', toggleBackground);
index.js
+1 -1
View File
@@ -214,7 +214,7 @@ Clay.encodeDataUri = function(input, prefix) {
* Eg: 1.4567 with a precision set to 3 will become 1456 * Eg: 1.4567 with a precision set to 3 will become 1456
* @param {number|string|boolean|Array|Object} val * @param {number|string|boolean|Array|Object} val
* @param {number|string|boolean|Array} val.value * @param {number|string|boolean|Array} val.value
* @param {number} [val.precision=0] * @param {number|undefined} [val.precision=0]
* @returns {number|string|Array} * @returns {number|string|Array}
*/ */
Clay.prepareForAppMessage = function(val) { Clay.prepareForAppMessage = function(val) {
src/scripts/lib/clay-config.js
+14 -14
View File
@@ -5,7 +5,7 @@
* @typedef {Object} Clay~ConfigItem * @typedef {Object} Clay~ConfigItem
* @property {string} type * @property {string} type
* @property {string|boolean|number} defaultValue * @property {string|boolean|number} defaultValue
* @property {string} [appKey] * @property {string} [messageKey]
* @property {string} [id] * @property {string} [id]
* @property {string} [label] * @property {string} [label]
* @property {Object} [attributes] * @property {Object} [attributes]
@@ -36,7 +36,7 @@ function ClayConfig(settings, config, $rootContainer, meta) {
var _settings = _.copyObj(settings); var _settings = _.copyObj(settings);
var _items; var _items;
var _itemsById; var _itemsById;
var _itemsByAppKey; var _itemsByMessageKey;
var _isBuilt; var _isBuilt;
/** /**
@@ -47,7 +47,7 @@ function ClayConfig(settings, config, $rootContainer, meta) {
function _initializeItems() { function _initializeItems() {
_items = []; _items = [];
_itemsById = {}; _itemsById = {};
_itemsByAppKey = {}; _itemsByMessageKey = {};
_isBuilt = false; _isBuilt = false;
} }
@@ -77,15 +77,15 @@ function ClayConfig(settings, config, $rootContainer, meta) {
_itemsById[_item.id] = clayItem; _itemsById[_item.id] = clayItem;
} }
if (_item.appKey) { if (_item.messageKey) {
_itemsByAppKey[_item.appKey] = clayItem; _itemsByMessageKey[_item.messageKey] = clayItem;
} }
_items.push(clayItem); _items.push(clayItem);
// set the value of the item via the manipulator to ensure consistency // set the value of the item via the manipulator to ensure consistency
var value = typeof _settings[_item.appKey] !== 'undefined' ? var value = typeof _settings[_item.messageKey] !== 'undefined' ?
_settings[_item.appKey] : _settings[_item.messageKey] :
(_item.defaultValue || ''); (_item.defaultValue || '');
clayItem.set(value); clayItem.set(value);
@@ -154,12 +154,12 @@ function ClayConfig(settings, config, $rootContainer, meta) {
}; };
/** /**
* @param {string} appKey * @param {string} messageKey
* @returns {ClayItem} * @returns {ClayItem}
*/ */
self.getItemByAppKey = function(appKey) { self.getItemByMessageKey = function(messageKey) {
_checkBuilt('getItemByAppKey'); _checkBuilt('getItemByMessageKey');
return _itemsByAppKey[appKey]; return _itemsByMessageKey[messageKey];
}; };
/** /**
@@ -190,13 +190,13 @@ function ClayConfig(settings, config, $rootContainer, meta) {
_settings = {}; _settings = {};
_.eachObj(_itemsByAppKey, function(appKey, item) { _.eachObj(_itemsByMessageKey, function(messageKey, item) {
_settings[appKey] = { _settings[messageKey] = {
value: item.get() value: item.get()
}; };
if (item.precision) { if (item.precision) {
_settings[appKey].precision = item.precision; _settings[messageKey].precision = item.precision;
} }
}); });
return _settings; return _settings;
src/scripts/lib/clay-item.js
+1 -1
View File
@@ -29,7 +29,7 @@ function ClayItem(config) {
self.id = config.id || null; self.id = config.id || null;
/** @type {string|null} */ /** @type {string|null} */
self.appKey = config.appKey || null; self.messageKey = config.messageKey || null;
/** @type {Object} */ /** @type {Object} */
self.config = config; self.config = config;
test/fixture.js
+1 -1
View File
@@ -53,7 +53,7 @@ module.exports.configItem = function(config, autoRegister) {
var result = _.extend({}, { var result = _.extend({}, {
label: config.type + '-label', label: config.type + '-label',
appKey: 'appKey-' + idCounter, messageKey: 'messageKey-' + idCounter,
id: 'id-' + idCounter id: 'id-' + idCounter
}, config); }, config);
test/spec/index.js
+5 -5
View File
@@ -82,10 +82,10 @@ describe('Clay', function() {
var logStub = sinon.stub(console, 'log'); var logStub = sinon.stub(console, 'log');
Pebble.addEventListener Pebble.addEventListener
.withArgs('webviewclosed') .withArgs('webviewclosed')
.callArgWith(1, { response: '%7B%22appKey%22%3A%22value%22%7D' }); .callArgWith(1, { response: '%7B%22messageKey%22%3A%22value%22%7D' });
assert(Pebble.addEventListener.calledWith('webviewclosed')); assert(Pebble.addEventListener.calledWith('webviewclosed'));
assert(Pebble.sendAppMessage.calledWith({ appKey: 'value' })); assert(Pebble.sendAppMessage.calledWith({ messageKey: 'value' }));
Pebble.sendAppMessage.callArg(1); Pebble.sendAppMessage.callArg(1);
assert(logStub.calledWith('Sent config data to Pebble')); assert(logStub.calledWith('Sent config data to Pebble'));
@@ -165,7 +165,7 @@ describe('Clay', function() {
describe('string substitutions', function() { describe('string substitutions', function() {
var customFn = function() { this.getAllItems(); }; var customFn = function() { this.getAllItems(); };
var config = fixture.config(['input', 'color']); var config = fixture.config(['input', 'color']);
var settings = { appKey: 'value' }; var settings = { messageKey: 'value' };
var clay; var clay;
var html; var html;
@@ -274,12 +274,12 @@ describe('Clay', function() {
it('does not store the response if it is invalid JSON and logs an error', it('does not store the response if it is invalid JSON and logs an error',
function() { function() {
var clay = fixture.clay([]); var clay = fixture.clay([]);
localStorage.setItem('clay-settings', '{"appKey":"value"}'); localStorage.setItem('clay-settings', '{"messageKey":"value"}');
assert.throws(function() { assert.throws(function() {
clay.getSettings('not valid JSON'); clay.getSettings('not valid JSON');
}, /Not Valid JSON/i); }, /Not Valid JSON/i);
assert.equal(localStorage.getItem('clay-settings'), '{"appKey":"value"}'); assert.equal(localStorage.getItem('clay-settings'), '{"messageKey":"value"}');
}); });
it('Prepares the settings for sendAppMessage', function() { it('Prepares the settings for sendAppMessage', function() {
test/spec/lib/clay-config.js
+20 -17
View File
@@ -12,7 +12,7 @@ describe('ClayConfig', function() {
it('defines read-only properties', function() { it('defines read-only properties', function() {
var properties = [ var properties = [
'EVENTS', 'EVENTS',
'getItemByAppKey', 'getItemByMessageKey',
'getItemById', 'getItemById',
'getItemsByType', 'getItemsByType',
'serialize', 'serialize',
@@ -34,7 +34,7 @@ describe('ClayConfig', function() {
* @param {number} fwMinor * @param {number} fwMinor
* @param {Array} capabilities * @param {Array} capabilities
* @param {number} expected * @param {number} expected
* @param {number} notExpected * @param {number} [notExpected] - defaults to the inverse of `expected`
* @return {void} * @return {void}
*/ */
function testCapabilities(platform, fwMajor, fwMinor, capabilities, expected, function testCapabilities(platform, fwMajor, fwMinor, capabilities, expected,
@@ -221,7 +221,7 @@ describe('ClayConfig', function() {
describe('throws when trying to run methods before being built', function() { describe('throws when trying to run methods before being built', function() {
[ [
'getItemByAppKey', 'getItemByMessageKey',
'getItemById', 'getItemById',
'getItemsByType', 'getItemsByType',
'serialize' 'serialize'
@@ -249,14 +249,17 @@ describe('ClayConfig', function() {
}); });
}); });
describe('.getItemByAppKey()', function() { describe('.getItemByMessageKey()', function() {
it('it returns the correct item', function() { it('it returns the correct item', function() {
var config = fixtures.config([ var config = fixtures.config([
{type: 'input', appKey: 'test-app-key', clayId: 0}, {type: 'input', messageKey: 'test-app-key', clayId: 0},
{type: 'input', appKey: undefined, clayId: 1} {type: 'input', messageKey: undefined, clayId: 1}
]); ]);
var clayConfig = fixtures.clayConfig(config); var clayConfig = fixtures.clayConfig(config);
assert.deepEqual(clayConfig.getItemByAppKey('test-app-key').config, config[0]); assert.deepEqual(
clayConfig.getItemByMessageKey('test-app-key').config,
config[0]
);
}); });
}); });
@@ -287,18 +290,18 @@ describe('ClayConfig', function() {
describe('.serialize()', function() { describe('.serialize()', function() {
it('returns the correct settings', function() { it('returns the correct settings', function() {
var config = [ var config = [
{type: 'input', appKey: 'test1', defaultValue: 'default val'}, {type: 'input', messageKey: 'test1', defaultValue: 'default val'},
{type: 'select', appKey: 'test2', options: [ {type: 'select', messageKey: 'test2', options: [
{label: 'label-1', value: 'val-1'}, {label: 'label-1', value: 'val-1'},
{label: 'label-2', value: 'val-2'} {label: 'label-2', value: 'val-2'}
]}, ]},
{type: 'toggle', appKey: 'test3'}, {type: 'toggle', messageKey: 'test3'},
{type: 'checkboxgroup', appKey: 'test4', options: [ {type: 'checkboxgroup', messageKey: 'test4', options: [
{label: 'label-1', value: 'cb-1'}, {label: 'label-1', value: 'cb-1'},
{label: 'label-2', value: 'cb-2'}, {label: 'label-2', value: 'cb-2'},
{label: 'label-2', value: 'cb-3'} {label: 'label-2', value: 'cb-3'}
]}, ]},
{type: 'slider', appKey: 'test5', step: 0.05, defaultValue: 12.5} {type: 'slider', messageKey: 'test5', step: 0.05, defaultValue: 12.5}
]; ];
var settings = { var settings = {
test2: 'val-2' test2: 'val-2'
@@ -314,9 +317,9 @@ describe('ClayConfig', function() {
test5: {value: 12.5, precision: 2} test5: {value: 12.5, precision: 2}
}); });
clayConfig.getItemByAppKey('test1').set('val-1'); clayConfig.getItemByMessageKey('test1').set('val-1');
clayConfig.getItemByAppKey('test3').set(true); clayConfig.getItemByMessageKey('test3').set(true);
clayConfig.getItemByAppKey('test4').set(['cb-1', 'cb-3']); clayConfig.getItemByMessageKey('test4').set(['cb-1', 'cb-3']);
assert.deepEqual(clayConfig.serialize(), { assert.deepEqual(clayConfig.serialize(), {
test1: {value: 'val-1'}, test1: {value: 'val-1'},
@@ -347,8 +350,8 @@ describe('ClayConfig', function() {
it('only returns the settings present in the config', function() { it('only returns the settings present in the config', function() {
var config = [ var config = [
{type: 'input', appKey: 'test1', defaultValue: 'default val'}, {type: 'input', messageKey: 'test1', defaultValue: 'default val'},
{type: 'select', appKey: 'test2', options: [ {type: 'select', messageKey: 'test2', options: [
{label: 'label-1', value: 'val-1'}, {label: 'label-1', value: 'val-1'},
{label: 'label-2', value: 'val-2'} {label: 'label-2', value: 'val-2'}
]} ]}
test/spec/lib/clay-item.js
+12 -10
View File
@@ -12,7 +12,7 @@ describe('ClayItem', function() {
it('defines read-only properties', function() { it('defines read-only properties', function() {
var properties = [ var properties = [
'id', 'id',
'appKey', 'messageKey',
'config', 'config',
'$element', '$element',
'$manipulatorTarget', '$manipulatorTarget',
@@ -53,24 +53,25 @@ describe('ClayItem', function() {
}); });
}); });
describe('.appKey', function() { describe('.messageKey', function() {
it('sets appKey correctly', function() { it('sets messageKey correctly', function() {
var config = fixture.configItem('input'); var config = fixture.configItem('input');
var clayItem = new ClayItem(config); var clayItem = new ClayItem(config);
assert.strictEqual(clayItem.appKey, config.appKey); assert.strictEqual(clayItem.messageKey, config.messageKey);
}); });
it('sets appKey to null if there is no appKey in the config', function() { it('sets messageKey to null if there is no messageKey in the config',
var clayItem = fixture.clayItem({type: 'input', appKey: undefined}); function() {
assert.strictEqual(clayItem.appKey, null); var clayItem = fixture.clayItem({type: 'input', messageKey: undefined});
assert.strictEqual(clayItem.messageKey, null);
}); });
}); });
describe('.config', function() { describe('.config', function() {
it('sets appKey correctly', function() { it('sets messageKey correctly', function() {
var config = fixture.configItem('input'); var config = fixture.configItem('input');
var clayItem = new ClayItem(config); var clayItem = new ClayItem(config);
assert.strictEqual(clayItem.appKey, config.appKey); assert.strictEqual(clayItem.messageKey, config.messageKey);
}); });
}); });
@@ -104,7 +105,8 @@ describe('ClayItem', function() {
it('returns itself for chaining', function() { it('returns itself for chaining', function() {
var clayItem = fixture.clayItem('select'); var clayItem = fixture.clayItem('select');
assert.strictEqual(clayItem.initialize(), clayItem); var clayConfig = fixture.clayConfig([]);
assert.strictEqual(clayItem.initialize(clayConfig), clayItem);
}); });
it('does nothing if there is no initialize function', function() { it('does nothing if there is no initialize function', function() {