labsense-ui-kit 1.0.2 → 1.0.4

package/README.md

@@ -1,53 +1,51 @@
-# labSense UI KIT LIBRARY
+# labSense UI Kit Library
 
-  labSense UI KIT is a UI components library created in react for faster web applications development.
+LabSense UI Kit is a modern UI components library built with React, designed to streamline and accelerate web application development.
 
-## Development
+---
 
-If you want to run the project follow the next steps
+## Getting Started
 
-- Clone repository
-```
-  git clone https://gitlab.com/chirag.jain5/labsense-ui-kit
-```
+Follow these steps to set up and run the project:
 
-- Install with npm version 8 node 16 or above from the root folder
-```
-  npm install
-```
-
-- If you want to run the example project, run library workspace first and then the example workspace in a different terminal
+### 1. Clone the Repository  
+Begin by cloning the repository to your local machine:
 
+```sh
+git clone https://gitlab.com/chirag.jain5/labsense-ui-kit
 ```
-  // Terminal 1
 
-  npm run dev --workspace=packages/ui-lib
-```
+### 2. Install Dependencies  
+Navigate to the project root and install the required dependencies using npm v20:
 
+```sh
+npm install
 ```
-  // Terminal 2
 
-  npm run dev --workspace=packages/example
-```
+### 3. Running the Project  
+To explore the UI kit, you can run different parts of the project as needed:
 
-- If you want to run the storybook
+#### a) Start the UI Library
+Run the core UI library workspace:
 
+```sh
+npm run dev --workspace=packages/ui-lib
 ```
-  // Terminal 3
 
