ak-button - npm Package Compare versions

Comparing version 4.0.1 to 4.0.2

CHANGELOG.md

@@ -1,6 +0,16 @@
-<a name="4.0.1"></a>
-## 4.0.1 (2016-11-21)
+<a name="4.0.2"></a>
+## 4.0.2 (2016-11-22)
 
 
 
+<a name="ak-button@4.0.2"></a>
+## ak-button@4.0.2 (2016-11-22)
+
+
+### Bug Fixes
+
+* **docs:** support docs for JSX files and add missing JSDoc class annotations ([0204a7e](https://bitbucket.org/atlassian/atlaskit/commits/0204a7e))
+
+
+
 <a name="ak-button@3.1.1"></a>
@@ -7,0 +17,0 @@ ## ak-button@3.1.1 (2016-11-21)

package.json

 {
   "name": "ak-button",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "ak-button webcomponent",
@@ -5,0 +5,0 @@ "main": "dist/bundle.js",

README.md

@@ -5,3 +5,3 @@ [![AtlasKit component registry](https://img.shields.io/badge/AtlasKit-components-FF5230.svg)](http://aui-cdn.atlassian.com/atlaskit/registry/)
 [![Report an issue](https://img.shields.io/badge/Report-an_issue-6554C0.svg)](https://ecosystem.atlassian.net/browse/AK)
-[![Ask in our forum](https://img.shields.io/badge/Ask-in_our_forum-6554C0.svg)](https://answers.atlassian.com/questions/ask?title=AtlasKit%3A%20&topics=atlaskit,ak-button,ak-button@4.0.1)
+[![Ask in our forum](https://img.shields.io/badge/Ask-in_our_forum-6554C0.svg)](https://answers.atlassian.com/questions/ask?title=AtlasKit%3A%20&topics=atlaskit,ak-button,ak-button@4.0.2)
 
@@ -12,9 +12,9 @@ # Button
 
-![Example buttons](https://bytebucket.org/atlassian/atlaskit/raw/dc1eade69a3842acc98311236846cf103c5447c0/packages/ak-button/docs/button_1.png)
+![Example buttons](https://bytebucket.org/atlassian/atlaskit/raw/10507aa785346305cec7fcb0d0221885d3802710/packages/ak-button/docs/button_1.png)
 
-![Example buttons](https://bytebucket.org/atlassian/atlaskit/raw/dc1eade69a3842acc98311236846cf103c5447c0/packages/ak-button/docs/button_2.png)
+![Example buttons](https://bytebucket.org/atlassian/atlaskit/raw/10507aa785346305cec7fcb0d0221885d3802710/packages/ak-button/docs/button_2.png)
 
 ## Try it out
 
-Interact with a [live demo of the ak-button component](https://aui-cdn.atlassian.com/atlaskit/stories/ak-button/4.0.1/).
+Interact with a [live demo of the ak-button component](https://aui-cdn.atlassian.com/atlaskit/stories/ak-button/4.0.2/).
 
@@ -39,4 +39,96 @@ ## Installation
 
+<a name="Button"></a>
 
+## Button
+**Kind**: global class  
+* Properties
 
+    *  [Button.appearance](#Button.appearance) : <code>string</code>
+    *  [Button.type](#Button.type) : <code>string</code>
+    *  [Button.href](#Button.href) : <code>string</code>
+    *  [Button.target](#Button.target) : <code>string</code>
+    *  [Button.disabled](#Button.disabled) : <code>boolean</code>
+    *  [Button.spacing](#Button.spacing) : <code>string</code>
+    *  [Button.selected](#Button.selected) : <code>boolean</code>
+    *  [Button.theme](#Button.theme) : <code>boolean</code>
+    *  [Button.iconBefore](#Button.iconBefore) : <code>element</code>
+    *  [Button.iconAfter](#Button.iconAfter) : <code>element</code>
+
+<a name="new_Button_new"></a>
+
+### new Button()
+Create instances of the Button component in a React context.
+
+<a name="Button.appearance"></a>
+
+### Button.appearance : <code>string</code>
+Predefined appearances of an ak-button. One of:
+'primary', 'default', 'subtle', 'compact'
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+**Default**: <code>&quot;&#x27;standard&#x27;&quot;</code>  
+<a name="Button.type"></a>
+
+### Button.type : <code>string</code>
+Type of the ak-button. One of:
+'button', 'submit'.
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+**Default**: <code>&quot;button&quot;</code>  
+<a name="Button.href"></a>
+
+### Button.href : <code>string</code>
+href of the ak-button.
+If href is set, button will redirect to href url when clicked.
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+**Default**: <code>&quot;button&quot;</code>  
+<a name="Button.target"></a>
+
+### Button.target : <code>string</code>
+Standard target attribute for hyperlinks
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+<a name="Button.disabled"></a>
+
+### Button.disabled : <code>boolean</code>
+Option to disable button and every click event
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+**Default**: <code>false</code>  
+<a name="Button.spacing"></a>
+
+### Button.spacing : <code>string</code>
+Option to change button's padding. One of:
+'none', 'compact', 'default'
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+**Default**: <code>&quot;&#x27;default&#x27;&quot;</code>  
+<a name="Button.selected"></a>
+
+### Button.selected : <code>boolean</code>
+Option to make a button selected
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+**Default**: <code>false</code>  
+<a name="Button.theme"></a>
+
+### Button.theme : <code>boolean</code>
+Option to make have a dark look and feel of a button.
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+**Default**: <code>false</code>  
+<a name="Button.iconBefore"></a>
+
+### Button.iconBefore : <code>element</code>
+iconBefore
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+<a name="Button.iconAfter"></a>
+
+### Button.iconAfter : <code>element</code>
+iconAfter
+
+**Kind**: static property of <code>[Button](#Button)</code>  
+
 ## Support and feedback
@@ -50,3 +142,3 @@
 
-Ask a question in our [forum](https://answers.atlassian.com/questions/ask?title=AtlasKit%3A%20&topics=atlaskit,ak-button,ak-button@4.0.1).
+Ask a question in our [forum](https://answers.atlassian.com/questions/ask?title=AtlasKit%3A%20&topics=atlaskit,ak-button,ak-button@4.0.2).
 
@@ -53,0 +145,0 @@ Check [if someone has already asked the same question before](https://answers.atlassian.com/questions/topics/42926171/atlaskit).

New alerts

License Policy Violation

License

This 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

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

161711

increased by2.03%

Number of lines in readme file

148

increased by164.29%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes