clay-sticker - npm Package Compare versions

Comparing version 2.0.0-rc.9 to 2.0.0-rc.10

lib/ClaySticker.js

@@ -38,2 +38,3 @@ 'use strict';
  * Implementation of the Metal Clay Link.
+ * @extends Component
  */
@@ -62,6 +63,6 @@ var ClaySticker = function (_Component) {
   * CSS classes to be applied to the element.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?string|undefined}
-  * @default undefined
+  * @type {?(string|undefined)}
   */
@@ -72,6 +73,6 @@ elementClasses: _metalState.Config.string(),
   * Render ClayIcon in the ClaySticker element.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?string|undefined}
-  * @default undefined
+  * @type {?(string|undefined)}
   */
@@ -82,6 +83,6 @@ icon: _metalState.Config.string(),
   * Id to be applied to the sticker element.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?string|undefined}
-  * @default undefined
+  * @type {?(string|undefined)}
   */
@@ -92,6 +93,6 @@ id: _metalState.Config.string(),
   * Alternate text of the image.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?string|undefined}
-  * @default undefined
+  * @type {?(string|undefined)}
   */
@@ -102,6 +103,6 @@ imageAlt: _metalState.Config.string(),
   * Source of the image to be rendered inside the sticker.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?string|undefined}
-  * @default undefined
+  * @type {?(string|undefined)}
   */
@@ -112,6 +113,6 @@ imageSrc: _metalState.Config.string(),
   * Sets the text or HTML to be rendered inside sticker.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?html|string|undefined}
-  * @default undefined
+  * @type {?(html|string|undefined)}
   */
@@ -123,6 +124,6 @@ label: _metalState.Config.any(),
   * corners when position is defined.
+  * @default false
   * @instance
   * @memberof ClaySticker
   * @type {?bool}
-  * @default false
   */
@@ -135,6 +136,6 @@ outside: _metalState.Config.bool().value(false),
   * and `top-right`.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?string|undefined}
-  * @default undefined
+  * @type {?(string|undefined)}
   */
@@ -145,6 +146,6 @@ position: _metalState.Config.oneOf(['bottom-left', 'bottom-right', 'top-left', 'top-right']),
   * Sticker size. Available sizes are `sm`, `lg`, `xl`.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?string|undefined}
-  * @default undefined
+  * @type {?(string|undefined)}
   */
@@ -155,6 +156,6 @@ size: _metalState.Config.oneOf(['lg', 'sm', 'xl']),
   * Shape of the sticker. Available shapes are `circle`, `rounded`.
+  * @default rounded
   * @instance
   * @memberof ClaySticker
   * @type {?string}
-  * @default rounded
   */
@@ -165,6 +166,6 @@ shape: _metalState.Config.oneOf(['circle', 'rounded']).value('rounded'),
   * The path to the SVG spritemap file containing the icons.
+  * @default undefined
   * @instance
   * @memberof ClaySticker
-  * @type {?string|undefined}
-  * @default undefined
+  * @type {?(string|undefined)}
   */
@@ -176,6 +177,6 @@ spritemap: _metalState.Config.string(),
   * `primary`, `secondary`, `success`, `warning`.
+  * @default primary
   * @instance
   * @memberof ClaySticker
   * @type {?string}
-  * @default primary
   */
@@ -182,0 +183,0 @@ style: _metalState.Config.oneOf(['danger', 'dark', 'info', 'light', 'primary', 'secondary', 'success', 'unstyled', 'warning']).value('primary')

