Compare commits

..
28 Commits
Author SHA1 Message Date
Keegan Lillo 1bf6db0809 Release v1.0.4 (#156) 2016-11-21 12:09:01 -08:00
Keegan Lillo 4b53d920c7 #77 - Add docs for setSettings() (#155) 2016-11-21 11:32:53 -08:00
Keegan Lillo fa3406a809 #151 - Fix incorrect value being set when defaultValue is falsey (#152) 2016-10-21 12:11:12 -07:00
Yohan Robert 46c0adb62c #77 - Allow claySettings to be modified from app.js (#150)
* .setSettings(key, value) to set a single setting
* .setSettings(object) to set multiple settings at once
2016-10-21 10:36:55 -07:00
Keegan Lillo d18170337d Release/v1.0.3 (#148) 2016-10-18 09:47:32 -07:00
Keegan Lillo 9c7238d578 #124/get items by group (#147)
* Add getItemsByGroup function

* Update test

* update readme

* Update README for submit button

* Update docs with ID prop for button and submit components
2016-10-18 09:40:32 -07:00
Keegan Lillo 1a63761e43 #141 - Use index.js not app.js in docs (#142) 2016-09-29 01:15:45 -07:00
Ben Combee 9c6bb48c7a fix copy-paste error with messageKey in ClayItem description (#138) 2016-09-14 23:42:36 -07:00
Jon Barlow 2173ad7c71 Add some note about Rocky.js (#134) 2016-08-17 13:51:22 +01:00
Keegan Lillo b8db6c6a90 Direct pebble.js users to v0.1.7 and fix typos 2016-07-11 11:29:06 -07:00
Keegan Lillo 62f0337198 release/v1.0.2 (#129) 2016-07-08 15:28:29 -07:00
Grégoire Sage eb89496733 #123 - Add 'configurable' capability 2016-07-08 15:06:59 -07:00
Grégoire Sage 5d6e070e01 #108 Fix colorpicker for Diorite 2016-07-08 14:56:45 -07:00
Keegan Lillo ae31f9737f #120 - Fixed Error: Cannot find module 'message_keys' in dev script 2016-06-23 23:39:06 -07:00
Keegan Lillo 6e42537aa1 #118/Add Configurable should be checked to cloudpebble getting started (#119) 2016-06-23 11:57:56 -07:00
Keegan Lillo 2b14076171 #86/Added contribution instructions (#111)
* Added contribution instructions

* remove production mode in the contributing guide.

* Remove squashing commits from contributing guide

* Add better examples for style guide.

* Add getting help section

* Change devsupport email to twitter

* Add link to contributing guide from the main readme
2016-06-20 15:32:40 -07:00
Keegan Lillo 55ac8681af Merge pull request #115 from pebble/documentation-update
Remove straggling reference to appinfo.js from README
2016-06-19 17:19:45 -07:00
Keegan Lillo b5d2615307 Remove straggling reference to appinfo.js from README 2016-06-19 16:48:49 -07:00
Keegan Lillo 6742ec84cf Merge pull request #113 from pebble/update-docs-to-new-require-mothod
Update README.md
2016-06-19 13:32:26 -07:00
Keegan Lillo 61d735662e Update README.md 2016-06-19 13:28:15 -07:00
Keegan Lillo 050b89f82f Merge pull request #112 from pebble/#110/add-get-settings-to-migration-guide
#110/add get settings to migration guide
2016-06-18 00:59:41 -07:00
Keegan 1b179a603a Added the changed behavior of clay.getSettings() to migration guide 2016-06-18 00:55:15 -07:00
Keegan 4a6382aa7f Remove unused function parameter in clay.getSettings() 2016-06-18 00:50:53 -07:00
Keegan Lillo f0c44c5719 Merge pull request #107 from pebble/release/v1.0.1
Bump version to 1.0.1
2016-06-17 17:11:07 -07:00
Keegan 2c2076bf69 Bump version to 1.0.1 2016-06-17 17:07:29 -07:00
Keegan Lillo 5a67fec99e Merge pull request #106 from pebble/update-docs-with-new-array-syntax
Fixed some straggling mentions of the old array behavior
2016-06-16 16:42:19 -07:00
Keegan 7cadd5fba4 update JSDoc on the Clay.prepareForAppMessage() method 2016-06-16 14:55:42 -07:00
Keegan Lillo 6b59844084 Fixed some straggling mentions of the old array behavior 2016-06-16 14:52:31 -07:00
11 changed files with 491 additions and 126 deletions
+198
View File
@@ -0,0 +1,198 @@
# Contributing
Thanks for checking out Clay. We accept pull requests from anybody, however we ask
that you follow some conventions when contributing to Clay.
We have set up a
[piece-of-cake](https://github.com/pebble/clay/issues?q=is%3Aopen+is%3Aissue+label%3Apiece-of-cake)
label in GitHub issues for bugs/features that are easy to implement. These issues are
a great place to start for people that are new to the codebase.
## Requirements
- [Node](https://nodejs.org) (4.0 and later)
- [Google Chrome](www.google.com/chrome) (To run tests)
- [Pebble SDK](https://developer.pebble.com/sdk/) (optional)
## Getting Started
### 1. Fork, then clone the repo:
`$ git clone git@github.com:your-username/clay.git`
### 2. Create a new branch with the following naming convention.
`#<issue-id>/description-of-change`
example:
`#90/support-message-keys`
If there is currently no GitHub issue open for your proposed contribution,
then please make one. This allows us to assign milestones and triage priority.
### 3. Install the project dependencies.
`$ npm install`
### 4. Develop your feature
Commit as often as you like. Your branch will be squashed when the pull request is merged.
### 5. Run the tests
`$ npm run test`
### 6. Run linting
`$ npm run lint`
### 7. Submit your pull request
In the main comment of the pull request, you must state the GitHub issue that your PR
resolves. You do this by using the syntax `Resolves #<issue-id>`. An example of this
can be found [here](https://github.com/pebble/clay/pull/81)
# Project Structure and Development
## Important Files
There are two main entry points for Clay - `index.js` and `src/scripts/config-page.js`.
### index.js
This is the main entry point for the code that will run in the Pebble app's `src/js/app.js`.
It is responsible for serializing the provided config into a data URI that will be opened
using `Pebble.openURL()`. It also persists data to `localStorage`.
### src/scripts/config-page.js
This is the main entry point for the code that runs on the generated config page,
and is responsible for passing the injected config and other components to the
`ClayConfig` class.
## Building
Use the following command to build Clay during development.
`$ npm run dev`
This command packages up `src/scripts/config-page.js` and `dev/dev.js` into the `tmp/` directory
so `dev/dev.html` can include them as script tags. This will also watch for changes
in the project.
While developing components and other functionality for Clay, it is much easier to
work with the files in the `dev/` directory than on a phone or emulator. Below is
an explanation of the files and their purpose.
| File | Purpose |
|----------|-----|
| `dev.html` | Open this page in a browser after running `$ npm run dev`. |
| `dev.js` | Injects the components and dependencies into the window the same way `index.js` would. |
| `config.js` | Clay config to use as a sandbox for testing components. |
| `custom-fn.js` | Clay custom function to be injected by `dev.js`. |
| `emulator.html` | Copy of the HTML page that is used to make the Clay compatible with the Pebble SDK emulator. |
| `uri-test.html` | Used to stress test URI creation for older browser versions. |
## Testing your change inside of a test project.
Once your change is ready to be tested in the emulator or on the watch, follow these steps:
1. From your Clay fork run `$ npm run pebble-build`. This builds Clay to work with the Pebble SDK
2. From your test Pebble project, run `$ pebble package install /path/to/your/clay/fork`.
This will modify your `package.json` to point directly to your local copy of Clay.
3. Run the usual`$ pebble build && pebble install --emulator basalt && pebble emu-app-config` to test your modifications
4. If you make modifications to your fork of Clay, you must repeat the above steps.
## Functionality
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()`,
`.getItemByMessageKey()`, `.getItemById()`, `.getItemsByType()`.
## Testing
Clay enforces 100% test coverage. Chances are, that if you are submitting a pull request,
there should be tests for the proposed code changes. Have a look at the other tests in
the repository to see some examples of how you should be writing your tests.
There are two commands to use while writing your tests.
- `$ npm run test` - Runs all tests once.
- `$ npm run test-debug` - Watches for file changes and re-runs all tests when it
detects a change. This also leaves an in instance of Google Chrome running.
If you click the "Debug" button in the top right of the page, a new tab will open.
You can then use the Google Chrome developer tools to debug your tests as they run.
Refreshing the page will re-run the tests.
## Style Guide
Our style guide is very similar to the
[Airbnb style guide.](https://github.com/airbnb/javascript/tree/master/es5) with the
following exceptions:
- When saving a reference to `this` use `self`.
```javascript
// bad
function() {
var _this = this;
return function() {
console.log(_this);
};
}
// bad
function() {
var that = this;
return function() {
console.log(that);
};
}
// good
function() {
var self = this;
return function() {
console.log(self);
};
}
```
- Don't double name your functions. It makes refactoring more difficult.
```javascript
// bad
var log = function log(msg) {
console.log(msg);
};
// good
var log = function(msg) {
console.log(msg);
};
```
The style guide is enforced using ESLint. Run `$ npm run lint` to ensure you are
adhering to the style guide.
## Getting Help
- Chat to us in the `#clay` channel on slack. http://slack.pbldev.io/
- Visit the [Pebble Forums](https://forums.pebble.com/)
- Tweet at [@pebbledev](https://twitter.com/pebbledev)
- More options at https://developer.pebble.com/community/online/
+140 -111
View File
@@ -1,16 +1,18 @@
# 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 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 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 `package.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 distributed as a [Pebble package](https://developer.pebble.com/guides/pebble-packages/) so it is super easy to include in your project. If you are upgrading from v0.1.x of Clay you need to follow the [migration guide](#migrating-from-v01x-to-v1x) before you can get started.
If you would like to contribute to Clay, check out the [contributing guide.](CONTRIBUTING.md)
# Getting Started (SDK 3.13 or higher)
1. Run `pebble package install pebble-clay` to install the package in your project
2. Create a JSON file called `config.json` and place it in your `src/js` directory.
3. In order for JSON files to work you may need to change a line in your `wscript` from `ctx.pbl_bundle(binaries=binaries, js=ctx.path.ant_glob('src/js/**/*.js'))` to `ctx.pbl_bundle(binaries=binaries, js=ctx.path.ant_glob(['src/js/**/*.js', 'src/js/**/*.json']))`.
4. Your `app.js` file needs to `require` clay and your config file, then be initialized. Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events. Copy and paste the following into the top of your `app.js` file:
4. Your `index.js` (`app.js` in SDK 3) file needs to `require` clay and your config file, then be initialized. Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events. Copy and paste the following into the top of your `index.js` file:
```javascript
var Clay = require('pebble-clay');
@@ -30,7 +32,7 @@ Clay is distributed as a [Pebble package](https://developer.pebble.com/guides/pe
```javascript
module.exports = [];
```
5. Your `app.js` file needs to `require` clay and your config file, then be initialized. Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events. Copy and paste the following into the top of your `app.js` file:
5. Your `index.js` file needs to `require` clay and your config file, then be initialized. Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events. Copy and paste the following into the top of your `app.js` file:
```javascript
var Clay = require('pebble-clay');
@@ -40,6 +42,12 @@ Clay is distributed as a [Pebble package](https://developer.pebble.com/guides/pe
6. Next is the fun part - creating your config page. Edit your `config.js` file to build a layout of elements as described in the sections below.
7. Make sure you have defined all of your message keys using `Automatic assignment` in your project settings. More info on how that works [here.](https://developer.pebble.com/guides/communication/using-pebblekit-js/#defining-keys)
# Getting Started (Pebble.js)
If you are using [Pebble.js](https://developer.pebble.com/docs/pebblejs/) and would like to use Clay, The setup process is a little different. Pebble.js does not currently support message keys so you will have to use [v0.1.7](https://github.com/pebble/clay/releases/v0.1.7) of Clay. Follow the instructions in the [readme for that version.](https://github.com/pebble/clay/blob/v0.1.7/README.md)
# Getting Started (Rocky.js)
If you are using [Rocky.js](https://developer.pebble.com/docs/rockyjs/) and would like to use Clay, please be aware that this is currently unsupported. It is possible to install the Clay package and override the 'showConfiguration' and 'webviewclosed' events and handle them manually, but Rocky.js does not currently support persistent storage, so the settings must be loaded from the phone each time. You can find an example of using Clay with Rocky.js [here](https://github.com/orviwan/rocky-leco-clay).
# Creating Your Config File
Clay uses JavaScript object notation (or JSON) to generate the config page for you. The structure of the page is up to you, but you do need to follow some basic rules.
@@ -118,11 +126,12 @@ Headings can be used in anywhere and can have their size adjusted to suit the co
| Property | Type | Description |
|----------|------|-------------|
| 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.getItemById()` in your [custom function](#custom-function). |
| 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. |
| 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 |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -149,10 +158,11 @@ Text is used to provide descriptions of sections or to explain complex parts of
| Property | Type | Description |
|----------|------|-------------|
| 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.getItemById()` in your [custom function](#custom-function). |
| 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. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -177,13 +187,14 @@ Standard text input field.
| Property | Type | Description |
|----------|------|-------------|
| 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.getItemById()` in your [custom function](#custom-function). |
| 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. |
| defaultValue | string | The default value of the input field. |
| description | string | Optional sub-text to include below the component |
| attributes | object | An object containing HTML attributes to set on the input field. Set `type` to values such as "email", "time", "date" etc to adjust the behavior of the component. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -215,12 +226,13 @@ Switch for a single item.
| Property | Type | Description |
|----------|------|-------------|
| 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.getItemById()` in your [custom function](#custom-function). |
| 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. |
| 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 |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -247,13 +259,14 @@ A dropdown menu containing multiple options.
| Property | Type | Description |
|----------|------|-------------|
| 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.getItemById()` in your [custom function](#custom-function). |
| 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. |
| 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 |
| options | array of objects | The options you want to appear in the dropdown menu. Each option is an object with a `label` and `value` property. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -353,7 +366,7 @@ The color picker will automatically show a different layout depending on the wat
| Property | Type | Description |
|----------|------|-------------|
| 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.getItemById()` in your [custom function](#custom-function). |
| 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. |
| 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. |
@@ -362,6 +375,7 @@ The color picker will automatically show a different layout depending on the wat
| layout | string OR array | Optional. Use a custom layout for the color picker. Defaults to automatically choosing the most appropriate layout for the connected watch. The layout is represented by a two dimensional array. Use `false` to insert blank spaces. You may also use one of the preset layouts by setting `layout` to: `"COLOR"`, `"GRAY"` or `"BLACK_WHITE"` |
| allowGray | boolean | Optional. Set this to `true` to include gray (`#AAAAAA`) in the color picker for aplite running on firmware 3 and above. This is optional because only a subset of the drawing operations support gray on aplite. Defaults to `false` |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -419,13 +433,14 @@ A list of options allowing the user can only choose one option to submit.
| Property | Type | Description |
|----------|------|-------------|
| 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.getItemById()` in your [custom function](#custom-function). |
| 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. |
| defaultValue | string | The default selected item. Must match a value in the `options` array. |
| description | string | Optional sub-text to include below the component |
| options | array of objects | The options you want to appear in the radio group. Each option is an object with a `label` and `value` property. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -464,13 +479,14 @@ A list of options where a user may choose more than one option to submit.
| Property | Type | Description |
|----------|------|-------------|
| 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.getItemById()` in your [custom function](#custom-function). |
| 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. **NOTE:** The checkboxgroup component will expect you to have defined a `messageKey` in your `package.json` using array syntax. In the example below, the matching entry in the `package.json` would be `favorite_food[3]`. In CloudPebble, you must use `Automatic assignment` for message keys and the `Key Array Length` must match the number of options in the checkboxgroup |
| label | string | The label that should appear next to this item. |
| defaultValue | array of booleans | The default selected items. |
| description | string | Optional sub-text to include below the component |
| options | array of strings | The labels for each checkbox you want to appear in the checkbox group. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -497,10 +513,12 @@ In the above example, Sushi and Burgers will be selected by default.
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `button`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| defaultValue | string | The text displayed on the button. |
| primary | boolean | If `true` the button will be orange, if `false`, the button will be gray (defaults to `false`)|
| description | string | Optional sub-text to include below the component |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -539,6 +557,7 @@ you must just remember to divide the received value on the watch accordingly.
| step | number | The multiple of the values allowed to be set on the slider. The slider will snap to these values. This value also determines the precision used when the value is sent to the watch. Defaults to 1 |
| description | string | Optional sub-text to include below the component |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -569,7 +588,9 @@ The submit button for the page. You **MUST** include this component somewhere in
|----------|------|-------------|
| type | string | Set to `submit`. |
| defaultValue | string | The text displayed on the button. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -786,7 +807,7 @@ Clay will by default, automatically handle the 'showConfiguration' and 'webviewc
Example:
```javascript
var Clay = require('./clay');
var Clay = require('pebble-clay');
var clayConfig = require('./config');
var clayConfigAplite = require('./config-aplite');
var clay = new Clay(clayConfig, null, { autoHandleEvents: false });
@@ -820,51 +841,6 @@ Pebble.addEventListener('webviewclosed', function(e) {
});
```
## Clay and Pebble.js
If you are using [Pebble.js](https://developer.pebble.com/docs/pebblejs/) and would like to use Clay, There are some extra steps to follow:
1. Remove all your `Settings.config` calls. Clay will handle the settings from now on.
2. Use the example below to modify your `app.js`. Notice that `autoHandleEvents` is set to `false` in the Clay constructor.:
```javascript
var Settings = require('settings');
var Clay = require('./clay');
var clayConfig = require('./config');
var clay = new Clay(clayConfig, null, {autoHandleEvents: false});
Pebble.addEventListener('showConfiguration', function(e) {
Pebble.openURL(clay.generateUrl());
});
Pebble.addEventListener('webviewclosed', function(e) {
if (e && !e.response) {
return;
}
var dict = clay.getSettings(e.response);
// Save the Clay settings to the Settings module.
Settings.option(dict);
});
```
### Caveats
Clay treats colors as numbers. You will need to convert these numbers to CSS colors before they can be used by Pebble.js. Use the function below to convert the colors.
```javascript
function cssColor(color) {
color = color.toString(16);
while (color.length < 6) {
color = '0' + color;
}
return '#' + color;
}
// Example usage with default:
cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000);
```
## Clay API (app.js)
### `Clay([Array] config, [function] customFn, [object] options)`
@@ -899,7 +875,41 @@ 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. |
| `.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. |
| `.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 |
| `.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. <br><br>This method will do some conversions depending on the type of the setting. Arrays will use message key array syntax to make the values of each item in the array available as individual message keys. Booleans will be converted to numbers. eg `true` becomes `1` and `false` becomes `0`. If the value is a number or an array of numbers and the optional property: "precision" is the power of precision (value * 10 ^ precision) and then floored. Eg: `1.4567` with a precision set to `3` will become `1456`. Pass `false` as the second parameter to disable this behavior. See the example below for how this all works |
| `.setSettings( [string] key, [*] value )` <br> `key` - The key for the setting you want to set. <br> `value` - The value of the setting you want to set. | `void` |
| `.setSettings( [object] settings )` <br> `settings` - An object of key/value pairs that you would like to update the settings with. eg `{ user_name: 'Emily', show_animations: true }` | `void` |
#### `.getSettings()` Example
```javascript
// webviewclosed response
{
"favorite_food": {"value": [1, 0, 1]},
"cool_things_enabled": {"value": true},
"user_name": {"value": "Jane Doe"},
"date_of_birth[0]": {"value": 1989},
"date_of_birth[1]": {"value": 11},
"date_of_birth[2]": {"value": 28},
"rating": {"value": 3.5, "precision": 1},
}
// resulting converted values
var messageKeys = require('message_keys');
messageKeys.favorite_food + 0 = 1;
messageKeys.favorite_food + 1 = 0;
messageKeys.favorite_food + 2 = 1;
messageKeys.cool_things_enabled = 1;
messageKeys.user_name = 'Jane Doe';
messageKeys.date_of_birth + 0 = 1989;
messageKeys.date_of_birth + 1 = 11;
messageKeys.date_of_birth + 2 = 28;
messageKeys.rating = 35;
```
---
@@ -919,7 +929,7 @@ Make sure to always wait for the config page to be built before manipulating ite
##### app.js
```javascript
var Clay = require('./clay');
var Clay = require('pebble-clay');
var clayConfig = require('./config');
var customClay = require('./custom-clay');
var userData = {token: 'abc123'}
@@ -996,6 +1006,7 @@ This is the main way of talking to your generated config page. An instance of th
| `.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`. |
| `.getItemsByType( [string] type )` | `Array.<ConfigItem>` - an array of config items that match the provided `type`. |
| `.getItemsByGroup( [string] group )` | `Array.<ConfigItem>` - an array of config items that match the provided `group`. |
| `.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` |
| `.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` |
@@ -1013,7 +1024,7 @@ This is the main way of talking to your generated config page. An instance of th
| Property | Type | Description |
|----------|------|-------------|
| `.id` | String | The ID of the item if provided in the config. |
| `.messageKey` | String | The ID of the item if provided in the config. |
| `.messageKey` | String | The messageKey of the item if provided in the config. |
| `.config` | Object | Reference to the config passed to the constructer. |
| `$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. |
@@ -1056,7 +1067,7 @@ Components are simple objects with the following properties.
Components must be registered before the config page is built. The easiest way to do this is in your `app.js` after you have initialized Clay:
```javascript
var Clay = require('./clay');
var Clay = require('pebble-clay');
var clayConfig = require('./config.json');
var clay = new Clay(clayConfig);
@@ -1093,56 +1104,6 @@ clay.registerComponent(require('./my-custom-component'));
- `_.template()`
- `_.isObject()`
# Project Structure and Development
There are two main entry points for Clay - `index.js` and `src/scripts/config-page.js`.
#### index.js
This is the main entry point for the code that will run in the Pebble app's `src/js/app.js`. It is responsible for serializing the provided config into a data URI that will be opened using `Pebble.openURL()`. It also persists data to `localStorage`.
#### src/scripts/config-page.js
This is the main entry point for the code that runs on the generated config page, and is responsible for passing the injected config and other components to the `ClayConfig` class.
### Building
There are two ways to build Clay, production mode and development mode.
#### Production Mode
```
$ npm run build
```
Packages up the entire Clay project into `dist/clay.js` to be required in the developer's `app.js`.
#### Development Mode
```
$ npm run dev
```
Packages up `src/scripts/config-page.js` and `dev/dev.js` into the `tmp/` directory so `dev/dev.html` can include them as script tags. This will also watch for changes in the project.
While developing components and other functionality for Clay, it is much easier to work with the files in the `dev/` directory than on a phone or emulator. Below is an explanation of the files and their purpose.
| File | Purpose |
|----------|-----|
| `dev.html` | Open this page in a browser after running `$ npm run dev`. |
| `dev.js` | Injects the components and dependencies into the window the same way `index.js` would. |
| `config.js` | Clay config to use as a sandbox for testing components. |
| `custom-fn.js` | Clay custom function to be injected by `dev.js`. |
| `emulator.html` | Copy of the HTML page that is used to make the Clay compatible with the Pebble SDK emulator. |
| `uri-test.html` | Used to stress test URI creation for older browser versions. |
## Functionality
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()`, `.getItemByMessageKey()`, `.getItemById()`, `.getItemsByType()`.
# Migrating from v0.1.x to v1.x
There were some changes in the 3.13 SDK that required Clay to undergo some major changes. For the majority of developers a simple find and replace over your config will do the trick.
@@ -1176,6 +1137,74 @@ becomes:
If you have a [custom function](#custom-function) and are using the `clayConfig.getItemByAppKey()` method you will need to change this to `clayConfig.getItemByMessageKey()`
### clay.getSettings() will now by default, return an object where the keys are numbers.
In the past, `clay.getSettings()` would return something that looked like:
```javascript
{
BACKGROUND_COLOR: 0,
NAME: 'Jane Doe',
ENABLE_TOOLS: 1
}
```
It now uses the values provided in the `message_keys` module to construct this object.
The new format looks something like:
```javascript
{
10000: 0,
10001: 'Jane Doe',
10002: 1
}
```
If you wish to find out what keys are associated with what values, you must use the `message_keys` module.
```javascript
var messageKeys = require('message_keys');
Pebble.addEventListener('webviewclosed', function(e) {
// Get the keys and values from each config item
var claySettings = clay.getSettings(e.response);
// In this example messageKeys.NAME is equal to 10001
console.log('Name is ' + claySettings[messageKeys.NAME]); // Logs: "Name is Jane Doe"
});
```
**NOTE:** The above only applies to the default behavior of the method. If you pass
`false` to the second argument, a standard object will be returned with the `messageKey`
as the key.
```javascript
Pebble.addEventListener('webviewclosed', function(e) {
clay.getSettings(e.response);
/* returns:
{
10000: 0,
10001: 'Jane Doe',
10002: 1
}
*/
clay.getSettings(e.response, false);
/* returns:
{
BACKGROUND_COLOR: {value: 0},
NAME: {value: 'Jane Doe'},
ENABLE_TOOLS: {value: true}
}
Notice that the value for ENABLE_TOOLS was not converted to a number from a boolean
*/
});
```
### Checkbox groups now use arrays.
In the previous version of Clay, checkbox groups would split the values of the items with zeros. This made for clumsy usage on the C side. Checkbox groups are now much simpler to use thanks to message keys. You will however need to update you config to the new format.
+3 -3
View File
@@ -64,11 +64,11 @@ module.exports = [
{
"type": "slider",
"messageKey": "slider",
"defaultValue": 15,
"defaultValue": 0,
"label": "Slider",
"description": "This is the description for the slider",
"min": 10,
"max": 20,
"min": 0,
"max": 30,
"step": 0.25
},
{
+1
View File
@@ -109,6 +109,7 @@ gulp.task('dev-js', ['js', 'sass'], function() {
.transform('deamdify')
.transform(sassify, sassifyOptions)
.transform(autoprefixify, autoprefixerOptions)
.ignore('message_keys')
.bundle()
.pipe(source('dev.js'))
.pipe(gulp.dest('./tmp/'));
+37 -6
View File
@@ -210,9 +210,40 @@ Clay.prototype.getSettings = function(response, convert) {
localStorage.setItem('clay-settings', JSON.stringify(settingsStorage));
return convert === false ?
settings :
Clay.prepareSettingsForAppMessage(settings, messageKeys);
return convert === false ? settings : Clay.prepareSettingsForAppMessage(settings);
};
/**
* Updates the settings with the given value(s).
*
* @signature `clay.setSettings(key, value)`
* @param {String} key - The property to set.
* @param {*} value - the value assigned to _key_.
* @return {undefined}
*
* @signature `clay.setSettings(settings)`
* @param {Object} settings - an object containing the key/value pairs to be set.
* @return {undefined}
*/
Clay.prototype.setSettings = function(key, value) {
var settingsStorage = {};
try {
settingsStorage = JSON.parse(localStorage.getItem('clay-settings')) || {};
} catch (e) {
console.error(e.toString());
}
if (typeof key === 'object') {
var settings = key;
Object.keys(settings).forEach(function(key) {
settingsStorage[key] = settings[key];
});
} else {
settingsStorage[key] = value;
}
localStorage.setItem('clay-settings', JSON.stringify(settingsStorage));
};
/**
@@ -230,8 +261,8 @@ Clay.encodeDataUri = function(input, prefix) {
* - Strings will be returned without modification
* - Numbers will be returned without modification
* - Booleans will be converted to a 0 or 1
* - Arrays that contain strings will be split with a zero.
* eg: ['one', 'two'] becomes ['one', 0, 'two', 0]
* - Arrays that contain strings will be returned without modification
* eg: ['one', 'two'] becomes ['one', 'two']
* - Arrays that contain numbers will be returned without modification
* eg: [1, 2] becomes [1, 2]
* - Arrays that contain booleans will be converted to a 0 or 1
@@ -239,7 +270,7 @@ Clay.encodeDataUri = function(input, prefix) {
* - Arrays must be single dimensional
* - Objects that have a "value" property will apply the above rules to the type of
* value. If the value is a number or an array of numbers and the optional
* property: "precision" is provided, then the number will be multipled by 10 to
* property: "precision" is provided, then the number will be multiplied by 10 to
* the power of precision (value * 10 ^ precision) and then floored.
* Eg: 1.4567 with a precision set to 3 will become 1456
* @param {number|string|boolean|Array|Object} val
+5 -2
View File
@@ -1,6 +1,6 @@
{
"name": "pebble-clay",
"version": "1.0.0",
"version": "1.0.4",
"description": "Pebble Config Framework",
"scripts": {
"test-travis": "./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --single-run --browsers chromeTravisCI && ./node_modules/.bin/eslint ./",
@@ -40,7 +40,10 @@
],
"resources": {
"media": []
}
},
"capabilities": [
"configurable"
]
},
"homepage": "https://github.com/pebble/clay#readme",
"devDependencies": {
+3 -2
View File
@@ -116,12 +116,13 @@ module.exports = {
function autoLayout() {
if (!clay.meta.activeWatchInfo ||
clay.meta.activeWatchInfo.firmware.major === 2 ||
clay.meta.activeWatchInfo.platform === 'aplite' &&
['aplite', 'diorite'].indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
!self.config.allowGray) {
return standardLayouts.BLACK_WHITE;
}
if (clay.meta.activeWatchInfo.platform === 'aplite' && self.config.allowGray) {
if (['aplite', 'diorite'].indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
self.config.allowGray) {
return standardLayouts.GRAY;
}
+13 -2
View File
@@ -86,9 +86,9 @@ function ClayConfig(settings, config, $rootContainer, meta) {
// set the value of the item via the manipulator to ensure consistency
var value = typeof _settings[_item.messageKey] !== 'undefined' ?
_settings[_item.messageKey] :
(_item.defaultValue || '');
_item.defaultValue;
clayItem.set(value);
clayItem.set(typeof value !== 'undefined' ? value : '');
$container.add(clayItem.$element);
}
@@ -182,6 +182,17 @@ function ClayConfig(settings, config, $rootContainer, meta) {
});
};
/**
* @param {string} group
* @returns {Array.<ClayItem>}
*/
self.getItemsByGroup = function(group) {
_checkBuilt('getItemsByGroup');
return _items.filter(function(item) {
return item.config.group === group;
});
};
/**
* @returns {Object}
*/
+22
View File
@@ -434,6 +434,28 @@ describe('component - color', function() {
suffix: ''
}
});
testAutoLayout('diorite', standardLayouts.BLACK_WHITE, false, '', {
platform: 'diorite',
model: 'qemu_platform_diorite',
language: 'en_US',
firmware: {
major: 4,
minor: 0,
patch: 0,
suffix: ''
}
});
testAutoLayout('diorite', standardLayouts.GRAY, true, '', {
platform: 'diorite',
model: 'qemu_platform_diorite',
language: 'en_US',
firmware: {
major: 4,
minor: 0,
patch: 0,
suffix: ''
}
});
testCustomLayout();
testCustomLayout('COLOR');
+48
View File
@@ -386,6 +386,54 @@ describe('Clay', function() {
});
});
describe('.setSettings', function() {
it('it writes to localStorage when passing an object',
function() {
var clay = fixture.clay([]);
var settings = {
key1: 'value1',
key2: 'value2'
};
var expected = {
key1: 'value1',
key2: 'value2'
};
clay.setSettings(settings);
assert.equal(
localStorage.getItem('clay-settings'),
JSON.stringify(expected)
);
});
it('it writes to localStorage when passing a key and a value',
function() {
var clay = fixture.clay([]);
var expected = {
key1: 'value1',
key2: 'value2%7Dbreaks'
};
clay.setSettings('key1', 'value1');
clay.setSettings('key2', 'value2%7Dbreaks');
assert.equal(localStorage.getItem('clay-settings'),
JSON.stringify(expected)
);
});
it('doesn\'t throw and logs an error if settings in localStorage are broken',
function() {
var clay = fixture.clay([]);
var errorStub = sinon.stub(console, 'error');
localStorage.setItem('clay-settings', 'not valid JSON');
assert.doesNotThrow(function() {
clay.setSettings('key', 'value');
});
assert(errorStub.calledWithMatch(/SyntaxError/i));
errorStub.restore();
});
});
describe('.meta', function() {
var emptyMeta = {
activeWatchInfo: null,
+21
View File
@@ -15,6 +15,7 @@ describe('ClayConfig', function() {
'getItemByMessageKey',
'getItemById',
'getItemsByType',
'getItemsByGroup',
'serialize',
'registerComponent',
'build',
@@ -224,6 +225,7 @@ describe('ClayConfig', function() {
'getItemByMessageKey',
'getItemById',
'getItemsByType',
'getItemsByGroup',
'serialize'
].forEach(function(method) {
it('.' + method + '()', function() {
@@ -287,6 +289,25 @@ describe('ClayConfig', function() {
});
});
describe('.getItemsByGroup()', function() {
it('it returns the correct items', function() {
var config = fixtures.config([
{type: 'input', id: 'g1-0', group: 'group1'},
{type: 'text', id: 'g2-0', group: 'group2'},
{type: 'input', id: 'g1-1', group: 'group1'}
]);
var clayConfig = fixtures.clayConfig(config);
assert.deepEqual(clayConfig.getItemsByGroup('group1'), [
clayConfig.getItemById('g1-0'),
clayConfig.getItemById('g1-1')
]);
assert.deepEqual(clayConfig.getItemsByGroup('group2'), [
clayConfig.getItemById('g2-0')
]);
});
});
describe('.serialize()', function() {
it('returns the correct settings', function() {
var config = [