@afconsult/apollo - npm Package Compare versions

Comparing version 1.1.17 to 1.1.18

package.json

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

README.md

@@ -21,3 +21,3 @@ # Apollo Design System
 1. Import the stylesheet:
-```javscript
+```jsx
 import '@afconsult/apollo/dist/css/apollo.css';
@@ -27,3 +27,3 @@ ```
 2. Import required apollo components:
-```javascript
+```jsx
 import { Button, Form, FormGroup, Input, Label } from '@afconsult/apollo';
@@ -33,3 +33,3 @@ ```
 3. Use the components:
-```javascript
+```jsx
 class Example extends React.PureComponent {
@@ -36,0 +36,0 @@ render() {

src/components/Badge/README.md

@@ -1,1 +0,25 @@
-## Badge
+# Badge
+
+#### Example
+``` jsx
+import React from 'react';
+import { Badge } from '@afconsult/apollo';
+
+export default class Example extends React.PureComponent {  
+  render() {
+    return (
+      <div>
+        <Badge>Group</Badge>
+        <Badge color="secondary">Project</Badge>
+      </div>
+    );
+  }
+}
+```
+
+#### Props
+| Name      | PropType | Default     | Description |
+|-----------|----------|-------------|-------------|
+| className | `string` | `undefined` | Classes to be applied to the DOM element. |
+| color     | `string` | `primary` | Specifies the color scheme. Can be one of `'primary'`, `'secondary'` | 
+| tag       | `[func, string]` | `span` | Specifies the DOM element to be used. |

src/components/Breadcrumbs/README.md

@@ -1,1 +0,33 @@
-## Breadcrumbs
+# Breadcrumbs
+
+#### Example
+``` jsx
+import React from 'react';
+import { Breadcrumbs, Breadcrumb } from '@afconsult/apollo';
+
+export default class Example extends React.PureComponent {  
+  render() {
+    return (
+      <Breadcrumbs>
+        <Breadcrumb>first</Breadcrumb>
+        <Breadcrumb>second</Breadcrumb>
+        <Breadcrumb active>active</Breadcrumb>
+      </Breadcrumbs>
+    );
+  }
+}
+```
+
+#### Props [Breadcrumbs](./)
+| Name      | PropType | Default     | Description |
+|-----------|----------|-------------|-------------|
+| children  | `node`   | `undefined` | | 
+| className | `string` | `undefined` | Classes to be applied to the DOM element. |
+| tag       | `[func, string]` | `nav` | Specifies the DOM element to be used. |
+
+#### Props [Breadcrumb](../Breadcrumb)
+| Name      | PropType | Default     | Description |
+|-----------|----------|-------------|-------------|
+| className | `string` | `undefined` | Classes to be applied to the DOM element. |
+| active    | `bool`   | `false`     | | 
+| tag       | `[func, string]` | `a` | Specifies the DOM element to be used. |

src/components/Follow/README.md

@@ -1,4 +0,5 @@
-### Follow
+# Follow
 
-```javascript
+#### Example
+```jsx
 const Example extends React.Component {
@@ -28,2 +29,12 @@ constructor(props) {
 }
-```
+```
+
+#### Props
+| Name      | PropType | Default      | Description |
+|-----------|----------|--------------|-------------|
+| active    | `bool`   | `false`      | Classes to be applied to the DOM element. |
+| children  | `[func, node, string]`  | `undefined` | |
+| className | `string` | `undefined`  | Classes to be applied to the DOM element. |
+| icon      | `string` | `undefined`  | |
+| onClick   | `func`   | `undefined`  | | 
+| onToggle  | `func`   | `undefined`  | | 

src/components/Jumbotron/README.md

@@ -1,1 +0,24 @@
-## Jumbotron
+# Jumbotron
+
+#### Example
+```jsx
+import React from 'react';
+import { Jumbotron } from '@afconsult/apollo';
+
+const Example extends React.PureComponent {
+  render() {
+    return (
+      <Jumbotron>
+        <h1>Lorem ipsum dolor</h1>
+        <p>Put a bird on it ethical fanny pack shoreditch la croix.</p>
+      </Jumbotron>
+    );
+  }
+}
+```
+
+#### Props
+| Name      | PropType | Default      | Description |
+|-----------|----------|--------------|-------------|
+| className | `string` | `undefined`  | Classes to be applied to the DOM element. |
+| tag       | `[func, string] `| `div`| Specifies the DOM element to be used. |

src/components/Loader/README.md

@@ -1,1 +0,26 @@
-## Loader
+# Loader
+
+Loader component is a wrapper of [React Lottie](https://www.npmjs.com/package/react-lottie).
+
+#### Example
+``` jsx
+import React from 'react';
+import { Loader } from '@afconsult/apollo';
+
+export default class Example extends React.PureComponent {  
+  render() {
+    return (
+      <Loader width={25} height={25} />
+    );
+  }
+}
+```
+
+#### Props
+| Name      | PropType | Default     | Description |
+|-----------|----------|-------------|-------------|
+| autoPlay  | `bool`   | `true`      | Bodymovin option to auto plays the animation. |
+| className | `string` | `undefined` | Classes to be applied to the DOM element. |
+| height    | `[number, string]` | `250` | Pixel value for lottie container height. | 
+| loop      | `bool`   | `true` | Bodymovin option to loop the animation. |
+| width     | `[number, string]` | `250` | Pixel value for lottie container width. |

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

Improved metrics

Total package byte prevSize

3777205

increased by0.1%

Worsened metrics

Number of package files

86

decreased by-1.15%

No dependency changes