@agility/plenum-ui 1.0.0 → 1.0.1

package/README.md

@@ -1,17 +1,46 @@
 # Agility CMS Component Library for React
 
-## PRE-RELEASE!
+## Features
 
-## Commands
+- Button | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-button)
+- Combobox | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-combobox--all-variations)
+- Dropdown | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-dropdown--default)
+- Switch | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-atoms--switch-component)
+- TreeView | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-treeview-v2--tree-view-component)
+- TextInput | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-textinput--all-variations)
+- TextInputAddon | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-textinputaddon--all-variations)
+- TextInputSelect | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-textinputselect--all-variations)
+- Radio | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-radio--all-variations)
+- Checkbox | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-checkbox--all-variations)
+- Textarea | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-textarea--all-variations)
+- Select | [view](https://plenum-ui.vercel.app/?path=/story/plenum-ui-components-select--all-variations)
 
-Build for distribution
 
-```
-yarn build
+## Installing
+
+Using npm:
+
+```bash
+$ npm install @agility/plenum-ui
 ```
 
-Run storybook
+Using bower:
 
+```bash
+$ bower install @agility/plenum-ui
 ```
-yarn start-tw & yarn storybook
+
+Using yarn:
+
+```bash
+$ yarn add @agility/plenum-ui
 ```
+
+
+## Usage
+
+```js
+import { Button } from '@agility/plenum-ui';
+
+<Button label='Primary' type='primary' size='base' icon='BellIcon'>
+```

package/lib/components/Forms/Select/Select.d.ts

@@ -1,9 +1,9 @@
 import { FC } from 'react';
-export declare type SelectOptions = {
+export declare type SimpleSelectOptions = {
     label: string;
     value: string;
 };
-export interface SelectProps {
+export interface SimpleSelectProps {
     /** Label */
     label?: string;
     /** Select ID prop */
@@ -11,7 +11,7 @@ export interface SelectProps {
     /** Select name prop */
     name: string;
     /** List of options to display in the select menu */
-    options: SelectOptions[];
+    options: SimpleSelectOptions[];
     /** Select name prop */
     onChange?(value: string): void;
     /** Select disabled state */
@@ -22,4 +22,4 @@ export interface SelectProps {
     isRequired?: boolean;
 }
 /** Comment */
-export declare const Select: FC<SelectProps>;
+export declare const Select: FC<SimpleSelectProps>;

package/lib/components/Forms/Select/Select.stories.d.ts

@@ -1,11 +1,11 @@
 import { Meta } from '@storybook/react/types-6-0';
 import { Story } from '@storybook/react';
-import { SelectProps } from './Select';
+import { SimpleSelectProps } from './Select';
 declare const _default: Meta<import("@storybook/react").Args>;
 export default _default;
-export declare const AllVariations: Story<SelectProps>;
-export declare const Base: Story<SelectProps>;
-export declare const Label: Story<SelectProps>;
-export declare const Disabled: Story<SelectProps>;
-export declare const Required: Story<SelectProps>;
-export declare const Error: Story<SelectProps>;
+export declare const AllVariations: Story<SimpleSelectProps>;
+export declare const Base: Story<SimpleSelectProps>;
+export declare const Label: Story<SimpleSelectProps>;
+export declare const Disabled: Story<SimpleSelectProps>;
+export declare const Required: Story<SimpleSelectProps>;
+export declare const Error: Story<SimpleSelectProps>;

package/lib/components/Forms/TextInputSelect/TextInputSelect.d.ts

@@ -1,6 +1,6 @@
 import { FC } from 'react';
 import '../../../tailwind.css';
-export declare type Type = 'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'currency';
+declare type Type = 'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'currency';
 export declare type SelectOptions = {
     label: string;
     value: string;
@@ -44,3 +44,4 @@ export interface TextInputSelectProps {
     onSelectOption?(value: string): void;
 }
 export declare const TextInputSelect: FC<TextInputSelectProps>;
+export {};

package/lib/index.d.ts

@@ -1,3 +1,12 @@
 export * from './components/Button';
+export * from './components/Combobox';
+export * from './components/Dropdown';
+export * from './components/Switch';
+export * from './components/TreeView';
 export * from './components/Forms/TextInput';
 export * from './components/Forms/TextInputAddon';
+export * from './components/Forms/TextInputSelect';
+export * from './components/Forms/Radio';
+export * from './components/Forms/Textarea';
+export * from './components/Forms/Select';
+export * from './components/Forms/Checkbox';