diff --git a/README.md b/README.md index 6526185..f531156 100755 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ Sections help divide up the page into logical groups of items. It is recommended ### Heading -**Manipulator:** `html` +**Manipulator:** [`html`](#html) Headings can be used in anywhere and can have their size adjusted to suit the context. If you place a heading item at the first position of a section's `items` array then it will automatically be styled as the header for that section. @@ -138,7 +138,7 @@ Headings can be used in anywhere and can have their size adjusted to suit the co ### Text -**Manipulator:** `html` +**Manipulator:** [`html`](#html) Text is used to provide descriptions of sections or to explain complex parts of your page. Feel free to add any extra HTML you require to the `defaultValue` @@ -165,7 +165,7 @@ Text is used to provide descriptions of sections or to explain complex parts of ### Input -**Manipulator:** `val` +**Manipulator:** [`val`](#val) Standard text input field. @@ -203,7 +203,7 @@ Standard text input field. #### Toggle -**Manipulator:** `checked` +**Manipulator:** [`checked`](#checked) Switch for a single item. @@ -238,7 +238,7 @@ Switch for a single item. #### Select -**Manipulator:** `val` +**Manipulator:** [`val`](#val) A dropdown menu containing multiple options. @@ -291,7 +291,7 @@ A dropdown menu containing multiple options. #### Color -**Manipulator:** `color` +**Manipulator:** [`color`](#color) A color picker containing the 64 supported colors on Basalt and Chalk. @@ -321,9 +321,9 @@ A color picker containing the 64 supported colors on Basalt and Chalk. --- -#### RadioGroup +#### Radio Group -**Manipulator:** `radiogroup` +**Manipulator:** [`radiogroup`](#radiogroup) A list of options allowing the user can only choose one option to submit. @@ -366,9 +366,9 @@ A list of options allowing the user can only choose one option to submit. --- -#### CheckboxGroup +#### Checkbox Group -**Manipulator:** `checkboxgroup` +**Manipulator:** [`checkboxgroup`](#checkboxgroup) A list of options where a user may choose more than one option to submit. @@ -412,9 +412,35 @@ A list of options where a user may choose more than one option to submit. --- +### Generic Button + +**Manipulator:** [`button`](#button) + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| type | string | Set to `button`. | +| 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`)| +| attributes | object | An object containing HTML attributes to set on the input field. | +| description | string | Optional sub-text to include below the component | + +##### Example + +```javascript +{ + "type": "button", + "primary": true, + "defaultValue": "Send" +} +``` + +--- + ### Submit -**Manipulator:** `html` +**Manipulator:** [`button`](#button) The submit button for the page. You **MUST** include this component somewhere in the config page (traditionally at the bottom) or users will not be able to save the form. @@ -440,7 +466,6 @@ The submit button for the page. You **MUST** include this component somewhere in ### Coming Soon - Range Slider -- Generic Button - Tabs - Footer - Dynamic + draggable list @@ -452,8 +477,12 @@ The submit button for the page. You **MUST** include this component somewhere in Each component has a **manipulator**. This is a set of methods used to talk to the item on the page. At a minimum, manipulators must have a `.get()` and `.set(value)` method however there are also methods to assist in interactivity such as `.hide()` and `.disable()`. **NOTE:** There is currently no way to disable or hide an entire section. You must disable/hide each item in the section to achieve this effect. + When the config page is closed, the `.get()` method is run on all components registered with an `appKey` to construct the object sent to the C app. -Many of these methods fire an event when the method is called. You can listen for these events with `ClayItem.on()`. + +Many of these methods fire an event when the method is called. You can listen for these events with `ClayItem.on()`. +**NOTE** These events will only be fired if the state actually changes. +Eg: If you run the `.show()` manipulator on an item that is already visible, the `show` event will not be triggered. #### html @@ -464,6 +493,17 @@ Many of these methods fire an event when the method is called. You can listen fo | `.hide()` | `ClayItem` | `hide` | Hides the item | | `.show()` | `ClayItem` | `show` | Shows the item | +#### button + +| Method | Returns | Event Fired | Description | +|--------|---------|-------------| ------------| +| `.set( [string\|HTML] value)` | `ClayItem` | `change` | Sets the content of this item. | +| `.get()` | `string` | | Gets the content of this item. | +| `.disable()` | `ClayItem` | `disabled` | Prevents this item from being clicked by the user. | +| `.enable()` | `ClayItem` | `enabled` | Allows this item to be clicked by the user. | +| `.hide()` | `ClayItem` | `hide` | Hides the item | +| `.show()` | `ClayItem` | `show` | Shows the item | + #### val | Method | Returns | Event Fired | Description | @@ -532,15 +572,23 @@ Example: ```javascript var Clay = require('./clay'); var clayConfig = require('./config'); +var clayConfigAplite = require('./config-aplite'); var clay = new Clay(clayConfig, null, { autoHandleEvents: false }); Pebble.addEventListener('showConfiguration', function(e) { + + // This is an example of how you might load a different config based on platform. + var platform = clay.meta.activeWatchInfo.platform || 'aplite'; + if (platform === 'aplite') { + clay.config = clayConfigAplite; + } + Pebble.openURL(clay.generateUrl()); }); Pebble.addEventListener('webviewclosed', function(e) { - if (e && !e.response) { - return; + if (e && !e.response) { + return; } // Get the keys and values from each config item @@ -558,6 +606,17 @@ Pebble.addEventListener('webviewclosed', function(e) { ### `Clay([Array] config, [function] customFn, [object] options)` +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| `.config` | Array | Reference to the config passed to the constructor and used for generating the page. **WARNING** this is a direct reference, not a copy of the config so any modification you make to it, will be reflected on the original as well | +| `.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). | + #### Methods | Method | Returns | @@ -595,27 +654,27 @@ var clay = new Clay(clayConfig, customClay); ```javascript module.exports = function(minified) { - var Clay = this; + var clayConfig = this; var _ = minified._; var $ = minified.$; var HTML = minified.HTML; function toggleBackground() { if (this.get()) { - Clay.getItemByAppKey('background').enable(); + clayConfig.getItemByAppKey('background').enable(); } else { - Clay.getItemByAppKey('background').disable(); + clayConfig.getItemByAppKey('background').disable(); } } - Clay.on(Clay.EVENTS.AFTER_BUILD, function() { - var coolStuffToggle = Clay.getItemByAppKey('cool_stuff'); + clayConfig.on(clayConfig.EVENTS.AFTER_BUILD, function() { + var coolStuffToggle = clayConfig.getItemByAppKey('cool_stuff'); toggleBackground.call(coolStuffToggle); coolStuffToggle.on('change', toggleBackground); // Hide the color picker for aplite - if (Clay.meta.activeWatchInfo.platform === 'aplite') { - Clay.getItemByAppKey('background').hide(); + if (!clayConfig.meta.activeWatchInfo || clayConfig.meta.activeWatchInfo.platform === 'aplite') { + clayConfig.getItemByAppKey('background').hide(); } }); @@ -626,7 +685,7 @@ module.exports = function(minified) { ### `ClayConfig([Object] settings, [Array] config, [$Minified] $rootContainer)` -This is the main way of talking to your generated config page. +This is the main way of talking to your generated config page. An instance of this class will be passed as the context of your custom function when it runs on the generated config page. #### Properties diff --git a/dev/config.js b/dev/config.js index 7b13947..b19cc2c 100644 --- a/dev/config.js +++ b/dev/config.js @@ -50,6 +50,14 @@ module.exports = [ "defaultValue": "00FF00", "label": "Sunny Color Picker", "sunlight": true + }, + { + type: 'button', + id: 'testButton', + primary: false, + defaultValue: 'Generic Button', + description: 'This is a generic button. ' + + 'You can listen for standard events like "click"' } ] }, diff --git a/src/images/example.png b/src/images/example.png index 3a96913..6d2ebc8 100644 Binary files a/src/images/example.png and b/src/images/example.png differ diff --git a/src/scripts/components/button.js b/src/scripts/components/button.js new file mode 100644 index 0000000..64fc65c --- /dev/null +++ b/src/scripts/components/button.js @@ -0,0 +1,13 @@ +'use strict'; + +module.exports = { + name: 'button', + template: require('../../templates/components/button.tpl'), + style: require('../../styles/clay/components/button.scss'), + manipulator: 'button', + defaults: { + primary: false, + attributes: {}, + description: '' + } +}; diff --git a/src/scripts/components/index.js b/src/scripts/components/index.js index 5b8741c..251aba8 100644 --- a/src/scripts/components/index.js +++ b/src/scripts/components/index.js @@ -10,5 +10,6 @@ module.exports = { text: require('./text'), toggle: require('./toggle'), radiogroup: require('./radiogroup'), - checkboxgroup: require('./checkboxgroup') + checkboxgroup: require('./checkboxgroup'), + button: require('./button') }; diff --git a/src/scripts/components/select.js b/src/scripts/components/select.js index ebd3229..09be191 100644 --- a/src/scripts/components/select.js +++ b/src/scripts/components/select.js @@ -16,11 +16,18 @@ module.exports = { var $value = self.$element.select('.value'); - self.on('change', function() { + /** + * Updates the HTML value of the component to match the slected option's label + * @return {void} + */ + function setValueDisplay() { var selectedIndex = self.$manipulatorTarget.get('selectedIndex'); var $options = self.$manipulatorTarget.select('option'); var value = $options[selectedIndex] && $options[selectedIndex].innerHTML; $value.set('innerHTML', value); - }); + } + + setValueDisplay(); + self.on('change', setValueDisplay); } }; diff --git a/src/scripts/components/submit.js b/src/scripts/components/submit.js index 18c684c..85d624e 100644 --- a/src/scripts/components/submit.js +++ b/src/scripts/components/submit.js @@ -4,7 +4,7 @@ module.exports = { name: 'submit', template: require('../../templates/components/submit.tpl'), style: require('../../styles/clay/components/submit.scss'), - manipulator: 'html', + manipulator: 'button', defaults: { attributes: {} } diff --git a/src/scripts/lib/manipulators.js b/src/scripts/lib/manipulators.js index a0f0fb8..ad96f72 100755 --- a/src/scripts/lib/manipulators.js +++ b/src/scripts/lib/manipulators.js @@ -1,35 +1,45 @@ 'use strict'; +var _ = require('../vendor/minified')._; + /** - * @returns {ClayEvents} + * @returns {ClayItem|ClayEvents} + * @extends {ClayItem} */ function disable() { + if (this.$manipulatorTarget.get('disabled')) { return this; } this.$element.set('+disabled'); this.$manipulatorTarget.set('disabled', true); return this.trigger('disabled'); } /** - * @returns {ClayEvents} + * @returns {ClayItem|ClayEvents} + * @extends {ClayItem} */ function enable() { + if (!this.$manipulatorTarget.get('disabled')) { return this; } this.$element.set('-disabled'); this.$manipulatorTarget.set('disabled', false); return this.trigger('enabled'); } /** - * @returns {ClayEvents} + * @returns {ClayItem|ClayEvents} + * @extends {ClayItem} */ function hide() { + if (this.$element[0].classList.contains('hide')) { return this; } this.$element.set('+hide'); return this.trigger('hide'); } /** - * @returns {ClayEvents} + * @returns {ClayItem|ClayEvents} + * @extends {ClayItem} */ function show() { + if (!this.$element[0].classList.contains('hide')) { return this; } this.$element.set('-hide'); return this.trigger('show'); } @@ -40,17 +50,33 @@ module.exports = { return this.$manipulatorTarget.get('innerHTML'); }, set: function(value) { + if (this.get() === value.toString(10)) { return this; } this.$manipulatorTarget.set('innerHTML', value); return this.trigger('change'); }, hide: hide, show: show }, + button: { + get: function() { + return this.$manipulatorTarget.get('innerHTML'); + }, + set: function(value) { + if (this.get() === value.toString(10)) { return this; } + this.$manipulatorTarget.set('innerHTML', value); + return this.trigger('change'); + }, + disable: disable, + enable: enable, + hide: hide, + show: show + }, val: { get: function() { return this.$manipulatorTarget.get('value'); }, set: function(value) { + if (this.get() === value.toString(10)) { return this; } this.$manipulatorTarget.set('value', value); return this.trigger('change'); }, @@ -64,6 +90,7 @@ module.exports = { return this.$manipulatorTarget.get('checked'); }, set: function(value) { + if (!this.get() === !value) { return this; } this.$manipulatorTarget.set('checked', !!value); return this.trigger('change'); }, @@ -77,6 +104,7 @@ module.exports = { return this.$element.select('input:checked').get('value'); }, set: function(value) { + if (this.get() === value.toString(10)) { return this; } this.$element .select('input[value="' + value.replace('"', '\\"') + '"]') .set('checked', true); @@ -97,8 +125,12 @@ module.exports = { }, set: function(values) { var self = this; - self.$element.select('input').set('checked', false); values = values || []; + + if (_.equals(this.get(), values)) { return this; } + + self.$element.select('input').set('checked', false); + values.map(function(value) { self.$element .select('input[value="' + value.replace('"', '\\"') + '"]') @@ -120,8 +152,10 @@ module.exports = { case 'number': value = value.toString(16); break; case 'string': value = value.replace(/^#|^0x/, ''); break; } + value = value || '000000'; - this.$manipulatorTarget.set('value', value || '000000'); + if (this.get() === parseInt(value, 16)) { return this; } + this.$manipulatorTarget.set('value', value); return this.trigger('change'); }, disable: disable, diff --git a/src/scripts/vendor/minified.js b/src/scripts/vendor/minified.js index 05b4061..a9816fb 100644 --- a/src/scripts/vendor/minified.js +++ b/src/scripts/vendor/minified.js @@ -1,8 +1,8 @@ // minified.js config start -- use this comment to re-create a configuration in the Builder // - Only sections add, always, amdsupport, copyobj, dollardollar, -// - each, eachobj, error, extend, find, format, formathtml, get, ht, html, -// - isobject, off, on, ready, request, select, set, template, trigger, underscore, -// - wait. +// - each, eachobj, equals, error, extend, find, format, formathtml, get, ht, +// - html, isobject, off, on, ready, request, select, set, template, trigger, +// - underscore, wait. // WARNING! This file is autogenerated from minified-master.js and others. @@ -1550,6 +1550,53 @@ define('minified', function() { */ 'each': listBind(each), + /*$ + * @id equals + * @group LIST + * @requires + * @configurable default + * @name .equals() + * @altname _.equals() + * @syntax list.equals(otherObject) + * @syntax _.equals(thisObject, otherObject) + * @module UTIL + * Checks whether two values, lists or objects are equal in a deep comparison. + * + * First equals() checks whether it got a function as parameter. + * If yes, it will be invoked without arguments and equals() calls itself recursively with the function's result. + * + * Once both values are no functions anymore, the values will be evaluated, If the first value is... + * + * + * Please note that, according to the rules, a ##list#Minified list## is equal to an array, as long as their content is equal. equals does not + * differentiate between null and undefined. + * + * equals is commutative. If you swap the parameters, the result is the same as long as no functions are involved. + * + * @example Compare a list and an array: + * 
+     *  _.equals([1, 2, 3], _(1, 2, 3));  // returns true
+     *
+ * + * @example Same result, but with a list method: + * 
+     *  _(1, 2, 3).equals([1, 2, 3]);  // returns true
+     *
+ * + * @param thisObject The first reference to evaluate. + * @param otherObject The second reference to evaluate. + * @return true if both references are equal. False otherwise. + */ + 'equals': listBind(equals), + /*$ * @id find * @group LIST @@ -2626,6 +2673,9 @@ define('minified', function() { // @condblock find 'find': find, // @condend + // @condblock equals + 'equals': equals, + // @condend /*$ * @id copyobj diff --git a/src/styles/clay/_base.scss b/src/styles/clay/_base.scss index aaa67a6..caea5e5 100644 --- a/src/styles/clay/_base.scss +++ b/src/styles/clay/_base.scss @@ -183,6 +183,7 @@ label { padding: 0 $item-spacing-h $item-spacing-v ; @include font-size(0.9); color: $color-gray-9; + text-align: left; } .inputs { diff --git a/src/styles/clay/_vars.scss b/src/styles/clay/_vars.scss index 391ecbd..acb1d5e 100644 --- a/src/styles/clay/_vars.scss +++ b/src/styles/clay/_vars.scss @@ -34,7 +34,7 @@ $color-gray-9: #a4a4a4 ; $color-gray-10: #ececec; $color-gray-11: #f2f2f2; -$button-padding: 0.7rem; -$button-padding-ios: 0.6rem; +$button-padding: 0.6rem; +$button-padding-ios: 0.5rem; $box-shadow-small-components: $color-gray-1 0 0.1rem 0.1rem; diff --git a/src/styles/clay/components/button.scss b/src/styles/clay/components/button.scss new file mode 100644 index 0000000..b6c6e13 --- /dev/null +++ b/src/styles/clay/components/button.scss @@ -0,0 +1,12 @@ +.component-button { + text-align: center; + + .section & { + padding-bottom: 0; + } + + .description { + padding-left: 0; + padding-right: 0; + } +} diff --git a/src/styles/clay/elements/_button.scss b/src/styles/clay/elements/_button.scss index 6ece43c..794ff54 100644 --- a/src/styles/clay/elements/_button.scss +++ b/src/styles/clay/elements/_button.scss @@ -3,52 +3,30 @@ button, .button { @include font-pfdin(medium); + @include font-size(1); text-transform: uppercase; - background-color: $color-gray-4; + background-color: $color-gray-7; border-radius: $border-radius; - font-size: 1rem; - line-height: 1; border: none; display: inline-block; color: $color-white; min-width: 12rem; text-align: center; - margin: 0 auto; - -webkit-tap-highlight-color: rgba(0,0,0,0); - + margin: 0 auto $item-spacing-v; padding: $button-padding; + @include tap-highlight($color-gray-8); + .platform-ios & { padding: $button-padding-ios; } - &:disabled { - background-color: $color-gray-3; - color: $color-gray-8; - } - - &:not(:disabled):active { - background-color: $color-gray-8; - } - - &.orange, &[type="submit"] { + &.primary, &[type="submit"] { background-color: $color-orange; - &:disabled { - background-color: $color-orange-dark; - color: $color-gray-3; - } - - &:not(:disabled):active { - background-color: $color-red; - } + @include tap-highlight($color-red); } - - &.light-grey { - background-color: $color-gray-5; - } - } a.button { diff --git a/src/templates/components/button.tpl b/src/templates/components/button.tpl new file mode 100755 index 0000000..187a22c --- /dev/null +++ b/src/templates/components/button.tpl @@ -0,0 +1,11 @@ +
+ + {{if description}} +
{{{description}}}
+ {{/if}} +
diff --git a/test/spec/components/select.js b/test/spec/components/select.js index 86c7521..8ea8b2e 100644 --- a/test/spec/components/select.js +++ b/test/spec/components/select.js @@ -3,7 +3,7 @@ var assert = require('chai').assert; var fixture = require('../../fixture'); -describe('component - color', function() { +describe('component - select', function() { it('sets the value display to the correct value on change', function() { var clayConfig = fixture.clayConfig([ { diff --git a/test/spec/lib/manipulators.js b/test/spec/lib/manipulators.js index 166a91e..1dc7828 100644 --- a/test/spec/lib/manipulators.js +++ b/test/spec/lib/manipulators.js @@ -19,9 +19,10 @@ describe('manipulators', function() { it('sets: "' + value + '" and gets: "' + expected + '" then triggers "change"', function() { var handlerSpy = sinon.spy(); - var clayItem = fixture.clayItem(itemType); + var clayItem = fixture.clayConfig([itemType]).getAllItems()[0]; clayItem.on('change', handlerSpy); + clayItem.set(value); clayItem.set(value); assert.deepEqual(clayItem.get(), expected); assert.strictEqual(handlerSpy.callCount, 1, 'handler not called once'); @@ -45,6 +46,7 @@ describe('manipulators', function() { false ); clayItem.disable(); + clayItem.disable(); assert.strictEqual( clayItem.$element[0].classList.contains('disabled'), true @@ -73,6 +75,7 @@ describe('manipulators', function() { true ); clayItem.enable(); + clayItem.enable(); assert.strictEqual( clayItem.$element[0].classList.contains('disabled'), false @@ -100,6 +103,7 @@ describe('manipulators', function() { false ); clayItem.hide(); + clayItem.hide(); assert.strictEqual( clayItem.$element[0].classList.contains('hide'), true @@ -127,6 +131,7 @@ describe('manipulators', function() { true ); clayItem.show(); + clayItem.show(); assert.strictEqual( clayItem.$element[0].classList.contains('hide'), false @@ -139,12 +144,23 @@ describe('manipulators', function() { describe('html', function() { testSetGet('text', 'test123'); + testSetGet('button', 'some HTML'); testShow('text'); testHide('text'); }); + describe('button', function() { + testSetGet('button', 'test123'); + testSetGet('button', 'some HTML'); + testDisable('button'); + testEnable('button'); + testShow('button'); + testHide('button'); + }); + describe('val', function() { testSetGet('input', 'test321'); + testSetGet('input', 1234, '1234'); testDisable('input'); testEnable('input'); testShow('text'); @@ -152,10 +168,10 @@ describe('manipulators', function() { }); describe('checked', function() { - testSetGet('toggle', true); - testSetGet('toggle', 1, true); - testSetGet('toggle', false); - testSetGet('toggle', 0, false); + testSetGet({type: 'toggle', defaultValue: false}, 1, true); + testSetGet({type: 'toggle', defaultValue: false}, true); + testSetGet({type: 'toggle', defaultValue: true}, 0, false); + testSetGet({type: 'toggle', defaultValue: true}, false); testDisable('toggle'); testEnable('toggle'); testShow('toggle'); @@ -185,6 +201,7 @@ describe('manipulators', function() { var item = { type: 'checkboxgroup', clayId: 1, + defaultValue: ['two'], options: [ { label: '1', value: 'one' }, { label: '2', value: 'two' }, @@ -207,9 +224,9 @@ describe('manipulators', function() { testSetGet('color', '0xFF0000', 0xff0000); testSetGet('color', '#ff0000', 0xff0000); testSetGet('color', 0xff0000, 0xff0000); - testSetGet('color', '', 0x000000); - testSetGet('color', false, 0x000000); - testSetGet('color', undefined, 0x000000); + testSetGet({type: 'color', defaultValue: 0x00ff00}, '', 0x000000); + testSetGet({type: 'color', defaultValue: 0x00ff00}, false, 0x000000); + testSetGet({type: 'color', defaultValue: 0x00ff00}, undefined, 0x000000); testDisable('color'); testEnable('color'); testShow('color');