mirror of
https://github.com/pebble-dev/clay.git
synced 2026-08-29 13:26:59 -04:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c1b87080f1 | ||
|
|
b2e9ed2392 | ||
|
|
75548a1c04 | ||
|
|
900b03de1d | ||
|
|
cc0e88598f | ||
|
|
078186cd25 | ||
|
|
b55a4c6c61 | ||
|
|
4dad63ea90 | ||
|
|
6335169e9a | ||
|
|
1bf6db0809 | ||
|
|
4b53d920c7 | ||
|
|
fa3406a809 | ||
|
|
46c0adb62c | ||
|
|
d18170337d | ||
|
|
9c7238d578 | ||
|
|
1a63761e43 | ||
|
|
9c6bb48c7a | ||
|
|
2173ad7c71 | ||
|
|
b8db6c6a90 |
@@ -0,0 +1,11 @@
|
||||
# To get started with Dependabot version updates, you'll need to specify which
|
||||
# package ecosystems to update and where the package manifests are located.
|
||||
# Please see the documentation for all configuration options:
|
||||
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "npm" # See documentation for possible values
|
||||
directory: "/" # Location of package manifests
|
||||
schedule:
|
||||
interval: "daily"
|
||||
@@ -0,0 +1,29 @@
|
||||
name: Build CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
container:
|
||||
image: ghcr.io/pebble-dev/pebbleos-docker:v1
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up uv
|
||||
uses: astral-sh/setup-uv@v7
|
||||
- run: uv tool install pebble-tool
|
||||
- run: npm install
|
||||
- run: npm run build
|
||||
- run: pebble build
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: clay
|
||||
path: dist.zip
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
name: Lint CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: 'npm'
|
||||
- run: npm install
|
||||
- run: npm run lint
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
name: Node.js Package
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [created]
|
||||
|
||||
permissions:
|
||||
id-token: write
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
publish-npm:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
container:
|
||||
image: ghcr.io/pebble-dev/pebbleos-docker:v1
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up uv
|
||||
uses: astral-sh/setup-uv@v7
|
||||
- run: uv tool install pebble-tool
|
||||
- run: npm install
|
||||
- run: npm run build
|
||||
- run: pebble build
|
||||
- name: Update npm
|
||||
run: npm install -g npm@latest
|
||||
- run: npm publish
|
||||
@@ -0,0 +1,34 @@
|
||||
name: Test CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: 'npm'
|
||||
- name: Setup Chrome
|
||||
uses: browser-actions/setup-chrome@v2
|
||||
id: setup-chrome
|
||||
with:
|
||||
install-dependencies: true
|
||||
- run: npm install
|
||||
- run: npm run build
|
||||
- name: Run headless test
|
||||
uses: coactions/setup-xvfb@v1
|
||||
with:
|
||||
run: npm run test-travis
|
||||
env:
|
||||
CHROME_BIN: ${{ steps.setup-chrome.outputs.chrome-path }}
|
||||
|
||||
+2
-1
@@ -3,7 +3,7 @@
|
||||
|
||||
# node-waf configuration
|
||||
.lock-wscript
|
||||
/.lock-waf_darwin_build
|
||||
/.lock-waf_*_build
|
||||
|
||||
# Dependency directory
|
||||
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
|
||||
@@ -13,4 +13,5 @@
|
||||
/tmp/
|
||||
/src/js/index.js
|
||||
/dist.zip
|
||||
/dist/
|
||||
/build/
|
||||
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
language: node_js
|
||||
sudo: false
|
||||
node_js:
|
||||
- '4'
|
||||
|
||||
before_script:
|
||||
# Needed to include Chrome in Travis for karma tests
|
||||
- export CHROME_BIN=chromium-browser
|
||||
- export DISPLAY=:99.0
|
||||
- sh -e /etc/init.d/xvfb start
|
||||
|
||||
script: 'npm run test-travis'
|
||||
+6
-6
@@ -4,7 +4,7 @@ Thanks for checking out Clay. We accept pull requests from anybody, however we a
|
||||
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)
|
||||
[piece-of-cake](https://github.com/pebble-dev/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.
|
||||
|
||||
@@ -13,7 +13,7 @@ a great place to start for people that are new to the codebase.
|
||||
|
||||
- [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)
|
||||
- [Pebble SDK](https://developer.rebble.io/sdk/) (optional)
|
||||
|
||||
|
||||
## Getting Started
|
||||
@@ -192,7 +192,7 @@ 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/
|
||||
- Chat to us in the `#app-dev` channel on Discord. https://discordapp.com/invite/aRUAYFN
|
||||
- Visit the [Rebble Forums](https://forum.rebble.io/)
|
||||
- Skeet at [@rebble.io](https://bsky.app/profile/rebble.io)
|
||||
- More options at https://developer.rebble.io/community/online/
|
||||
|
||||
@@ -1,46 +1,30 @@
|
||||
# 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 `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 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`, 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.
|
||||
Clay is distributed as a [Pebble package](https://developer.rebble.io/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
|
||||
1. Run `pebble package install @rebble/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');
|
||||
var Clay = require('@rebble/clay');
|
||||
var clayConfig = require('./config.json');
|
||||
var clay = new Clay(clayConfig);
|
||||
```
|
||||
5. Ensure `pebble.enableMultiJS` is set to true in your `package.json`.
|
||||
6. Next is the fun part - creating your config page. Edit your `config.json` file to build a layout of elements as described in the sections below.
|
||||
7. Make sure you have defined all of your `messageKeys` in your `package.json`. More info on how that works [here.](https://developer.pebble.com/guides/communication/using-pebblekit-js/#defining-keys)
|
||||
7. Make sure you have defined all of your `messageKeys` in your `package.json`. More info on how that works [here.](https://developer.rebble.io/guides/communication/using-pebblekit-js/#defining-keys)
|
||||
|
||||
# Getting Started (CloudPebble)
|
||||
|
||||
1. Ensure `JS Handling` is set to `CommonJS-style` in your project settings.
|
||||
2. Under `Dependencies` in the project navigation, enter `pebble-clay` as the `Package Name` and `^1.0.0` for the `Version`. You may use any specific version you like, however using `^1.0.0` will ensure you receive all minor version updates.
|
||||
4. Create a JavaScript file called `config.js` with the following content. This will act as your config's root array element, from which the rest of the page is built up:
|
||||
|
||||
```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:
|
||||
|
||||
```javascript
|
||||
var Clay = require('pebble-clay');
|
||||
var clayConfig = require('./config');
|
||||
var clay = new Clay(clayConfig);
|
||||
```
|
||||
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 (Rocky.js)
|
||||
If you are using [Rocky.js](https://developer.rebble.io/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
|
||||
|
||||
@@ -120,11 +104,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
|
||||
@@ -151,10 +136,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
|
||||
@@ -179,13 +165,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
|
||||
@@ -217,12 +204,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
|
||||
@@ -249,13 +237,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
|
||||
|
||||
@@ -355,15 +344,16 @@ 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. |
|
||||
| defaultValue | string OR int | The default color. One of the [64 colors](https://developer.rebble.io/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 |
|
||||
| sunlight | boolean | Use the color-corrected sunlight color palette if `true`, else the uncorrected version. Defaults to `true` if not specified. |
|
||||
| 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
|
||||
|
||||
@@ -421,13 +411,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
|
||||
|
||||
@@ -466,13 +457,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). |
|
||||
| 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 |
|
||||
| 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]`. |
|
||||
| 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
|
||||
|
||||
@@ -499,10 +491,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
|
||||
|
||||
@@ -541,6 +535,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
|
||||
|
||||
@@ -571,7 +566,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
|
||||
|
||||
@@ -586,7 +583,7 @@ The submit button for the page. You **MUST** include this component somewhere in
|
||||
|
||||
### Message keys and array syntax
|
||||
|
||||
Clay supports (and requires in some cases) the use of array syntax for message keys. Also known as `Automatic assignment` in CloudPebble. More info [here.](https://developer.pebble.com/guides/communication/using-pebblekit-js/#defining-keys)
|
||||
Clay supports (and requires in some cases) the use of array syntax for message keys. More info [here.](https://developer.rebble.io/guides/communication/using-pebblekit-js/#defining-keys)
|
||||
|
||||
You can assign any component that does not return an array to a particular position in your message key. This is done by appending the position (zero indexed) wrapped in brackets to the end of the `messageKey` property. Do **NOT** include any spaces in your `messageKey`.
|
||||
|
||||
@@ -666,7 +663,8 @@ Below is the full list of capabilities
|
||||
| PLATFORM_BASALT | Running on Pebble Time/Pebble Time Steel. |
|
||||
| PLATFORM_CHALK | Running on Pebble Time Round. |
|
||||
| PLATFORM_DIORITE | Running on Pebble 2 |
|
||||
| PLATFORM_EMERY | Running on Time 2. |
|
||||
| PLATFORM_EMERY | Running on Core Time 2. |
|
||||
| PLATFORM_FLINT | Running on Core 2 Duo. |
|
||||
| BW | Running on hardware that supports only black and white. |
|
||||
| COLOR | Running on hardware that supports 64 colors. |
|
||||
| MICROPHONE | Running on hardware that includes a microphone. |
|
||||
@@ -788,7 +786,7 @@ Clay will by default, automatically handle the 'showConfiguration' and 'webviewc
|
||||
Example:
|
||||
|
||||
```javascript
|
||||
var Clay = require('pebble-clay');
|
||||
var Clay = require('@rebble/clay');
|
||||
var clayConfig = require('./config');
|
||||
var clayConfigAplite = require('./config-aplite');
|
||||
var clay = new Clay(clayConfig, null, { autoHandleEvents: false });
|
||||
@@ -822,51 +820,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('pebble-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)`
|
||||
@@ -888,9 +841,9 @@ cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000);
|
||||
| `.config` | Array | Copy of the config passed to the constructor and used for generating the page. |
|
||||
| `.customFn` | Function | Reference to the custom function passed to the constructor. **WARNING** this is a direct reference, not a copy of the custom function so any modification you make to it, will be reflected on the original as well |
|
||||
| `.meta` | Object | Contains information about the current user and watch. **WARNING** This will only be populated in the `showConfiguration` event handler. (See example above) |
|
||||
| `.meta.activeWatchInfo` | watchinfo\|null | An object containing information on the currently connected Pebble smartwatch or null if unavailable. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getActiveWatchInfo). |
|
||||
| `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getAccountToken). |
|
||||
| `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getWatchToken). |
|
||||
| `.meta.activeWatchInfo` | watchinfo\|null | An object containing information on the currently connected Pebble smartwatch or null if unavailable. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getActiveWatchInfo). |
|
||||
| `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getAccountToken). |
|
||||
| `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getWatchToken). |
|
||||
| `.meta.userData` | Any | A deep copy of the arbitrary data provided in the `options.userData`. Defaults to an empty object |
|
||||
| `.version` | String | The version of Clay currently being used. |
|
||||
|
||||
@@ -902,6 +855,8 @@ cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000);
|
||||
| `.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. <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
|
||||
|
||||
@@ -953,7 +908,7 @@ Make sure to always wait for the config page to be built before manipulating ite
|
||||
##### app.js
|
||||
|
||||
```javascript
|
||||
var Clay = require('pebble-clay');
|
||||
var Clay = require('@rebble/clay');
|
||||
var clayConfig = require('./config');
|
||||
var customClay = require('./custom-clay');
|
||||
var userData = {token: 'abc123'}
|
||||
@@ -1016,9 +971,9 @@ This is the main way of talking to your generated config page. An instance of th
|
||||
| `.EVENTS.AFTER_DESTROY` | String | Dispatched after destroying the page. |
|
||||
| `.config` | Array | Reference to the config passed to the constructor and used for generating the page. |
|
||||
| `.meta` | Object | Contains information about the current user and watch |
|
||||
| `.meta.activeWatchInfo` | watchinfo\|null | An object containing information on the currently connected Pebble smartwatch or null if unavailable. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getActiveWatchInfo). |
|
||||
| `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getAccountToken). |
|
||||
| `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getWatchToken). |
|
||||
| `.meta.activeWatchInfo` | watchinfo\|null | An object containing information on the currently connected Pebble smartwatch or null if unavailable. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getActiveWatchInfo). |
|
||||
| `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getAccountToken). |
|
||||
| `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getWatchToken). |
|
||||
| `.meta.userData` | Any | The data passed in the `options.userData` of the [Clay constructor.](#clayarray-config-function-customfn-object-options) |
|
||||
|
||||
|
||||
@@ -1030,6 +985,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` |
|
||||
@@ -1047,7 +1003,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. |
|
||||
@@ -1090,7 +1046,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('pebble-clay');
|
||||
var Clay = require('@rebble/clay');
|
||||
var clayConfig = require('./config.json');
|
||||
var clay = new Clay(clayConfig);
|
||||
|
||||
|
||||
+3
-3
@@ -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
|
||||
},
|
||||
{
|
||||
|
||||
+51
-31
@@ -8,11 +8,10 @@ var stringify = require('stringify');
|
||||
var del = require('del');
|
||||
var inline = require('gulp-inline');
|
||||
var htmlmin = require('gulp-htmlmin');
|
||||
var sass = require('gulp-sass');
|
||||
var sass = require('gulp-sass')(require('sass'));
|
||||
var sourceMaps = require('gulp-sourcemaps');
|
||||
var autoprefixer = require('gulp-autoprefixer');
|
||||
var uglify = require('gulp-uglify');
|
||||
var sassify = require('sassify');
|
||||
var autoprefixify = require('./src/scripts/vendor/autoprefixify');
|
||||
var insert = require('gulp-insert');
|
||||
var clayPackage = require('./package.json');
|
||||
@@ -22,22 +21,13 @@ var sassIncludePaths = [].concat(
|
||||
'src/styles'
|
||||
);
|
||||
|
||||
var sassifyOptions = {
|
||||
base64Encode: false,
|
||||
sourceMap: false,
|
||||
sourceMapEmbed: false,
|
||||
sourceMapContents: false,
|
||||
outputStyle: 'compact',
|
||||
includePaths: sassIncludePaths
|
||||
};
|
||||
|
||||
var autoprefixerOptions = {
|
||||
browsers: ['Android 4', 'iOS 8'],
|
||||
cascade: false
|
||||
};
|
||||
|
||||
var stringifyOptions = ['.html', '.tpl'];
|
||||
var versionMessage = '/* Clay - https://github.com/pebble/clay - Version: ' +
|
||||
var stringifyOptions = ['.html', '.tpl', '.css'];
|
||||
var versionMessage = '/* Clay - https://github.com/pebble-dev/clay - Version: ' +
|
||||
clayPackage.version +
|
||||
' - Build Date: ' + new Date().toISOString() + ' */\n';
|
||||
|
||||
@@ -45,29 +35,44 @@ gulp.task('clean-js', function() {
|
||||
return del(['tmp/config-page.js']);
|
||||
});
|
||||
|
||||
gulp.task('js', ['clean-js'], function() {
|
||||
/**
|
||||
* @returns {string}
|
||||
*/
|
||||
function taskJs() {
|
||||
return browserify('src/scripts/config-page.js', { debug: true })
|
||||
.transform('deamdify')
|
||||
.bundle()
|
||||
.pipe(source('config-page.js'))
|
||||
.pipe(gulp.dest('./tmp/'));
|
||||
});
|
||||
}
|
||||
|
||||
gulp.task('js', gulp.series('clean-js', taskJs));
|
||||
|
||||
gulp.task('clean-sass', function() {
|
||||
return del(['tmp/config-page.scss']);
|
||||
});
|
||||
gulp.task('sass', ['clean-sass'], function() {
|
||||
gulp.src('./src/styles/config-page.scss')
|
||||
|
||||
/**
|
||||
* @returns {string}
|
||||
*/
|
||||
function taskSass() {
|
||||
return gulp.src(['./src/styles/config-page.scss',
|
||||
'./src/styles/clay/components/*.scss'])
|
||||
.pipe(sourceMaps.init())
|
||||
.pipe(sass({
|
||||
includePaths: sassIncludePaths
|
||||
loadPaths: sassIncludePaths
|
||||
}).on('error', sass.logError))
|
||||
.pipe(autoprefixer(autoprefixerOptions))
|
||||
.pipe(sourceMaps.write('./'))
|
||||
.pipe(gulp.dest('tmp'));
|
||||
});
|
||||
}
|
||||
|
||||
gulp.task('inlineHtml', ['js', 'sass'], function() {
|
||||
gulp.task('sass', gulp.series('clean-sass', taskSass));
|
||||
|
||||
/**
|
||||
* @returns {string}
|
||||
*/
|
||||
function taskInlineHtml() {
|
||||
return gulp.src('src/config-page.html')
|
||||
.pipe(inline())
|
||||
.pipe(htmlmin({
|
||||
@@ -80,17 +85,21 @@ gulp.task('inlineHtml', ['js', 'sass'], function() {
|
||||
minifyCSS: true
|
||||
}))
|
||||
.pipe(gulp.dest('tmp/'));
|
||||
});
|
||||
}
|
||||
|
||||
gulp.task('clay', ['inlineHtml'], function() {
|
||||
gulp.task('inlineHtml', gulp.series('js', 'sass', taskInlineHtml));
|
||||
|
||||
/**
|
||||
* @returns {string}
|
||||
*/
|
||||
function taskClay() {
|
||||
return browserify('index.js', {
|
||||
debug: false,
|
||||
standalone: clayPackage.name
|
||||
})
|
||||
.transform('deamdify')
|
||||
.transform(stringify(stringifyOptions))
|
||||
.transform(sassify, sassifyOptions)
|
||||
.transform(autoprefixify, autoprefixerOptions)
|
||||
// .transform(autoprefixify, autoprefixerOptions)
|
||||
.require(require.resolve('./index'), {expose: clayPackage.name})
|
||||
.exclude('message_keys')
|
||||
.bundle()
|
||||
@@ -101,24 +110,35 @@ gulp.task('clay', ['inlineHtml'], function() {
|
||||
}))
|
||||
.pipe(insert.prepend(versionMessage))
|
||||
.pipe(gulp.dest('./src/js'));
|
||||
});
|
||||
}
|
||||
|
||||
gulp.task('dev-js', ['js', 'sass'], function() {
|
||||
gulp.task('clay', gulp.series('inlineHtml', taskClay));
|
||||
|
||||
/**
|
||||
* @returns {string}
|
||||
*/
|
||||
function taskDevJs() {
|
||||
return browserify('dev/dev.js', { debug: true })
|
||||
.transform(stringify(stringifyOptions))
|
||||
.transform('deamdify')
|
||||
.transform(sassify, sassifyOptions)
|
||||
.transform(autoprefixify, autoprefixerOptions)
|
||||
.ignore('message_keys')
|
||||
.bundle()
|
||||
.pipe(source('dev.js'))
|
||||
.pipe(gulp.dest('./tmp/'));
|
||||
});
|
||||
}
|
||||
|
||||
gulp.task('default', ['clay']);
|
||||
gulp.task('dev-js', gulp.series('js', 'sass', taskDevJs));
|
||||
|
||||
gulp.task('dev', ['dev-js'], function() {
|
||||
gulp.task('default', gulp.series('clay'));
|
||||
|
||||
/**
|
||||
* @returns {string}
|
||||
*/
|
||||
function taskDev() {
|
||||
gulp.watch('src/styles/**/*.scss', ['sass']);
|
||||
gulp.watch(['src/scripts/**/*.js', 'src/templates/**/*.tpl'], ['js']);
|
||||
gulp.watch(['src/**', 'dev/**/*.js'], ['dev-js']);
|
||||
});
|
||||
}
|
||||
|
||||
gulp.task('dev', gulp.series('dev-js', taskDev));
|
||||
|
||||
@@ -213,6 +213,39 @@ Clay.prototype.getSettings = function(response, convert) {
|
||||
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));
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {string} input
|
||||
* @param {string} [prefix='data:text/html;charset=utf-8,']
|
||||
|
||||
Generated
+13728
File diff suppressed because it is too large
Load Diff
+25
-25
@@ -1,9 +1,9 @@
|
||||
{
|
||||
"name": "pebble-clay",
|
||||
"version": "1.0.2",
|
||||
"name": "@rebble/clay",
|
||||
"version": "1.0.5",
|
||||
"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 ./",
|
||||
"test-travis": "./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --single-run --browsers chromeTravisCI",
|
||||
"test-debug": "(export DEBUG=true && ./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --no-single-run)",
|
||||
"test": "./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --single-run",
|
||||
"lint": "./node_modules/.bin/eslint ./",
|
||||
@@ -15,7 +15,7 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/pebble/clay.git"
|
||||
"url": "git+https://github.com/pebble-dev/clay.git"
|
||||
},
|
||||
"keywords": [
|
||||
"pebble",
|
||||
@@ -26,7 +26,7 @@
|
||||
"author": "Pebble Technology",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/pebble/clay/issues"
|
||||
"url": "https://github.com/pebble-dev/clay/issues"
|
||||
},
|
||||
"pebble": {
|
||||
"projectType": "package",
|
||||
@@ -36,7 +36,8 @@
|
||||
"basalt",
|
||||
"chalk",
|
||||
"diorite",
|
||||
"emery"
|
||||
"emery",
|
||||
"flint"
|
||||
],
|
||||
"resources": {
|
||||
"media": []
|
||||
@@ -45,12 +46,12 @@
|
||||
"configurable"
|
||||
]
|
||||
},
|
||||
"homepage": "https://github.com/pebble/clay#readme",
|
||||
"homepage": "https://github.com/pebble-dev/clay#readme",
|
||||
"devDependencies": {
|
||||
"autoprefixer": "^6.3.1",
|
||||
"autoprefixer": "^10.4.22",
|
||||
"bourbon": "^4.2.6",
|
||||
"browserify": "^13.0.0",
|
||||
"browserify-istanbul": "^0.2.1",
|
||||
"browserify-istanbul": "^3.0.1",
|
||||
"chai": "^3.4.1",
|
||||
"deamdify": "^0.2.0",
|
||||
"deepcopy": "^0.6.1",
|
||||
@@ -58,34 +59,33 @@
|
||||
"eslint": "^1.5.1",
|
||||
"eslint-config-pebble": "^1.2.0",
|
||||
"eslint-plugin-standard": "^1.3.1",
|
||||
"gulp": "^3.9.0",
|
||||
"gulp": "^5.0.1",
|
||||
"gulp-autoprefixer": "^3.1.0",
|
||||
"gulp-htmlmin": "^1.3.0",
|
||||
"gulp-inline": "0.0.15",
|
||||
"gulp-inline": "^0.1.3",
|
||||
"gulp-insert": "^0.5.0",
|
||||
"gulp-sass": "^2.1.1",
|
||||
"gulp-sass": "^6.0.1",
|
||||
"gulp-sourcemaps": "^1.6.0",
|
||||
"gulp-uglify": "^1.5.2",
|
||||
"joi": "^6.10.1",
|
||||
"karma": "^0.13.19",
|
||||
"karma-browserify": "^5.0.1",
|
||||
"karma-chrome-launcher": "^0.2.2",
|
||||
"karma-coverage": "^0.5.3",
|
||||
"karma-mocha": "^0.2.1",
|
||||
"karma-mocha-reporter": "^1.1.5",
|
||||
"karma-source-map-support": "^1.1.0",
|
||||
"karma": "^6.4.0",
|
||||
"karma-browserify": "^8.1.0",
|
||||
"karma-chrome-launcher": "^3.2.0",
|
||||
"karma-coverage": "^2.2.1",
|
||||
"karma-mocha": "^2.0.1",
|
||||
"karma-mocha-reporter": "^2.2.5",
|
||||
"karma-source-map-support": "^1.4.0",
|
||||
"karma-threshold-reporter": "^0.1.15",
|
||||
"mocha": "^2.3.4",
|
||||
"postcss": "^5.0.14",
|
||||
"mocha": "^11.7.5",
|
||||
"postcss": "^8.5.6",
|
||||
"require-from-string": "^1.1.0",
|
||||
"sassify": "^0.9.1",
|
||||
"sass": "^1.94.2",
|
||||
"sinon": "^1.17.3",
|
||||
"stringify": "^3.2.0",
|
||||
"through": "^2.3.8",
|
||||
"tosource": "^1.0.0",
|
||||
"vinyl-buffer": "^1.0.0",
|
||||
"vinyl-source-stream": "^1.1.0",
|
||||
"vinyl-source-stream": "^2.0.0",
|
||||
"watchify": "^3.7.0"
|
||||
},
|
||||
"dependencies": {}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'button',
|
||||
template: require('../../templates/components/button.tpl'),
|
||||
style: require('../../styles/clay/components/button.scss'),
|
||||
style: require('../../../tmp/button.css'),
|
||||
manipulator: 'button',
|
||||
defaults: {
|
||||
primary: false,
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'checkboxgroup',
|
||||
template: require('../../templates/components/checkboxgroup.tpl'),
|
||||
style: require('../../styles/clay/components/checkboxgroup.scss'),
|
||||
style: require('../../../tmp/checkboxgroup.css'),
|
||||
manipulator: 'checkboxgroup',
|
||||
defaults: {
|
||||
label: '',
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'color',
|
||||
template: require('../../templates/components/color.tpl'),
|
||||
style: require('../../styles/clay/components/color.scss'),
|
||||
style: require('../../../tmp/color.css'),
|
||||
manipulator: 'color',
|
||||
defaults: {
|
||||
label: '',
|
||||
@@ -114,14 +114,15 @@ module.exports = {
|
||||
* @returns {Array}
|
||||
*/
|
||||
function autoLayout() {
|
||||
var bwWatches = ['aplite', 'diorite', 'flint'];
|
||||
if (!clay.meta.activeWatchInfo ||
|
||||
clay.meta.activeWatchInfo.firmware.major === 2 ||
|
||||
['aplite', 'diorite'].indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
|
||||
bwWatches.indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
|
||||
!self.config.allowGray) {
|
||||
return standardLayouts.BLACK_WHITE;
|
||||
}
|
||||
|
||||
if (['aplite', 'diorite'].indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
|
||||
if (bwWatches.indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
|
||||
self.config.allowGray) {
|
||||
return standardLayouts.GRAY;
|
||||
}
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'input',
|
||||
template: require('../../templates/components/input.tpl'),
|
||||
style: require('../../styles/clay/components/input.scss'),
|
||||
style: require('../../../tmp/input.css'),
|
||||
manipulator: 'val',
|
||||
defaults: {
|
||||
label: '',
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'radiogroup',
|
||||
template: require('../../templates/components/radiogroup.tpl'),
|
||||
style: require('../../styles/clay/components/radiogroup.scss'),
|
||||
style: require('../../../tmp/radiogroup.css'),
|
||||
manipulator: 'radiogroup',
|
||||
defaults: {
|
||||
label: '',
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'select',
|
||||
template: require('../../templates/components/select.tpl'),
|
||||
style: require('../../styles/clay/components/select.scss'),
|
||||
style: require('../../../tmp/select.css'),
|
||||
manipulator: 'val',
|
||||
defaults: {
|
||||
label: '',
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'slider',
|
||||
template: require('../../templates/components/slider.tpl'),
|
||||
style: require('../../styles/clay/components/slider.scss'),
|
||||
style: require('../../../tmp/slider.css'),
|
||||
manipulator: 'slider',
|
||||
defaults: {
|
||||
label: '',
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'submit',
|
||||
template: require('../../templates/components/submit.tpl'),
|
||||
style: require('../../styles/clay/components/submit.scss'),
|
||||
style: require('../../../tmp/submit.css'),
|
||||
manipulator: 'button',
|
||||
defaults: {
|
||||
attributes: {}
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
module.exports = {
|
||||
name: 'toggle',
|
||||
template: require('../../templates/components/toggle.tpl'),
|
||||
style: require('../../styles/clay/components/toggle.scss'),
|
||||
style: require('../../../tmp/toggle.css'),
|
||||
manipulator: 'checked',
|
||||
defaults: {
|
||||
label: '',
|
||||
|
||||
@@ -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}
|
||||
*/
|
||||
|
||||
@@ -44,8 +44,13 @@ module.exports.capabilityMap = {
|
||||
minFwMajor: 0,
|
||||
minFwMinor: 0
|
||||
},
|
||||
PLATFORM_FLINT: {
|
||||
platforms: ['flint'],
|
||||
minFwMajor: 0,
|
||||
minFwMinor: 0
|
||||
},
|
||||
BW: {
|
||||
platforms: ['aplite', 'diorite'],
|
||||
platforms: ['aplite', 'diorite', 'flint'],
|
||||
minFwMajor: 0,
|
||||
minFwMinor: 0
|
||||
},
|
||||
@@ -55,7 +60,7 @@ module.exports.capabilityMap = {
|
||||
minFwMinor: 0
|
||||
},
|
||||
MICROPHONE: {
|
||||
platforms: ['basalt', 'chalk', 'diorite', 'emery'],
|
||||
platforms: ['basalt', 'chalk', 'diorite', 'emery', 'flint'],
|
||||
minFwMajor: 0,
|
||||
minFwMinor: 0
|
||||
},
|
||||
@@ -70,12 +75,12 @@ module.exports.capabilityMap = {
|
||||
minFwMinor: 4
|
||||
},
|
||||
HEALTH: {
|
||||
platforms: ['basalt', 'chalk', 'diorite', 'emery'],
|
||||
platforms: ['basalt', 'chalk', 'diorite', 'emery', 'flint'],
|
||||
minFwMajor: 3,
|
||||
minFwMinor: 10
|
||||
},
|
||||
RECT: {
|
||||
platforms: ['aplite', 'basalt', 'diorite', 'emery'],
|
||||
platforms: ['aplite', 'basalt', 'diorite', 'emery', 'flint'],
|
||||
minFwMajor: 0,
|
||||
minFwMinor: 0
|
||||
},
|
||||
@@ -85,7 +90,7 @@ module.exports.capabilityMap = {
|
||||
minFwMinor: 0
|
||||
},
|
||||
DISPLAY_144x168: {
|
||||
platforms: ['aplite', 'basalt', 'diorite'],
|
||||
platforms: ['aplite', 'basalt', 'diorite', 'flint'],
|
||||
minFwMajor: 0,
|
||||
minFwMinor: 0
|
||||
},
|
||||
|
||||
+1
-15
@@ -24,24 +24,10 @@ module.exports = function(config) {
|
||||
[
|
||||
'stringify',
|
||||
{
|
||||
extensions: ['.html', '.tpl']
|
||||
extensions: ['.html', '.tpl', '.css']
|
||||
}
|
||||
],
|
||||
'deamdify',
|
||||
[
|
||||
'sassify',
|
||||
{
|
||||
base64Encode: false,
|
||||
sourceMap: false,
|
||||
sourceMapEmbed: false,
|
||||
sourceMapContents: false,
|
||||
outputStyle: 'compact',
|
||||
includePaths: [].concat(
|
||||
require('bourbon').includePaths,
|
||||
'src/styles'
|
||||
)
|
||||
}
|
||||
],
|
||||
[
|
||||
'browserify-istanbul',
|
||||
{
|
||||
|
||||
@@ -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,
|
||||
|
||||
@@ -15,6 +15,7 @@ describe('ClayConfig', function() {
|
||||
'getItemByMessageKey',
|
||||
'getItemById',
|
||||
'getItemsByType',
|
||||
'getItemsByGroup',
|
||||
'serialize',
|
||||
'registerComponent',
|
||||
'build',
|
||||
@@ -91,6 +92,7 @@ describe('ClayConfig', function() {
|
||||
testCapabilities('aplite', 2, 9, ['PLATFORM_CHALK'], 0);
|
||||
testCapabilities('aplite', 2, 9, ['PLATFORM_DIORITE'], 0);
|
||||
testCapabilities('aplite', 2, 9, ['PLATFORM_EMERY'], 0);
|
||||
testCapabilities('aplite', 2, 9, ['PLATFORM_FLINT'], 0);
|
||||
|
||||
testCapabilities('aplite', 3, 10, ['BW'], 1);
|
||||
testCapabilities('aplite', 3, 10, ['COLOR'], 0);
|
||||
@@ -111,6 +113,7 @@ describe('ClayConfig', function() {
|
||||
testCapabilities('aplite', 3, 10, ['PLATFORM_CHALK'], 0);
|
||||
testCapabilities('aplite', 3, 10, ['PLATFORM_DIORITE'], 0);
|
||||
testCapabilities('aplite', 3, 10, ['PLATFORM_EMERY'], 0);
|
||||
testCapabilities('aplite', 3, 10, ['PLATFORM_FLINT'], 0);
|
||||
|
||||
testCapabilities('basalt', 3, 10, ['BW'], 0);
|
||||
testCapabilities('basalt', 3, 10, ['COLOR'], 1);
|
||||
@@ -133,6 +136,7 @@ describe('ClayConfig', function() {
|
||||
testCapabilities('basalt', 3, 10, ['PLATFORM_CHALK'], 0);
|
||||
testCapabilities('basalt', 3, 10, ['PLATFORM_DIORITE'], 0);
|
||||
testCapabilities('basalt', 3, 10, ['PLATFORM_EMERY'], 0);
|
||||
testCapabilities('basalt', 3, 10, ['PLATFORM_FLINT'], 0);
|
||||
|
||||
testCapabilities('chalk', 3, 10, ['BW'], 0);
|
||||
testCapabilities('chalk', 3, 10, ['COLOR'], 1);
|
||||
@@ -155,6 +159,7 @@ describe('ClayConfig', function() {
|
||||
testCapabilities('chalk', 3, 10, ['PLATFORM_CHALK'], 1);
|
||||
testCapabilities('chalk', 3, 10, ['PLATFORM_DIORITE'], 0);
|
||||
testCapabilities('chalk', 3, 10, ['PLATFORM_EMERY'], 0);
|
||||
testCapabilities('chalk', 3, 10, ['PLATFORM_FLINT'], 0);
|
||||
|
||||
testCapabilities('diorite', 3, 10, ['BW'], 1);
|
||||
testCapabilities('diorite', 3, 10, ['COLOR'], 0);
|
||||
@@ -177,6 +182,7 @@ describe('ClayConfig', function() {
|
||||
testCapabilities('diorite', 3, 10, ['PLATFORM_CHALK'], 0);
|
||||
testCapabilities('diorite', 3, 10, ['PLATFORM_DIORITE'], 1);
|
||||
testCapabilities('diorite', 3, 10, ['PLATFORM_EMERY'], 0);
|
||||
testCapabilities('diorite', 3, 10, ['PLATFORM_FLINT'], 0);
|
||||
|
||||
testCapabilities('emery', 3, 10, ['BW'], 0);
|
||||
testCapabilities('emery', 3, 10, ['COLOR'], 1);
|
||||
@@ -199,6 +205,30 @@ describe('ClayConfig', function() {
|
||||
testCapabilities('emery', 3, 10, ['PLATFORM_CHALK'], 0);
|
||||
testCapabilities('emery', 3, 10, ['PLATFORM_DIORITE'], 0);
|
||||
testCapabilities('emery', 3, 10, ['PLATFORM_EMERY'], 1);
|
||||
testCapabilities('emery', 3, 10, ['PLATFORM_FLINT'], 0);
|
||||
|
||||
testCapabilities('flint', 3, 10, ['BW'], 1);
|
||||
testCapabilities('flint', 3, 10, ['COLOR'], 0);
|
||||
testCapabilities('flint', 3, 10, ['MICROPHONE'], 1);
|
||||
testCapabilities('flint', 3, 10, ['SMARTSTRAP'], 0);
|
||||
testCapabilities('flint', 3, 4, ['SMARTSTRAP'], 0);
|
||||
testCapabilities('flint', 3, 3, ['SMARTSTRAP'], 0);
|
||||
testCapabilities('flint', 3, 10, ['SMARTSTRAP_POWER'], 0);
|
||||
testCapabilities('flint', 3, 4, ['SMARTSTRAP_POWER'], 0);
|
||||
testCapabilities('flint', 3, 3, ['SMARTSTRAP_POWER'], 0);
|
||||
testCapabilities('flint', 3, 10, ['HEALTH'], 1);
|
||||
testCapabilities('flint', 3, 9, ['HEALTH'], 0);
|
||||
testCapabilities('flint', 3, 10, ['RECT'], 1);
|
||||
testCapabilities('flint', 3, 10, ['ROUND'], 0);
|
||||
testCapabilities('flint', 3, 10, ['DISPLAY_144x168'], 1);
|
||||
testCapabilities('flint', 3, 10, ['DISPLAY_180x180_ROUND'], 0);
|
||||
testCapabilities('flint', 3, 10, ['DISPLAY_200x228'], 0);
|
||||
testCapabilities('flint', 3, 10, ['PLATFORM_APLITE'], 0);
|
||||
testCapabilities('flint', 3, 10, ['PLATFORM_BASALT'], 0);
|
||||
testCapabilities('flint', 3, 10, ['PLATFORM_CHALK'], 0);
|
||||
testCapabilities('flint', 3, 10, ['PLATFORM_DIORITE'], 0);
|
||||
testCapabilities('flint', 3, 10, ['PLATFORM_EMERY'], 0);
|
||||
testCapabilities('flint', 3, 10, ['PLATFORM_FLINT'], 1);
|
||||
|
||||
testCapabilities('aplite', 3, 10, ['BW', 'HEALTH'], 0, 0);
|
||||
testCapabilities('emery', 3, 10, ['COLOR', 'HEALTH'], 1);
|
||||
@@ -224,6 +254,7 @@ describe('ClayConfig', function() {
|
||||
'getItemByMessageKey',
|
||||
'getItemById',
|
||||
'getItemsByType',
|
||||
'getItemsByGroup',
|
||||
'serialize'
|
||||
].forEach(function(method) {
|
||||
it('.' + method + '()', function() {
|
||||
@@ -287,6 +318,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 = [
|
||||
|
||||
Reference in New Issue
Block a user