@avsync.live/formation - npm Package Compare versions

Comparing version 0.9.5 to 0.9.6

dist/cjs/components/Sidebar/Sidebar.d.ts

@@ -5,11 +5,11 @@ /// <reference types="react" />
     type?: string;
-    href: string;
+    href?: string;
     title?: string;
-    icon: IconName;
+    icon?: IconName;
     iconPrefix?: IconPrefix;
-    name: string;
-    toolTipTitle: string;
+    name?: string;
+    toolTipTitle?: string;
     active?: boolean;
-    newTab: boolean;
-    onClick: () => void;
+    newTab?: boolean;
+    onClick?: () => void;
 }
@@ -16,0 +16,0 @@ export declare type Navs = NavProps[];

dist/esm/components/Sidebar/Sidebar.d.ts

@@ -5,11 +5,11 @@ /// <reference types="react" />
     type?: string;
-    href: string;
+    href?: string;
     title?: string;
-    icon: IconName;
+    icon?: IconName;
     iconPrefix?: IconPrefix;
-    name: string;
-    toolTipTitle: string;
+    name?: string;
+    toolTipTitle?: string;
     active?: boolean;
-    newTab: boolean;
-    onClick: () => void;
+    newTab?: boolean;
+    onClick?: () => void;
 }
@@ -16,0 +16,0 @@ export declare type Navs = NavProps[];

dist/index.d.ts

@@ -335,11 +335,11 @@ /// <reference types="react" />
     type?: string;
-    href: string;
+    href?: string;
     title?: string;
-    icon: IconName;
+    icon?: IconName;
     iconPrefix?: IconPrefix;
-    name: string;
-    toolTipTitle: string;
+    name?: string;
+    toolTipTitle?: string;
     active?: boolean;
-    newTab: boolean;
-    onClick: () => void;
+    newTab?: boolean;
+    onClick?: () => void;
 }
@@ -346,0 +346,0 @@ declare type Navs = NavProps[];

package.json

@@ -7,3 +7,3 @@ {
   },
-  "version": "0.9.5",
+  "version": "0.9.6",
   "description": "A component library utilizing React, Styled Components, and CSS variables.",
@@ -10,0 +10,0 @@ "keywords": [

README.md

@@ -25,10 +25,24 @@ # Formation
 
+import { Page, StyleHTML, Button } from '@avsync.live/formation'
+
 import '@avsync.live/formation/dist/index.dark.css' // or index.light.css
 
+// fontawesome
 import '@fortawesome/fontawesome-svg-core/styles.css'
 import { library } from '@fortawesome/fontawesome-svg-core'
-import { faHeart } from '@fortawesome/free-solid-svg-icons'
-library.add(faHeart)
+import * as far from '@fortawesome/free-regular-svg-icons'
+import * as fas from '@fortawesome/free-solid-svg-icons'
+library.add(
+  // regular
+  far.faHeart, far.faPaperPlane, far.faCheckSquare, far.faSquare,
+  fas.faEnvelope,
 
-import { Page, StyleHTML, Button } from '@avsync.live/formation'
+  // solid
+  fas.faInfoCircle, fas.faBars, fas.faHeart, fas.faPlus,
+  fas.faEllipsisV, fas.faPaperPlane, fas.faCalendarAlt,
+  fas.faArrowRight, fas.faArrowLeft, fas.faClock, fas.faSearch,
+  fas.faSortAlphaUp, fas.faSortAlphaDown, fas.faFilter,
+  fas.faChevronCircleRight, fas.faChevronCircleLeft, fas.faEnvelope,
+  fas.faCheck, fas.faExclamationTriangle
+)
 
@@ -75,2 +89,4 @@ export default function App() {
 
+The free icons below are used by some components, and should be included in your project.
+
 ```jsx
@@ -80,4 +96,18 @@ // in your app's entrypoint (_app.tsx, App.js, etc)
 import { library } from '@fortawesome/fontawesome-svg-core'
-import { faHeart } from '@fortawesome/free-solid-svg-icons'
-library.add(faHeart)
+import * as far from '@fortawesome/free-regular-svg-icons'
+import * as fas from '@fortawesome/free-solid-svg-icons'
+library.add(
+  // regular
+  far.faHeart, far.faPaperPlane, far.faCheckSquare, far.faSquare,
+  fas.faEnvelope,
+
+  // solid
+  fas.faInfoCircle, fas.faBars, fas.faHeart, fas.faPlus,
+  fas.faEllipsisV, fas.faPaperPlane, fas.faCalendarAlt,
+  fas.faArrowRight, fas.faArrowLeft, fas.faClock, fas.faSearch,
+  fas.faSortAlphaUp, fas.faSortAlphaDown, fas.faFilter,
+  fas.faChevronCircleRight, fas.faChevronCircleLeft, fas.faEnvelope,
+  fas.faCheck, fas.faExclamationTriangle
+)
+
 ```
@@ -84,0 +114,0 @@

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

Number of lines in readme file

135

increased by28.57%

Worsened metrics

Total package byte prevSize

723925

decreased by-0.21%

Lines of code

7178

decreased by-0.42%

No dependency changes