ak-blanket - npm Package Compare versions

Comparing version 3.0.1 to 3.0.2

CHANGELOG.md

@@ -1,6 +0,30 @@
-<a name="3.0.0"></a>
-# 3.0.0 (2016-09-01)
+<a name="3.0.2"></a>
+## 3.0.2 (2016-09-21)
 
 
 
+<a name="ak-blanket@3.0.2"></a>
+## ak-blanket@3.0.2 (2016-09-21)
+
+
+### Bug Fixes
+
+* **component:** Fix on container name overflow and container link overflow ellipsis ([d2b733d](https://bitbucket.org/atlassian/atlaskit/commits/d2b733d))
+* Create a valid mousedown event for IE. ([0669636](https://bitbucket.org/atlassian/atlaskit/commits/0669636))
+* Do not use shadowRoot symbol ([45a8d3c](https://bitbucket.org/atlassian/atlaskit/commits/45a8d3c))
+* **docs:** Added [@version](https://github.com/version)@ to all the components ([fc0c9bf](https://bitbucket.org/atlassian/atlaskit/commits/fc0c9bf))
+* **docs:** I've made multiple changes: new installation header, new try yourself section, I've added ([c38b82f](https://bitbucket.org/atlassian/atlaskit/commits/c38b82f))
+
+
+
+<a name="ak-blanket@3.0.1"></a>
+## ak-blanket@3.0.1 (2016-09-01)
+
+
+### Bug Fixes
+
+* Bump skatejs to pull in a fix for how attributes are handled in components. ([bd9bb8f](https://bitbucket.org/atlassian/atlaskit/commits/bd9bb8f))
+
+
+
 <a name="ak-blanket@3.0.0"></a>
@@ -28,2 +52,3 @@ # ak-blanket@3.0.0 (2016-08-31)
 * **events:** Change the event name to not contain a prefix ([0c299c2](https://bitbucket.org/atlassian/atlaskit/commits/0c299c2))
+* use new ak-blanket ([9077eef](https://bitbucket.org/atlassian/atlaskit/commits/9077eef))
 
@@ -33,2 +58,3 @@
 
+* events exposed by ak-blanket changed
 * events: This changes the event name used from 'ak-blanket-click' to 'activate'
@@ -59,2 +85,3 @@
 
+* **component:** change visual styles to have fixed width, better commit icon ([957a859](https://bitbucket.org/atlassian/atlaskit/commits/957a859))
 * **package:** Publish an extra commonjs-only (no UMD) bundle for webpack consumption. ([bb0a3ce](https://bitbucket.org/atlassian/atlaskit/commits/bb0a3ce))
@@ -83,5 +110,13 @@
 
+### Bug Fixes
+
+* target for alignment fix ([20d6cc2](https://bitbucket.org/atlassian/atlaskit/commits/20d6cc2))
+* **component:** Fixed alt of img, added test for it ([d3e4b34](https://bitbucket.org/atlassian/atlaskit/commits/d3e4b34))
+
+
 ### Features
 
+* **lint:** Add support for JSX in the eslint-config-ak-base and add docs for it. ([bd59ebf](https://bitbucket.org/atlassian/atlaskit/commits/bd59ebf))
 * introducing the blanket component ([bc8c23f](https://bitbucket.org/atlassian/atlaskit/commits/bc8c23f))
+* run single storybook ([aa31b02](https://bitbucket.org/atlassian/atlaskit/commits/aa31b02))
 
@@ -88,0 +123,0 @@

dist/bundle-cjs.js

@@ -96,3 +96,3 @@ module.exports = /******/
     __webpack_require__(4);
-    var _skatejs = __webpack_require__(8), _shadow = __webpack_require__(9), _shadow2 = _interopRequireDefault(_shadow), _classnames = __webpack_require__(10), _classnames2 = _interopRequireDefault(_classnames), _events = __webpack_require__(11), events = _interopRequireWildcard(_events);
+    var _skatejs = __webpack_require__(8), _shadow = __webpack_require__(9), _shadow2 = _interopRequireDefault(_shadow), _classnames = __webpack_require__(10), _classnames2 = _interopRequireDefault(_classnames), _index = __webpack_require__(11), events = _interopRequireWildcard(_index);
     /**
@@ -126,5 +126,7 @@ * @description Create instances of the component programmatically, or using markup.
             /**
-	     * @description If click on the blanket emits a 'blanket-click' event.
+	     * @description Whether the blanket is clickable.
+	     *
 	     * @memberof Blanket
 	     * @instance
+	     * @emits Blanket#activate
 	     * @type Boolean
@@ -374,3 +376,9 @@ * @default false
     });
+    /**
+	* This event is emitted when the blanket is clicked.
+	* The emission of this event can be controlled by the {@link Blanket#clickable} property.
+	*
+	* @event Blanket#activate
+	*/
     exports.activate = "activate";
 } ]);

dist/bundle.js

@@ -99,3 +99,3 @@ !function(root, factory) {
         __webpack_require__(4);
-        var _skatejs = __webpack_require__(8), _shadow = __webpack_require__(9), _shadow2 = _interopRequireDefault(_shadow), _classnames = __webpack_require__(10), _classnames2 = _interopRequireDefault(_classnames), _events = __webpack_require__(11), events = _interopRequireWildcard(_events);
+        var _skatejs = __webpack_require__(8), _shadow = __webpack_require__(9), _shadow2 = _interopRequireDefault(_shadow), _classnames = __webpack_require__(10), _classnames2 = _interopRequireDefault(_classnames), _index = __webpack_require__(11), events = _interopRequireWildcard(_index);
         /**
@@ -129,5 +129,7 @@ * @description Create instances of the component programmatically, or using markup.
                 /**
-	     * @description If click on the blanket emits a 'blanket-click' event.
+	     * @description Whether the blanket is clickable.
+	     *
 	     * @memberof Blanket
 	     * @instance
+	     * @emits Blanket#activate
 	     * @type Boolean
@@ -377,4 +379,10 @@ * @default false
         });
+        /**
+	* This event is emitted when the blanket is clicked.
+	* The emission of this event can be controlled by the {@link Blanket#clickable} property.
+	*
+	* @event Blanket#activate
+	*/
         exports.activate = "activate";
     } ]);
 });

package.json

 {
   "name": "ak-blanket",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "ak-blanket webcomponent",
@@ -5,0 +5,0 @@ "main": "dist/bundle.js",

README.md

 # Blanket
 
-## Setup and install
+The main purpose of the blanket component is to provide the overlay layer for components such as a modal dialog or a tooltip.
 
-```
+## Try it out
+
+Interact with a [live demo of the ak-blanket component](https://aui-cdn.atlassian.com/atlaskit/stories/ak-blanket/3.0.2/).
+
+## Installation
+
+```sh
 npm install ak-blanket
@@ -19,11 +25,11 @@ ```
 
-```
+```javascript
 import 'ak-blanket';
 ```
 
-Now we can use the defined tag in our HTML markup, e.g.:
+Now you can use the defined tag in your HTML markup, for example:
 
 #### index.html
 
-```
+```html
 <html>
@@ -43,3 +49,3 @@ <head>
 
-```
+```js
 define('modal-dialog-component', () => {
@@ -64,7 +70,9 @@ attached(elem) {
 Blanket component doesn't have the z-index style, so make sure you put it into an appropriate DOM position.
-For the purpose of simplicity blanket doesn't have any `show/hide` functionality. Since the main use of it suppose to be inside `popup` elements it would appear/disapper with the parent element.
+For the purpose of simplicity blanket doesn't have any `show/hide` functionality. Since the main use of it suppose to be inside `popup` elements it would appear/disappear with the parent element.
 
 ### React
 
-```
+This is a standard web component, if you want to use it in your React app, use the Skate.js [React integration](https://github.com/webcomponents/react-integration).
+
+```js
 import Blanket from 'ak-blanket';
@@ -78,9 +86,18 @@ import reactify from 'skatejs-react-integration';
 
-## Blanket API
+<a name="Blanket"></a>
+
+## Blanket
+**Kind**: global class  
 * Properties
 
-    *  [`blanket.tinted`](#Blanket+tinted) : Boolean
-    *  [`blanket.clickable`](#Blanket+clickable) : Boolean
+    *  [`blanket.tinted`](#Blanket+tinted) : <code>Boolean</code>
+    *  [`blanket.clickable`](#Blanket+clickable) : <code>Boolean</code>
 
-### Constructor
+* Events
+
+    *  [`"activate"`](#Blanket+event_activate)
+
+<a name="new_Blanket_new"></a>
+
+### `new Blanket()`
 Create instances of the component programmatically, or using markup.
@@ -93,7 +110,9 @@
 ```
-### `blanket.tinted` : Boolean
+<a name="Blanket+tinted"></a>
+
+### `blanket.tinted` : <code>Boolean</code>
 Is blanket grey with opacity or transparent. By default it's transparent.
 
-**Kind**: instance property of Blanket  
-**Default**: `false`  
+**Kind**: instance property of <code>[Blanket](#Blanket)</code>  
+**Default**: <code>false</code>  
 **HTML Example**
@@ -107,7 +126,10 @@ ```js
 ```
-### `blanket.clickable` : Boolean
-If click on the blanket emits a 'blanket-click' event.
+<a name="Blanket+clickable"></a>
 
-**Kind**: instance property of Blanket  
-**Default**: `false`  
+### `blanket.clickable` : <code>Boolean</code>
+Whether the blanket is clickable.
+
+**Kind**: instance property of <code>[Blanket](#Blanket)</code>  
+**Default**: <code>false</code>  
+**Emits**: <code>[activate](#Blanket+event_activate)</code>  
 **HTML Example**
@@ -121,1 +143,8 @@ ```js
 ```
+<a name="Blanket+event_activate"></a>
+
+### `"activate"`
+This event is emitted when the blanket is clicked.
+The emission of this event can be controlled by the [clickable](#Blanket+clickable) property.
+
+**Kind**: event emitted by <code>[Blanket](#Blanket)</code>  

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

172214

increased by221.97%

Number of package files

10

increased by25%

Lines of code

2543

increased by237.27%

Number of lines in readme file

143

increased by24.35%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes