@adoptaunabuelo/react-components 0.1.3 → 0.1.5

package/README.md

@@ -1,2 +1,58 @@
 # react-components
-A simple, customizable, and accessible library of React components
+A simple, customizable, and accessible library of React components
+
+[![npm latest package](https://img.shields.io/npm/v/@adoptaunabuelo/react-components/latest.svg)](https://www.npmjs.com/package/@adoptaunabuelo/react-components)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE)
+<a href="https://64650038c7589bed568201a8-eaedthpnzo.chromatic.com" target="_blank"><img src="https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg"></a>
+
+## Installation
+
+### React Components
+
+React Components is available as an [npm package](https://www.npmjs.com/package/@adoptaunabuelo/react-components).
+
+**npm:**
+
+```sh
+npm install @adoptaunabuelo/react-components
+```
+
+**yarn:**
+
+```sh
+yarn add @adoptaunabuelo/react-components
+```
+
+## Getting started with React Components
+
+Here is an example of a basic app using React Components `ProgressBar` component:
+
+```jsx
+import * as React from 'react';
+import { ProgressBar } from '@adoptaunabuelo/react-components';
+
+function App() {
+    return (
+        <ProgressBar 
+            maxValue={100}
+            minValue={0}
+            progress={40}
+        />;
+    )
+}
+```
+
+## Storybook
+
+You can checkout all the library Components and its docs in our storybook
+
+[Open the Storybook](https://64650038c7589bed568201a8-eaedthpnzo.chromatic.com)
+
+## Changelog
+
+The [changelog](https://github.com/mui/material-ui/releases) is regularly updated to reflect what's changed in each new release.
+
+## License
+
+This project is licensed under the terms of the
+[MIT license](/LICENSE).

package/dist/cjs/components/BreadCrumb/BreadCrumb.d.ts

@@ -1,5 +1,5 @@
 import { ComponentPropsWithoutRef } from 'react';
-declare const BreadCrumb: (props: Props) => import("react/jsx-runtime").JSX.Element;
+declare const BreadCrumb: ({ steps, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
 export default BreadCrumb;
 export interface Props extends ComponentPropsWithoutRef<"div"> {
     selectedStep?: number;

package/dist/cjs/components/Feedback/Feedback.d.ts

@@ -0,0 +1,9 @@
+import { ComponentPropsWithoutRef } from 'react';
+declare const FeedBack: ({ type, isVisible, ...props }: Props) => import("react/jsx-runtime").JSX.Element | null;
+export default FeedBack;
+export interface Props extends ComponentPropsWithoutRef<"div"> {
+    isVisible: boolean;
+    type: 'success' | 'error';
+    text: string;
+    onClose?: () => void;
+}

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

@@ -1,3 +1,4 @@
 export { default as BreadCrumb } from './BreadCrumb/BreadCrumb';
 export { default as Text } from './Text/Text';
 export { default as ProgressBar } from './ProgressBar/ProgressBar';
+export { default as Feedback } from './Feedback/Feedback';