@veeqo/ui 0.0.15 → 0.0.16

package/README.md

@@ -6,11 +6,13 @@ The frontend component library for reusable components in Veeqo which aim to ref
 
 This library has been re-written and refactored with the aims of enable tree-shaking which will allow us to reduce our bundle size and decrease page load times while also simplifying the library making it easier to work with and develop.
 
-Icons and Integrations have been moved:
+Icons and Integrations **WILL** been moved:
 
 - Icons now live in [@veeqo/icons](https://www.npmjs.com/package/@veeqo/icons).
 - Our Integrations now live in [@veeqo/integrations](https://www.npmjs.com/package/@veeqo/integrations).
 
+_For now please use individual icons to preserve tree shaking, while downstream uses can use the old component library Glyph component if needed (not tree shakable, huge size)._
+
 ## Getting Started
 
 Setup should be simple, clone the repo and use npm to install all dependencies.
@@ -71,7 +73,16 @@ npm login
 
 Versioning will happen on the `package.json` version number, and is for the library as a whole instead of per component for simplicity.
 
-When you make a change, which should be published to NPM please use: `npm version (patch | minor | major)`
+When have made a change you want published, use `npm run patch` or `npm run minor` or `npm run major` depending on your changes: 
 
-- This create a commit where you update the version number
+- This create update the version number by the amount specified in the command you entered above.
 - **Create a git tag** for that version, making the version history straightward to look back on.
+- Update the changelog based on your commits.
+- Push this readme change upstream
+
+**After this is done, merge your PR.**
+
+Once your PR is reviewed and merged, you can then run `npm publish` from master.
+
+- This will run all unit tests and check linting.
+- Then publish to NPM.

package/dist/components/AnimatedDropdown/hooks/useClickAway.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const useClickAway: (ref: React.RefObject<HTMLElement>, onClickAway: (event: Event) => void) => void;

package/dist/components/Banner/Banner.d.ts

@@ -1,6 +1,16 @@
-import React from 'react';
-import { BannerProps } from './types';
+import React, { ReactEventHandler, ReactNode } from 'react';
+import { BannerTypes } from './types';
+type BannerProps = {
+    type?: BannerTypes;
+    text?: string;
+    icon?: Omit<ReactNode, string>;
+    onClose?: ReactEventHandler;
+    className?: string;
+    header?: ReactNode;
+    children?: ReactNode;
+};
 /**
  * The `Banner` component was previously called `Alert` (and similarly `Pill`).
  */
-export declare const Banner: ({ type, text, icon, onClose, className, header, }: BannerProps) => React.JSX.Element;
+export declare const Banner: ({ type, text, icon, onClose, className, header, children, }: BannerProps) => React.JSX.Element;
+export {};

package/dist/components/Banner/types.d.ts

@@ -1,18 +1,5 @@
-import { ReactNode, ReactEventHandler } from 'react';
-export declare enum BannerTypes {
-    help = "help",
-    info = "info",
-    error = "error",
-    success = "success"
-}
-export type BannerProps = {
-    type?: keyof typeof BannerTypes | string;
-    text?: string;
-    icon?: Omit<ReactNode, string>;
-    onClose?: ReactEventHandler;
-    className?: string;
-    header?: ReactNode;
-};
+import { ReactNode } from 'react';
+export type BannerTypes = 'help' | 'info' | 'error' | 'success';
 export type PillProps = {
     children?: ReactNode;
     className?: string;