@afconsult/apollo - npm Package Compare versions

Comparing version 1.2.7 to 1.2.8

package.json

 {
   "name": "@afconsult/apollo",
-  "version": "1.2.7",
+  "version": "1.2.8",
   "description": "Design system for ÅF Web Apps",
@@ -5,0 +5,0 @@ "main": "index.js",

src/components/Alert/README.md

@@ -24,4 +24,4 @@ # Alert
 | color     | `string` | `primary`    | Specifies the alert color. Can be one of `'primary'`, `'secondary'`, `'danger'`, `'success'`, `'warning'`, `'info'` |
-| onToggle  | `func`   | `undefined`  | |
-| open      | `bool`   | `true`       | |
+| onToggle  | `func`   | `undefined`  | Called for toggling `open` in the controlling component. |
+| open      | `bool`   | `true`       | Control the alert visibility state. |
 | tag       | `[func, string]`| `div` | Specifies the DOM element to be used. |

src/components/Breadcrumbs/README.md

@@ -24,3 +24,3 @@ # Breadcrumbs
 |-----------|----------|-------------|-------------|
-| children  | `node`   | `undefined` | | 
+| children  | `node`   | `undefined` | Collection of DOM child elements. | 
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
@@ -33,3 +33,3 @@ | tag       | `[func, string]` | `nav` | Specifies the DOM element to be used. |
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
-| active    | `bool`   | `false`     | | 
+| active    | `bool`   | `false`     | Control the breadcrumb state. | 
 | tag       | `[func, string]` | `a` | Specifies the DOM element to be used. |

src/components/Dropdown/README.md

@@ -13,3 +13,3 @@ # Dropdown
     super(props);
-    this.state = { isOpen: false };
+    this.state = { open: false };
     this.handleToggle = this.handleToggle.bind(this);
@@ -19,10 +19,10 @@ }
   handleToggle(e) {
-    this.setState(state => { isOpen: !state.isOpen });
+    this.setState(state => { open: !state.open });
   }
   
   render() {
-    const { isOpen } = this.state;
+    const { open } = this.state;
     
     return (
-      <Dropdown onToggle={this.handleToggle} open={isOpen}>
+      <Dropdown onToggle={this.handleToggle} open={open}>
         <DropdownToggle>
@@ -48,5 +48,5 @@ Dropdown
 | className | `string` | `undefined`  | Classes to be applied to the DOM element. |
-| disabled  | `bool`   | `undefined`  | |
-| onToggle  | `func`   | `undefined`  | |
-| open      | `bool`   | `false`      | |
+| disabled  | `bool`   | `undefined`  | Control the dropdown disable state. |
+| onToggle  | `func`   | `undefined`  | Called for toggling `open` in the controlling component. |
+| open      | `bool`   | `false`      | Control the dropdown visibility state. |
 | tag       | `[func, string] `| `div`| Specifies the DOM element to be used. |
@@ -57,6 +57,6 @@
 |-----------|----------|--------------|-------------|
-| active    | `bool`   | `false`      | |
+| active    | `bool`   | `false`      | Control the dropdown toggle active state. |
 | className | `string` | `undefined`  | Classes to be applied to the DOM element. |
-| disabled  | `bool`   | `false`      | |
-| onClick   | `func`   | `undefined`  | |
+| disabled  | `bool`   | `false`      | Control the dropdown toggle disable state. |
+| onClick   | `func`   | `undefined`  | Called back when the DOM element is clicked. |
 | tag       | `[func, string] `| `a`| Specifies the DOM element to be used. |
@@ -68,3 +68,3 @@
 | className | `string` | `undefined`  | Classes to be applied to the DOM element. |
-| right     | `bool`   | `false`      | |
+| right     | `bool`   | `false`      | Align the menu right instead of default left. |
 | tag       | `[func, string] `| `div`| Specifies the DOM element to be used. |
@@ -75,9 +75,8 @@
 |-----------|----------|--------------|-------------|
-| active    | `bool`   | `false`     | |
+| active    | `bool`   | `false`     | Control the dropdown item active state. |
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
-| disabled  | `bool`   | `false`     | |
-| header    | `bool`   | `false`     | |
-| href      | `string` | `undefined` | |
-| onClick   | `func`   | `undefined` | |
-| separator | `bool`   | `false`     |
+| disabled  | `bool`   | `false`     | Control the dropdown item disable state. |
+| header    | `bool`   | `false`     | Control if the dropdown item should be rendered as a header |
+| onClick   | `func`   | `undefined` | Called back when the DOM element is clicked. |
+| separator | `bool`   | `false`     | Specifies if the dropdown item should be rendered as a separator |
 | tag       | `[func, string] `| `button`| Specifies the DOM element to be used. |
@@ -84,0 +83,0 @@

src/components/Follow/README.md

@@ -35,3 +35,3 @@ # Follow
 | active    | `bool`   | `false`      | Classes to be applied to the DOM element. |
-| children  | `[func, node, string]`  | `undefined` | |
+| children  | `[func, node, string]`  | `undefined` | Collection of DOM child elements. |
 | className | `string` | `undefined`  | Classes to be applied to the DOM element. |
@@ -38,0 +38,0 @@ | icon      | `string` | `undefined`  | Specifies the url of an image icon. |

src/components/Form/README.md

@@ -62,3 +62,3 @@ # Form
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
-| inline    | `bool`   | `false`     | |
+| inline    | `bool`   | `false`     | Specifies that all DOM children should be displayed as `inline-block`. |
 | innerRef  | `[func, object, string]` | `undefined` | Add a `ref` to the DOM element. |
@@ -69,5 +69,5 @@
 |-----------|----------|-------------|-------------|
-| check     | `bool`   | `false`     | |
+| check     | `bool`   | `false`     | Styles the form group for input types [`'checkbox'`, `'radio'`] when `true`, default when `false`. |
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
-| inline    | `bool`   | `false`     | |
+| inline    | `bool`   | `false`     | Specifies that all DOM children should be displayed as `inline-block`. |
 
@@ -78,3 +78,3 @@ #### Props [FormFeedback](../FormFeedback)
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
-| indented  | `bool`   | `false`     | |
+| indented  | `bool`   | `false`     | Specifies that the text should be indented. |
 | valid     | `bool`   | `false`     | Specifies the value of the DOM element. |
@@ -197,9 +197,9 @@
 |-----------|----------|-------------|-------------|
-| checked   | `bool`   | `false`     | |
+| checked   | `bool`   | `false`     | Specifies that the radio button should be pre-selected when the page loads. |
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
 | disabled  | `bool`   | `false`     | Specifies that the DOM element should be disabled. |
 | id        | `string` | `undefined` | A unique id for the DOM element. |
-| name      | `string` | `undefined` | 	Specifies the name of the DOM element. |
+| name      | `string` | `undefined` | Specifies the name of the DOM element. |
 | onChange  | `func`   | `undefined` | Called when the value of the DOM element has been changed. |
-| readOnly  | `bool`   | `false`     | |
+| readOnly  | `bool`   | `false`     | Specifies that the radio button should be read-only. |
 | value     | `string` | `undefined` | Specifies the value of the DOM element. |
@@ -235,3 +235,3 @@
 |-----------|----------|-------------|-------------|
-| checked   | `bool`   | `false`     | |
+| checked   | `bool`   | `false`     | Specifies that the checkbox should be pre-selected when the page loads. |
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
@@ -242,3 +242,3 @@ | disabled  | `bool`   | `false`     | Specifies that the DOM element should be disabled. |
 | onChange  | `func`   | `undefined` | Called when the value of the DOM element has been changed. |
-| readOnly  | `bool`   | `false`     | |
+| readOnly  | `bool`   | `false`     | Specifies that the select should be read-only. |
 | value     | `string` | `undefined` | Specifies the value of the DOM element. |
@@ -270,3 +270,3 @@
 | className | `string` | `undefined` | Classes to be applied to the DOM element. |
-| columns   | `string` | `39`        |
+| columns   | `string` | `39`        | Specifies the visible width of a text area. |
 | disabled  | `bool`   | `false`     | Specifies that the DOM element should be disabled. |
@@ -276,2 +276,2 @@ | id        | `string` | `undefined` | A unique id for the DOM element. |
 | onChange  | `func`   | `undefined` | Called when the value of the DOM element has been changed. |
-| rows      | `string` | `1`         |
+| rows      | `string` | `1`         | Specifies the visible number of lines in a text area. |

src/components/Mention/README.md

@@ -1,1 +0,22 @@
-## Mention
+# Mention
+
+#### Example
+```jsx
+import React from 'react';
+import { Mention } from '@afconsult/apollo';
+
+const Example extends React.PureComponent {
+  render() {
+    return (
+      <Mention>
+        Stockholm
+      </Mention>
+    );
+  }
+}
+```
+
+#### Props
+| Name      | PropType | Default      | Description |
+|-----------|----------|--------------|-------------|
+| children  | `[func, node, string]`  | `undefined` | Collection of DOM child elements. |

No alert changes

Improved metrics

Total package byte prevSize

3816617

increased by0.04%

Worsened metrics

Lines of code

15639

decreased by-0.01%

No dependency changes