motofin-ui - npm Package Compare versions

Comparing version 1.2.2 to 1.2.3

dist/cjs/components/Badge/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Badge";
+export { default } from './Badge';

dist/cjs/components/CheckBox/Checkbox.types.d.ts

@@ -0,1 +1,2 @@
+import React from 'react';
 export interface CheckboxProps {
@@ -12,4 +13,4 @@ id?: string;
     iconColor?: string;
-    onChange?: (event: any) => void;
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
     testid?: string;
 }

dist/cjs/components/CheckBox/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Checkbox";
+export { default } from './Checkbox';

dist/cjs/components/ChoicesWrapper/ChoiceButton.types.d.ts

 /// <reference types="react" />
 export interface ChoiceWrapperProps {
-    choices: ChoiceWrapperProps;
     onSelect?: (choice: string) => void;
@@ -11,3 +10,3 @@ preSelectedChoiceKey?: string;
     identifier?: string;
-    children: JSX.Element;
+    children?: (JSX.Element[] | JSX.Element);
 }
@@ -14,0 +13,0 @@ export interface ChoiceButtonProps {

dist/cjs/components/constants/icons/olx.d.ts

@@ -7,2 +7,3 @@ export declare const olx: {
     cross: string;
+    arrowDown: string;
     arrowRightSmall: string;
@@ -17,2 +18,5 @@ arrowRight: string;
     setting: string;
+    hamburger: string;
+    filter: string;
+    edit: string;
 };

dist/cjs/components/Container/Container.stories.d.ts

@@ -1,5 +0,5 @@
-import React from "react";
-import { ComponentStory, ComponentMeta } from "@storybook/react";
+import React from 'react';
+import { ComponentStory, ComponentMeta } from '@storybook/react';
 declare const _default: ComponentMeta<React.NamedExoticComponent<import("./Container.types").ContainerProps>>;
 export default _default;
 export declare const Default: ComponentStory<React.NamedExoticComponent<import("./Container.types").ContainerProps>>;

dist/cjs/components/Container/Container.types.d.ts

@@ -1,2 +0,2 @@
-import { ReactNode } from "react";
+import { ReactNode } from 'react';
 declare type Radii = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
@@ -3,0 +3,0 @@ export interface ContainerProps {

dist/cjs/components/Container/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Container";
+export { default } from './Container';

dist/cjs/components/Dropdown/Dropdown.types.d.ts

@@ -0,1 +1,2 @@
+import React from 'react';
 export declare const LabelValues: {
@@ -14,3 +15,3 @@ readonly TITLE: "title";
     value: string;
-    title: any;
+    title: string | (() => React.ReactNode) | null;
     color?: string;
@@ -21,7 +22,7 @@ }
     value: string;
-    title: any;
+    title: (() => React.ReactNode) | string | null;
     keyProp: string;
     isActive: boolean;
     color: string;
-    handleSelect: (option: any) => void;
+    handleSelect: (option: Option) => void;
     selectable: boolean;
@@ -35,4 +36,4 @@ }
     defaultValue?: string;
-    onClick?: (event: any) => void;
-    onChange?: (event: any) => void;
+    onClick?: (event: boolean) => void;
+    onChange?: (option: Option) => void;
     disabled?: boolean;
@@ -39,0 +40,0 @@ dropdownClass?: string;

dist/cjs/components/index.d.ts

@@ -18,1 +18,2 @@ export { default as Button } from './Button';
 export { default as TabCarousel } from './Tabs';
+export { default as Tooltip } from './Tooltip';

dist/cjs/components/Modal/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Modal";
+export { default } from './Modal';

dist/cjs/components/Pagination/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Pagination";
+export { default } from './Pagination';

dist/cjs/components/Pagination/PageSizeSelector.d.ts

@@ -1,4 +0,4 @@
-import React from "react";
-import { PageSizeSelectorProps } from "./Pagination.types";
+import React from 'react';
+import { PageSizeSelectorProps } from './Pagination.types';
 declare const PageSizeSelector: React.FC<PageSizeSelectorProps>;
 export default PageSizeSelector;

dist/cjs/components/Pagination/Pagination.stories.d.ts

@@ -1,5 +0,5 @@
-import React from "react";
-import { ComponentStory, ComponentMeta } from "@storybook/react";
+import React from 'react';
+import { ComponentStory, ComponentMeta } from '@storybook/react';
 declare const _default: ComponentMeta<React.NamedExoticComponent<import("./Pagination.types").PaginationProps>>;
 export default _default;
 export declare const Default: ComponentStory<React.NamedExoticComponent<import("./Pagination.types").PaginationProps>>;

dist/cjs/components/Pagination/Pagination.types.d.ts

 export declare type PAGINATION_TYPES = 'minimal' | 'grid' | 'buttons';
+export interface PaginationData {
+    currentPage: number;
+    totalPages: number;
+    pageSize: number;
+    totalItems: number;
+}
 export interface PaginationProps {
@@ -7,3 +13,3 @@ type?: PAGINATION_TYPES;
     defaultPageSize?: number;
-    onChange?: (event: any) => void;
+    onChange?: (data: PaginationData) => void;
     disabled?: boolean;
@@ -18,3 +24,3 @@ 'test-id'?: string;
     selectedPage: number;
-    pages: any[];
+    pages: (number | string)[];
     DOTS: string;
@@ -21,0 +27,0 @@ type: PAGINATION_TYPES;

dist/cjs/components/Table/Table.types.d.ts

@@ -0,1 +1,2 @@
+import React from 'react';
 declare type TableTypes = 'default' | 'zebra';
@@ -8,12 +9,23 @@ declare type PAGINATION_TYPES = 'minimal' | 'grid' | 'buttons';
 }
+export interface Action {
+    onClick: (data: any) => void;
+    key: number;
+    icon: string;
+}
 export interface Column {
     key: string;
-    title: any;
-    render?: (data: any, record: any) => void;
+    title: string;
+    type?: string;
+    headingRender?: () => React.ReactNode;
+    render?: (data: any, record?: any) => React.ReactNode;
 }
+export interface RowData {
+    id: number;
+    [key: string]: string | number;
+}
 export interface TableProps {
     columns: Column[];
     pagination?: PaginationObject;
-    data: any[];
-    actions?: any[];
+    data: RowData[];
+    actions?: Action[];
     type?: TableTypes;
@@ -30,3 +42,3 @@ paginationType?: PAGINATION_TYPES;
 export interface TableHeaderProps {
-    columns: any;
+    columns: Column[];
     type: TableTypes;
@@ -38,5 +50,5 @@ checkable?: boolean;
 export interface TableRowProps {
-    rowData: any;
-    columns: any;
-    actions: any[];
+    rowData: RowData;
+    columns: Column[];
+    actions: Action[];
     checkable?: boolean;
@@ -43,0 +55,0 @@ isChecked?: boolean;

dist/esm/components/Badge/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Badge";
+export { default } from './Badge';

dist/esm/components/CheckBox/Checkbox.types.d.ts

@@ -0,1 +1,2 @@
+import React from 'react';
 export interface CheckboxProps {
@@ -12,4 +13,4 @@ id?: string;
     iconColor?: string;
-    onChange?: (event: any) => void;
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
     testid?: string;
 }

dist/esm/components/CheckBox/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Checkbox";
+export { default } from './Checkbox';

dist/esm/components/ChoicesWrapper/ChoiceButton.types.d.ts

 /// <reference types="react" />
 export interface ChoiceWrapperProps {
-    choices: ChoiceWrapperProps;
     onSelect?: (choice: string) => void;
@@ -11,3 +10,3 @@ preSelectedChoiceKey?: string;
     identifier?: string;
-    children: JSX.Element;
+    children?: (JSX.Element[] | JSX.Element);
 }
@@ -14,0 +13,0 @@ export interface ChoiceButtonProps {

dist/esm/components/constants/icons/olx.d.ts

@@ -7,2 +7,3 @@ export declare const olx: {
     cross: string;
+    arrowDown: string;
     arrowRightSmall: string;
@@ -17,2 +18,5 @@ arrowRight: string;
     setting: string;
+    hamburger: string;
+    filter: string;
+    edit: string;
 };

dist/esm/components/Container/Container.stories.d.ts

@@ -1,5 +0,5 @@
-import React from "react";
-import { ComponentStory, ComponentMeta } from "@storybook/react";
+import React from 'react';
+import { ComponentStory, ComponentMeta } from '@storybook/react';
 declare const _default: ComponentMeta<React.NamedExoticComponent<import("./Container.types").ContainerProps>>;
 export default _default;
 export declare const Default: ComponentStory<React.NamedExoticComponent<import("./Container.types").ContainerProps>>;

dist/esm/components/Container/Container.types.d.ts

@@ -1,2 +0,2 @@
-import { ReactNode } from "react";
+import { ReactNode } from 'react';
 declare type Radii = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
@@ -3,0 +3,0 @@ export interface ContainerProps {

dist/esm/components/Container/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Container";
+export { default } from './Container';

dist/esm/components/Dropdown/Dropdown.types.d.ts

@@ -0,1 +1,2 @@
+import React from 'react';
 export declare const LabelValues: {
@@ -14,3 +15,3 @@ readonly TITLE: "title";
     value: string;
-    title: any;
+    title: string | (() => React.ReactNode) | null;
     color?: string;
@@ -21,7 +22,7 @@ }
     value: string;
-    title: any;
+    title: (() => React.ReactNode) | string | null;
     keyProp: string;
     isActive: boolean;
     color: string;
-    handleSelect: (option: any) => void;
+    handleSelect: (option: Option) => void;
     selectable: boolean;
@@ -35,4 +36,4 @@ }
     defaultValue?: string;
-    onClick?: (event: any) => void;
-    onChange?: (event: any) => void;
+    onClick?: (event: boolean) => void;
+    onChange?: (option: Option) => void;
     disabled?: boolean;
@@ -39,0 +40,0 @@ dropdownClass?: string;

dist/esm/components/index.d.ts

@@ -18,1 +18,2 @@ export { default as Button } from './Button';
 export { default as TabCarousel } from './Tabs';
+export { default as Tooltip } from './Tooltip';

dist/esm/components/Modal/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Modal";
+export { default } from './Modal';

dist/esm/components/Pagination/index.d.ts

@@ -1,1 +0,1 @@
-export { default } from "./Pagination";
+export { default } from './Pagination';

dist/esm/components/Pagination/PageSizeSelector.d.ts

@@ -1,4 +0,4 @@
-import React from "react";
-import { PageSizeSelectorProps } from "./Pagination.types";
+import React from 'react';
+import { PageSizeSelectorProps } from './Pagination.types';
 declare const PageSizeSelector: React.FC<PageSizeSelectorProps>;
 export default PageSizeSelector;

dist/esm/components/Pagination/Pagination.stories.d.ts

@@ -1,5 +0,5 @@
-import React from "react";
-import { ComponentStory, ComponentMeta } from "@storybook/react";
+import React from 'react';
+import { ComponentStory, ComponentMeta } from '@storybook/react';
 declare const _default: ComponentMeta<React.NamedExoticComponent<import("./Pagination.types").PaginationProps>>;
 export default _default;
 export declare const Default: ComponentStory<React.NamedExoticComponent<import("./Pagination.types").PaginationProps>>;

dist/esm/components/Pagination/Pagination.types.d.ts

 export declare type PAGINATION_TYPES = 'minimal' | 'grid' | 'buttons';
+export interface PaginationData {
+    currentPage: number;
+    totalPages: number;
+    pageSize: number;
+    totalItems: number;
+}
 export interface PaginationProps {
@@ -7,3 +13,3 @@ type?: PAGINATION_TYPES;
     defaultPageSize?: number;
-    onChange?: (event: any) => void;
+    onChange?: (data: PaginationData) => void;
     disabled?: boolean;
@@ -18,3 +24,3 @@ 'test-id'?: string;
     selectedPage: number;
-    pages: any[];
+    pages: (number | string)[];
     DOTS: string;
@@ -21,0 +27,0 @@ type: PAGINATION_TYPES;

dist/esm/components/Table/Table.types.d.ts

@@ -0,1 +1,2 @@
+import React from 'react';
 declare type TableTypes = 'default' | 'zebra';
@@ -8,12 +9,23 @@ declare type PAGINATION_TYPES = 'minimal' | 'grid' | 'buttons';
 }
+export interface Action {
+    onClick: (data: any) => void;
+    key: number;
+    icon: string;
+}
 export interface Column {
     key: string;
-    title: any;
-    render?: (data: any, record: any) => void;
+    title: string;
+    type?: string;
+    headingRender?: () => React.ReactNode;
+    render?: (data: any, record?: any) => React.ReactNode;
 }
+export interface RowData {
+    id: number;
+    [key: string]: string | number;
+}
 export interface TableProps {
     columns: Column[];
     pagination?: PaginationObject;
-    data: any[];
-    actions?: any[];
+    data: RowData[];
+    actions?: Action[];
     type?: TableTypes;
@@ -30,3 +42,3 @@ paginationType?: PAGINATION_TYPES;
 export interface TableHeaderProps {
-    columns: any;
+    columns: Column[];
     type: TableTypes;
@@ -38,5 +50,5 @@ checkable?: boolean;
 export interface TableRowProps {
-    rowData: any;
-    columns: any;
-    actions: any[];
+    rowData: RowData;
+    columns: Column[];
+    actions: Action[];
     checkable?: boolean;
@@ -43,0 +55,0 @@ isChecked?: boolean;

dist/index.d.ts

@@ -27,3 +27,3 @@ /// <reference types="react" />
 
-declare const _default$e: React.MemoExoticComponent<({ type, disabled, size, fixed, icon, className, onClick, "test-id": testId, iconDirection, children, invert, roundCorners, style, iconPlacement, iconSize }: ButtonProps) => JSX.Element>;
+declare const _default$f: React.MemoExoticComponent<({ type, disabled, size, fixed, icon, className, onClick, "test-id": testId, iconDirection, children, invert, roundCorners, style, iconPlacement, iconSize }: ButtonProps) => JSX.Element>;
 
@@ -41,3 +41,3 @@ interface ModalProps {
 
-declare const _default$d: React.NamedExoticComponent<ModalProps>;
+declare const _default$e: React.NamedExoticComponent<ModalProps>;
 
@@ -51,12 +51,23 @@ declare type TableTypes = 'default' | 'zebra';
 }
+interface Action {
+    onClick: (data: any) => void;
+    key: number;
+    icon: string;
+}
 interface Column {
     key: string;
-    title: any;
-    render?: (data: any, record: any) => void;
+    title: string;
+    type?: string;
+    headingRender?: () => React.ReactNode;
+    render?: (data: any, record?: any) => React.ReactNode;
 }
+interface RowData {
+    id: number;
+    [key: string]: string | number;
+}
 interface TableProps {
     columns: Column[];
     pagination?: PaginationObject;
-    data: any[];
-    actions?: any[];
+    data: RowData[];
+    actions?: Action[];
     type?: TableTypes;
@@ -73,3 +84,3 @@ paginationType?: PAGINATION_TYPES$1;
 
-declare const _default$c: React.NamedExoticComponent<TableProps>;
+declare const _default$d: React.NamedExoticComponent<TableProps>;
 
@@ -85,3 +96,3 @@ declare type Radii = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
 
-declare const _default$b: React.NamedExoticComponent<ContainerProps>;
+declare const _default$c: React.NamedExoticComponent<ContainerProps>;
 
@@ -103,5 +114,11 @@ declare type ICON_POSITION = 'right' | 'left';
 
-declare const _default$a: React.NamedExoticComponent<BadgeProps>;
+declare const _default$b: React.NamedExoticComponent<BadgeProps>;
 
 declare type PAGINATION_TYPES = 'minimal' | 'grid' | 'buttons';
+interface PaginationData {
+    currentPage: number;
+    totalPages: number;
+    pageSize: number;
+    totalItems: number;
+}
 interface PaginationProps {
@@ -112,3 +129,3 @@ type?: PAGINATION_TYPES;
     defaultPageSize?: number;
-    onChange?: (event: any) => void;
+    onChange?: (data: PaginationData) => void;
     disabled?: boolean;
@@ -119,3 +136,3 @@ 'test-id'?: string;
 
-declare const _default$9: React.NamedExoticComponent<PaginationProps>;
+declare const _default$a: React.NamedExoticComponent<PaginationProps>;
 
@@ -135,3 +152,3 @@ declare const LabelValues: {
     value: string;
-    title: any;
+    title: string | (() => React.ReactNode) | null;
     color?: string;
@@ -145,4 +162,4 @@ }
     defaultValue?: string;
-    onClick?: (event: any) => void;
-    onChange?: (event: any) => void;
+    onClick?: (event: boolean) => void;
+    onChange?: (option: Option) => void;
     disabled?: boolean;
@@ -160,3 +177,3 @@ dropdownClass?: string;
 
-declare const _default$8: React.NamedExoticComponent<DropdownProps>;
+declare const _default$9: React.NamedExoticComponent<DropdownProps>;
 
@@ -174,6 +191,5 @@ interface IconProps {
 
-declare const _default$7: React.NamedExoticComponent<IconProps>;
+declare const _default$8: React.NamedExoticComponent<IconProps>;
 
 interface ChoiceWrapperProps {
-    choices: ChoiceWrapperProps;
     onSelect?: (choice: string) => void;
@@ -186,6 +202,6 @@ preSelectedChoiceKey?: string;
     identifier?: string;
-    children: JSX.Element;
+    children?: (JSX.Element[] | JSX.Element);
 }
 
-declare const _default$6: React.NamedExoticComponent<ChoiceWrapperProps>;
+declare const _default$7: React.NamedExoticComponent<ChoiceWrapperProps>;
 
@@ -227,3 +243,3 @@ declare const InputType: {
 
-declare const _default$5: React.MemoExoticComponent<({ iconLeftColor, iconRightColor, value, id, name, disabled, label, placeholder, type, hintText, errorText, maxLength, iconRight, iconLeft, iconLeftClassName, iconRightClassName, prefix, prefixClassName, className, containerClassName, renderProps, category, autoFocus, onChange, onFocus, onBlur, testid }: InputFieldProps) => JSX.Element>;
+declare const _default$6: React.MemoExoticComponent<({ iconLeftColor, iconRightColor, value, id, name, disabled, label, placeholder, type, hintText, errorText, maxLength, iconRight, iconLeft, iconLeftClassName, iconRightClassName, prefix, prefixClassName, className, containerClassName, renderProps, category, autoFocus, onChange, onFocus, onBlur, testid }: InputFieldProps) => JSX.Element>;
 
@@ -245,3 +261,3 @@ interface FieldType {
 
-declare const _default$4: React.MemoExoticComponent<({ stepsData, activeStage, testId }: ProgressiveSidebarProps) => JSX.Element>;
+declare const _default$5: React.MemoExoticComponent<({ stepsData, activeStage, testId }: ProgressiveSidebarProps) => JSX.Element>;
 
@@ -261,3 +277,3 @@ interface BannerProps {
 };
-declare const _default$3: React.MemoExoticComponent<({ bgColor, icon, heading, description, variant, testId }: BannerProps) => JSX.Element>;
+declare const _default$4: React.MemoExoticComponent<({ bgColor, icon, heading, description, variant, testId }: BannerProps) => JSX.Element>;
 
@@ -275,7 +291,7 @@ interface CheckboxProps {
     iconColor?: string;
-    onChange?: (event: any) => void;
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
     testid?: string;
 }
 
-declare const _default$2: React.MemoExoticComponent<({ id, name, disabled, value, label, roundedCorners, labelClassName, icon, iconClassName, iconColor, onChange, testid }: CheckboxProps) => JSX.Element>;
+declare const _default$3: React.MemoExoticComponent<({ id, name, disabled, value, label, roundedCorners, labelClassName, icon, iconClassName, iconColor, onChange, testid }: CheckboxProps) => JSX.Element>;
 
@@ -296,3 +312,3 @@ interface Link {
 
-declare const _default$1: React.MemoExoticComponent<{
+declare const _default$2: React.MemoExoticComponent<{
     ({ links, className, testid, linksClassname, seperatorIcon, iconClassName, size }: Breadcrumbprops): JSX.Element | null;
@@ -361,4 +377,15 @@ propTypes: {
 
-declare const _default: React.MemoExoticComponent<(props: TabCarouselProps) => JSX.Element>;
+declare const _default$1: React.MemoExoticComponent<(props: TabCarouselProps) => JSX.Element>;
 
+interface TooltipProps {
+    tooltipText?: string;
+    tooltipBgColor?: string;
+    tooltipClass?: string;
+    tooltipTextColor?: string;
+    'test-id'?: string;
+    renderProps?: Function;
+}
+
+declare const _default: React.NamedExoticComponent<TooltipProps>;
+
 declare const css: {
@@ -370,2 +397,2 @@ base: Record<string, string>;
 
-export { _default$a as Badge, _default$3 as Banner, _default$1 as Breadcrumb, _default$e as Button, _default$2 as Checkbox, _default$6 as ChoiceButton, _default$b as Container, _default$8 as Dropdown, Heading, _default$7 as Icon, _default$5 as InputField, _default$d as Modal, _default$9 as Pagination, _default$4 as ProgressiveSidebar, Radio, _default as TabCarousel, _default$c as Table, css };
+export { _default$b as Badge, _default$4 as Banner, _default$2 as Breadcrumb, _default$f as Button, _default$3 as Checkbox, _default$7 as ChoiceButton, _default$c as Container, _default$9 as Dropdown, Heading, _default$8 as Icon, _default$6 as InputField, _default$e as Modal, _default$a as Pagination, _default$5 as ProgressiveSidebar, Radio, _default$1 as TabCarousel, _default$d as Table, _default as Tooltip, css };

package.json

 {
   "name": "motofin-ui",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "A React component library for building motofin web admin panels",
@@ -26,3 +26,3 @@ "main": "dist/cjs/index.js",
     "type": "git",
-    "url": "https://git.naspersclassifieds.com/olxautos/motofin-ui.git"
+    "url": "https://git.naspersclassifieds.com/panamera/consumer-finance/motofin-ui.git"
   },
@@ -65,3 +65,2 @@ "devDependencies": {
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-perf": "^3.3.1",
     "identity-obj-proxy": "^3.0.0",
@@ -68,0 +67,0 @@ "jest": "^28.1.1",

README.md

@@ -0,92 +1,80 @@
+[npm]: https://img.shields.io/npm/v/motofin-ui
+[npm-url]: https://www.npmjs.com/package/motofin-ui
+[size]: https://packagephobia.now.sh/badge?p=motofin-ui
+[size-url]: https://packagephobia.now.sh/result?p=motofin-ui
+
+[![npm][npm]][npm-url]
+[![size][size]][size-url]
 # motofin-ui
 
-This service will be used by all the teams for re-using the components and creating new components.
+A React Component Library for Building [MotoFin360 Design Components](https://motofin.eks.stg.ap-southeast-1.horizontals.olx.org/)
 
-## Getting started
+# Documentation
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+Go to [https://motofin.eks.stg.ap-southeast-1.horizontals.olx.org/](https://motofin.eks.stg.ap-southeast-1.horizontals.olx.org/)
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+## Description
 
-## Add your files
+Tech Stack -
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+- TypeScript
+- SASS
+- React Testing Library + Jest
+- Storybook
+- React JS
 
-```
-cd existing_repo
-git remote add origin https://git.naspersclassifieds.com/olxautos/motofin-ui.git
-git branch -M master
-git push -uf origin master
-```
+## Install
 
-## Integrate with your tools
+Using yarn:
 
-- [ ] [Set up project integrations](https://git.naspersclassifieds.com/olxautos/motofin-ui/-/settings/integrations)
+```console
+yarn add motofin-ui
+```
 
-## Collaborate with your team
+Using npm:
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+```console
+npm install motofin-ui
+```
 
-## Test and Deploy
 
-Use the built-in continuous integration in GitLab.
+## Getting started
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+In order to get your instance up and running you must:
 
-***
+1. Clone this repo - https://git.naspersclassifieds.com/panamera/consumer-finance/motofin-ui.git
+2. Install dependencies `yarn install`
+3. Run `yarn storybook`
 
-# Editing this README
+## Avalaible Commands
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!).  Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+Use the following commands :
 
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+- Development mode: `yarn storybook`
+- Run the unit test suite: `yarn test`
+- Run the unit test suite and watch for files in order to re-run tests automatically: `yarn test:watch`
+- Get a coverage report: `yarn test:coverage`
+- Storybook Development: `yarn story:dev`
+- Build Storybook: `yarn build-storybook`
+- Run Es-Lint: `yarn lint`
 
-## Name
-Choose a self-explaining name for your project.
+## Contributing
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+Please refer to project's style and contribution guidelines for submitting patches and additions. In general, we follow the following process.
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+ 1. **Clone** the project to your own machine
+ 2. **Add** Your changes and **Test Cases** for the newly added code (Very IMPORTANT)
+ 3. **Commit** changes to your own branch
+ 4. **Push** your work back up to the repo
+ 5. Submit a **Pull request** so that we can review your changes
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+NOTE: Be sure to merge the latest from "upstream" before making a pull request!
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
 ## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
 
-## License
-For open source projects, say how it is licensed.
+Contributing Authors -
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+1. Anil Jangra - [e-mail]
+2. Nidhi Deswal - [e-mail]
+3. Aayush Goyal - [e-mail]
+4. Ria Soam - [e-mail]

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

751780

increased by1.75%

Dev dependency count

52

decreased by-1.89%

Number of package files

245

increased by5.15%

Lines of code

3641

increased by5.51%

Worsened metrics

Number of lines in readme file

81

decreased by-12.9%

Number of low supply chain risk alerts

68

increased by6.25%

No dependency changes