package.json

 {
   "name": "clay-sticker",
-  "version": "2.0.0-rc.9",
+  "version": "2.0.0-rc.10",
   "description": "Clay Sticker Component",
@@ -30,3 +30,3 @@ "license": "BSD",
   "dependencies": {
-    "clay-icon": "^2.0.0-rc.9",
+    "clay-icon": "^2.0.0-rc.10",
     "metal": "^2.16.0",
@@ -44,4 +44,4 @@ "metal-component": "^2.16.0",
     "babel-preset-env": "^1.6.0",
-    "browserslist-config-clay-components": "^2.0.0-rc.9",
-    "clay": "^2.0.0-rc.9",
+    "browserslist-config-clay-components": "^2.0.0-rc.10",
+    "clay": "^2.0.0-rc.10",
     "metal-dom": "^2.13.2",
@@ -48,0 +48,0 @@ "metal-tools-soy": "^6.0.0",

src/ClaySticker.js

@@ -11,2 +11,3 @@ import 'clay-icon';
  * Implementation of the Metal Clay Link.
+ * @extends Component
  */
@@ -23,6 +24,6 @@ class ClaySticker extends Component {}
 	 * CSS classes to be applied to the element.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?string|undefined}
-	 * @default undefined
+	 * @type {?(string|undefined)}
 	 */
@@ -33,6 +34,6 @@ elementClasses: Config.string(),
 	 * Render ClayIcon in the ClaySticker element.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?string|undefined}
-	 * @default undefined
+	 * @type {?(string|undefined)}
 	 */
@@ -43,6 +44,6 @@ icon: Config.string(),
 	 * Id to be applied to the sticker element.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?string|undefined}
-	 * @default undefined
+	 * @type {?(string|undefined)}
 	 */
@@ -53,6 +54,6 @@ id: Config.string(),
 	 * Alternate text of the image.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?string|undefined}
-	 * @default undefined
+	 * @type {?(string|undefined)}
 	 */
@@ -63,6 +64,6 @@ imageAlt: Config.string(),
 	 * Source of the image to be rendered inside the sticker.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?string|undefined}
-	 * @default undefined
+	 * @type {?(string|undefined)}
 	 */
@@ -73,6 +74,6 @@ imageSrc: Config.string(),
 	 * Sets the text or HTML to be rendered inside sticker.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?html|string|undefined}
-	 * @default undefined
+	 * @type {?(html|string|undefined)}
 	 */
@@ -84,6 +85,6 @@ label: Config.any(),
 	 * corners when position is defined.
+	 * @default false
 	 * @instance
 	 * @memberof ClaySticker
 	 * @type {?bool}
-	 * @default false
 	 */
@@ -96,6 +97,6 @@ outside: Config.bool().value(false),
 	 * and `top-right`.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?string|undefined}
-	 * @default undefined
+	 * @type {?(string|undefined)}
 	 */
@@ -111,6 +112,6 @@ position: Config.oneOf([
 	 * Sticker size. Available sizes are `sm`, `lg`, `xl`.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?string|undefined}
-	 * @default undefined
+	 * @type {?(string|undefined)}
 	 */
@@ -121,6 +122,6 @@ size: Config.oneOf(['lg', 'sm', 'xl']),
 	 * Shape of the sticker. Available shapes are `circle`, `rounded`.
+	 * @default rounded
 	 * @instance
 	 * @memberof ClaySticker
 	 * @type {?string}
-	 * @default rounded
 	 */
@@ -131,6 +132,6 @@ shape: Config.oneOf(['circle', 'rounded']).value('rounded'),
 	 * The path to the SVG spritemap file containing the icons.
+	 * @default undefined
 	 * @instance
 	 * @memberof ClaySticker
-	 * @type {?string|undefined}
-	 * @default undefined
+	 * @type {?(string|undefined)}
 	 */
@@ -142,6 +143,6 @@ spritemap: Config.string(),
 	 * `primary`, `secondary`, `success`, `warning`.
+	 * @default primary
 	 * @instance
 	 * @memberof ClaySticker
 	 * @type {?string}
-	 * @default primary
 	 */
@@ -148,0 +149,0 @@ style: Config.oneOf([

No alert changes

Improved metrics

Total package byte prevSize

74698

increased by0.17%

Lines of code

846

increased by0.24%

Dependency changes

• Updatedclay-icon@^2.0.0-rc.10