ak-layer - npm Package Compare versions
Comparing version 57.7.0 to 57.7.1
@@ -1,6 +0,18 @@ | ||
| <a name="57.7.0"></a> | ||
| # 57.7.0 (2016-09-19) | ||
| <a name="57.7.1"></a> | ||
| ## 57.7.1 (2016-09-21) | ||
| <a name="ak-layer@57.7.1"></a> | ||
| ## ak-layer@57.7.1 (2016-09-21) | ||
| ### Bug Fixes | ||
| * **docs:** Added [@version](https://github.com/version)@ to all the components ([fc0c9bf](https://bitbucket.org/atlassian/atlaskit/commits/fc0c9bf)) | ||
| * **docs:** Fixes Layer docs to call .isFLipped a prop rather than a function ([97bb8af](https://bitbucket.org/atlassian/atlaskit/commits/97bb8af)) | ||
| * **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-layer@57.7.0"></a> | ||
@@ -12,2 +24,3 @@ # ak-layer@57.7.0 (2016-09-19) | ||
| * **ak-layer:** Removed references to onUpdate callback ([16149c3](https://bitbucket.org/atlassian/atlaskit/commits/16149c3)) | ||
| * **docs:** Adds some more jsdoc annotations to ak-layer ([6fb42cd](https://bitbucket.org/atlassian/atlaskit/commits/6fb42cd)) | ||
@@ -43,2 +56,4 @@ * Create a valid mousedown event for IE. ([0669636](https://bitbucket.org/atlassian/atlaskit/commits/0669636)) | ||
| * **component:** Fix on container name overflow and container link overflow ellipsis ([d2b733d](https://bitbucket.org/atlassian/atlaskit/commits/d2b733d)) | ||
| * **component:** Fixes bug in ak-layer where updating the target prop didnt update the Layers positio ([92076bb](https://bitbucket.org/atlassian/atlaskit/commits/92076bb)) | ||
| * **component:** Fixses bug in Tooltips where animation comes from wrong direction when tooltip flips ([78fa1be](https://bitbucket.org/atlassian/atlaskit/commits/78fa1be)) | ||
@@ -45,0 +60,0 @@ |
@@ -213,3 +213,3 @@ module.exports = /******/ | ||
| * @instance | ||
| * @return undefined | ||
| * @return Layer | ||
| * @example @js layer.reposition(); | ||
@@ -224,3 +224,3 @@ */ | ||
| * @instance | ||
| * @return Boolean | ||
| * @type Boolean | ||
| * @example @js const isFlipped = elem.isFlipped; | ||
@@ -227,0 +227,0 @@ */ |
@@ -216,3 +216,3 @@ !function(root, factory) { | ||
| * @instance | ||
| * @return undefined | ||
| * @return Layer | ||
| * @example @js layer.reposition(); | ||
@@ -227,3 +227,3 @@ */ | ||
| * @instance | ||
| * @return Boolean | ||
| * @type Boolean | ||
| * @example @js const isFlipped = elem.isFlipped; | ||
@@ -230,0 +230,0 @@ */ |
| { | ||
| "name": "ak-layer", | ||
| "version": "57.7.0", | ||
| "version": "57.7.1", | ||
| "description": "A layer component", | ||
@@ -5,0 +5,0 @@ "main": "dist/bundle.js", |
@@ -7,4 +7,8 @@ # Layer | ||
| ## Setup and install | ||
| ## Try it out | ||
| Interact with a [live demo of the ak-layer component](https://aui-cdn.atlassian.com/atlaskit/stories/ak-layer/57.7.1/). | ||
| ## Installation | ||
| ```sh | ||
@@ -16,4 +20,10 @@ npm install ak-layer | ||
| ### HTML | ||
| The `ak-layer` package exports the Layer [skate](https://github.com/skatejs/skatejs) component: | ||
| Import the component in your JS resource: | ||
| #### bundle.js | ||
| ```js | ||
@@ -24,3 +34,30 @@ import Layer from 'ak-layer'; | ||
| ``` | ||
| Now you can use the defined layer in your HTML markup: | ||
| #### index.html | ||
| ``` | ||
| <html> | ||
| <head> | ||
| <script src="bundle.js"></script> | ||
| </head> | ||
| <body> | ||
| <!-- ... --> | ||
| <ak-layer></ak-layer> | ||
| </body> | ||
| ``` | ||
| ### 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). | ||
| ``` | ||
| import Layer from 'ak-layer'; | ||
| import reactify from 'skatejs-react-integration'; | ||
| const ReactComponent = reactify(Layer, {}); | ||
| ReactDOM.render(<ReactComponent />, container); | ||
| ``` | ||
| <a name="Layer"></a> | ||
@@ -39,3 +76,3 @@ | ||
| * [`layer.onUpdate`](#Layer+onUpdate) : <code>function</code> | ||
| * [`layer.isFlipped`](#Layer+isFlipped) ⇒ | ||
| * [`layer.isFlipped`](#Layer+isFlipped) : <code>Boolean</code> | ||
@@ -189,7 +226,6 @@ * Methods | ||
| ### `layer.isFlipped` ⇒ | ||
| ### `layer.isFlipped` : <code>Boolean</code> | ||
| Will be true if a Layer has been flipped from its original position. | ||
| **Kind**: instance property of <code>[Layer](#Layer)</code> | ||
| **Returns**: Boolean | ||
| **JS Example** | ||
@@ -207,3 +243,3 @@ ```js | ||
| **Kind**: instance method of <code>[Layer](#Layer)</code> | ||
| **Returns**: undefined | ||
| **Returns**: Layer | ||
| **JS Example** | ||
@@ -210,0 +246,0 @@ ```js |
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.56%
320446
- Number of lines in readme file
- increased by17.48%
242