-  npm run dev --workspace=packages/storybook
-```
+#### b) Run the Example Project
+To see the UI components in action, start the example project in a separate terminal:
 
-## Icons
+```sh
+npm run dev --workspace=packages/example
+```
 
-The icons used in this UI Kit are licensed from [Streamline Icons](https://streamlineicons.com/). We are able to provide a limited set in this kit with as per our license agreement. If you wish to extend the icons included in this kit yourself, we highly recommend checking those out if you want to keep a consistent style.
+#### c) Launch Storybook
+To view and test individual UI components in isolation, run Storybook:
 
-We tend to use the regular weighted icons and process them first to ungroup them. Then we use the above command to process them for inclusion in the UI Kit.
+```sh
+npm run dev --workspace=packages/storybook
+```
       
 ## License
 
-The labSense UI Kit is released under the [MIT license](../../LICENSE.md).
-
-Please note however that the icon set included in this software is included under license and remains property of Webalys LLC. These icons can be used only in the context of this open source project. For more information regarding this license, see [Streamline Icons Premium License](https://help.streamlineicons.com/license-premium).
-
-
+The labSense UI Kit is released under the [MIT license](../../LICENSE.md).

package/dist/Icons/SVGs/Back.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Back: React.FC<SVGProps>;
+export default Back;

package/dist/Icons/SVGs/Bin.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Bin: React.FC<SVGProps>;
+export default Bin;

package/dist/Icons/SVGs/Business.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Business: React.FC<SVGProps>;
+export default Business;

package/dist/Icons/SVGs/Circle.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Circle: React.FC<SVGProps>;
+export default Circle;

package/dist/Icons/SVGs/Client.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Client: React.FC<SVGProps>;
+export default Client;

package/dist/Icons/SVGs/Close.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Close: React.FC<SVGProps>;
+export default Close;

package/dist/Icons/SVGs/CloseCircle.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const CloseCircle: React.FC<SVGProps>;
+export default CloseCircle;

package/dist/Icons/SVGs/Copy.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Copy: React.FC<SVGProps>;
+export default Copy;

package/dist/Icons/SVGs/Cyber.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Cyber: React.FC<SVGProps>;
+export default Cyber;

package/dist/Icons/SVGs/DownArrow.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const DownArrow: React.FC<SVGProps>;
+export default DownArrow;

package/dist/Icons/SVGs/Download.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Download: React.FC<SVGProps>;
+export default Download;

package/dist/Icons/SVGs/Edit.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Edit: React.FC<SVGProps>;
+export default Edit;

package/dist/Icons/SVGs/Email.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Email: React.FC<SVGProps>;
+export default Email;

package/dist/Icons/SVGs/FilesBox.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const FilesBox: React.FC<SVGProps>;
+export default FilesBox;

package/dist/Icons/SVGs/Filter.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Filter: React.FC<SVGProps>;
+export default Filter;

package/dist/Icons/SVGs/Forward.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Forward: React.FC<SVGProps>;
+export default Forward;

package/dist/Icons/SVGs/History.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const History: React.FC<SVGProps>;
+export default History;

package/dist/Icons/SVGs/Information.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Information: React.FC<SVGProps>;
+export default Information;

package/dist/Icons/SVGs/LeftArrow.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const LeftArrow: React.FC<SVGProps>;
+export default LeftArrow;

package/dist/Icons/SVGs/Letter.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Letter: React.FC<SVGProps>;
+export default Letter;

package/dist/Icons/SVGs/Lock.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Lock: React.FC<SVGProps>;
+export default Lock;

package/dist/Icons/SVGs/Logout.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "../";
+declare const Logout: React.FC<SVGProps>;
+export default Logout;

package/dist/Icons/SVGs/Mute.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Mute: React.FC<SVGProps>;
+export default Mute;

package/dist/Icons/SVGs/Notifications.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Notifications: React.FC<SVGProps>;
+export default Notifications;

package/dist/Icons/SVGs/Phone.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "../";
+declare const Phone: React.FC<SVGProps>;
+export default Phone;

package/dist/Icons/SVGs/Play.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Play: React.FC<SVGProps>;
+export default Play;

package/dist/Icons/SVGs/Profile_1.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Profile_1: React.FC<SVGProps>;
+export default Profile_1;

package/dist/Icons/SVGs/Profile_2.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Profile_2: React.FC<SVGProps>;
+export default Profile_2;

package/dist/Icons/SVGs/RightArrow.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const RightArrow: React.FC<SVGProps>;
+export default RightArrow;

package/dist/Icons/SVGs/RunAway.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const RunAway: React.FC<SVGProps>;
+export default RunAway;

package/dist/Icons/SVGs/SandTimer.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const SandTimer: React.FC<SVGProps>;
+export default SandTimer;

package/dist/Icons/SVGs/Search.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Search: React.FC<SVGProps>;
+export default Search;

package/dist/Icons/SVGs/Settings.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Settings: React.FC<SVGProps>;
+export default Settings;

package/dist/Icons/SVGs/Shield.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Shield: React.FC<SVGProps>;
+export default Shield;

package/dist/Icons/SVGs/Team.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Team: React.FC<SVGProps>;
+export default Team;

package/dist/Icons/SVGs/ThumbsUp.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const ThumbsUp: React.FC<SVGProps>;
+export default ThumbsUp;

package/dist/Icons/SVGs/Tick.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Tick: React.FC<SVGProps>;
+export default Tick;

package/dist/Icons/SVGs/Wallet.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Wallet: React.FC<SVGProps>;
+export default Wallet;

package/dist/Icons/SVGs/Zapper.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SVGProps } from "..";
+declare const Zapper: React.FC<SVGProps>;
+export default Zapper;

package/dist/Icons/SVGs/index.d.ts

@@ -0,0 +1,39 @@
+export { default as Forward } from './Forward';
+export { default as RunAway } from './RunAway';
+export { default as Back } from './Back';
+export { default as Download } from './Download';
+export { default as Wallet } from './Wallet';
+export { default as Bin } from './Bin';
+export { default as Business } from './Business';
+export { default as Client } from './Client';
+export { default as Close } from './Close';
+export { default as Copy } from './Copy';
+export { default as CloseCircle } from './CloseCircle';
+export { default as Cyber } from './Cyber';
+export { default as Shield } from './Shield';
+export { default as Lock } from './Lock';
+export { default as DownArrow } from './/DownArrow';
+export { default as Email } from './Email';
+export { default as FilesBox } from './FilesBox';
+export { default as Filter } from './Filter';
+export { default as Team } from './Team';
+export { default as History } from './History';
+export { default as Information } from './Information';
+export { default as Letter } from './Letter';
+export { default as Logout } from './Logout';
+export { default as Mute } from './Mute';
+export { default as Notifications } from './Notifications';
+export { default as Circle } from './Circle';
+export { default as Phone } from './Phone';
+export { default as Play } from './Play';
+export { default as Settings } from './Settings';
+export { default as Profile_1 } from './Profile_1';
+export { default as Profile_2 } from './Profile_2';
+export { default as Search } from './Search';
+export { default as Edit } from './Edit';
+export { default as RightArrow } from './RightArrow';
+export { default as LeftArrow } from './LeftArrow';
+export { default as ThumbsUp } from './ThumbsUp';
+export { default as Tick } from './Tick';
+export { default as SandTimer } from './SandTimer';
+export { default as Zapper } from './Zapper';

package/dist/Icons/index.d.ts

@@ -0,0 +1,20 @@
+import React from "react";
+declare const IconWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
+declare const IconWrapperForSVG: import("styled-components").StyledComponent<"g", any, {}, never>;
+export { IconWrapper, IconWrapperForSVG };
+export interface SVGProps {
+    size: number;
+    color: string;
+    weight: string;
+}
+declare const IconSVGs: {
+    [key: string]: React.FC<SVGProps>;
+};
+export interface IconProps {
+    icon: keyof typeof IconSVGs;
+    size?: number;
+    color?: string;
+    weight?: string;
+}
+declare const Icon: React.FC<IconProps>;
+export { Icon };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 import { Button } from "./Buttons";
 import { Input } from "./Inputs";
-export { Button, Input };
+import { Icon } from './Icons';
+export { Button, Input, Icon };