@luscii-healthtech/web-ui 0.1.1 → 0.1.4

package/README.md

@@ -1,181 +1,60 @@
-# TSDX React w/ Storybook User Guide
+# web-ui
 
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+The web-ui repository contains the web UI components for Luscii's front end projects. It is published to NPM for inclusion into our projects. It also uses storybook and is published to chromatic for easy review of changes. 
 
-> This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
+## Running locally
 
-> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
-
-## Commands
-
-TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
-
-The recommended workflow is to run TSDX in one terminal:
-
-```bash
-npm start # or yarn start
-```
-
-This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
-
-Then run either Storybook or the example playground:
-
-### Storybook
-
-Run inside another terminal:
+If you want to run storybook locally you can use 
 
 ```bash
+yarn install
 yarn storybook
 ```
 
-This loads the stories from `./stories`.
-
-> NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.
+## Contributing
 
-### Example
+Make sure you understand our design system and follow its guidelines. They are document in storybook. We value consistency, simplicity and usability highly. Don't mess it up.
 
-Then run the example inside another:
-
-```bash
-cd example
-npm i # or yarn to install dependencies
-npm start # or yarn start
+If you want to add components, do so in 
 ```
-
-The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
-
-To do a one-off build, use `npm run build` or `yarn build`.
-
-To run tests, use `npm test` or `yarn test`.
-
-## Configuration
-
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
-
-### Jest
-
-Jest tests are set up to run with `npm test` or `yarn test`.
-
-### Bundle analysis
-
-Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
-
-#### Setup Files
-
-This is the folder structure we set up for you:
-
-```txt
-/example
-  index.html
-  index.tsx       # test your component here in a demo app
-  package.json
-  tsconfig.json
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-/stories
-  Thing.stories.tsx # EDIT THIS
-/.storybook
-  main.js
-  preview.js
-.gitignore
-package.json
-README.md         # EDIT THIS
-tsconfig.json
+/src/components
 ```
+Please stay vigilant when adding components that we implement them consistently in our projects and that it is clear when and where they have to be used. We want to avoid a lot of components that are similar. 
 
-#### React Testing Library
-
-We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
-
-### Rollup
-
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
-
-### TypeScript
-
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
-
-## Continuous Integration
-
-### GitHub Actions
-
-Two actions are added by default:
-
-- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-- `size` which comments cost comparison of your library on every pull request using [size-limit](https://github.com/ai/size-limit)
-
-## Optimizations
-
-Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
-
-```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
-
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
+When you create new components, you must add them to storybook as well. Stories go in
 ```
-
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
-
-## Module Formats
-
-CJS, ESModules, and UMD module formats are supported.
-
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
-
-## Deploying the Example Playground
-
-The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
-
-```bash
-cd example # if not already in the example folder
-npm run build # builds to dist
-netlify deploy # deploy the dist folder
-```
-
-Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
-
-```bash
-netlify init
-# build command: yarn build && cd example && yarn && yarn build
-# directory to deploy: example/dist
-# pick yes for netlify.toml
+/stories
 ```
 
-## Named Exports
 
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
+## CI setup
 
-## Including Styles
+#### Branching
 
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
+The `main` branch is our default branch. When you contribute, branch from there and name your branch 
 
-For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
+ ```
+   //Branch names convention (enforced)
+    
+   major/*      //for a new design system or changes that effect our foundations (typography, color)
+   minor/*      //for new components and stories
+   patch/*      //for small improvements to existing components, stories
+   bug/*        //for bugs, fixes 
+   ```
 
-## Publishing to NPM
+We have configured at lot of magic for your convenience. 
 
-We recommend using [np](https://github.com/sindresorhus/np).
+#### On every PR
+1. the module build, lint and tests are checked. 
+2. The storybook build is published to chromatic. 
+3. Labels are added based on the branch name and PR size. 
+4. Branch names must follow the convention and are checked
+   
 
-## Usage with Lerna
 
-When creating a new package with TSDX within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
+#### On merge to main
 
-The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
-
-Change the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
-
-```diff
-   "alias": {
--    "react": "../node_modules/react",
--    "react-dom": "../node_modules/react-dom"
-+    "react": "../../../node_modules/react",
-+    "react-dom": "../../../node_modules/react-dom"
-   },
-```
+1. Draft a github release
+2. Version bump of the package
+3. Publish new package to NPM
 
-An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/palmerhq/tsdx/issues/64)

package/dist/components/Dropdown/Dropdown.d.ts

@@ -36,7 +36,7 @@ declare namespace Dropdown {
             title: PropTypes.Requireable<string>;
             groupKey: PropTypes.Validator<string>;
         }> | null | undefined)[]>;
-        export const initialSelectedItemId: PropTypes.Requireable<React.Key>;
+        export const initialSelectedItemId: PropTypes.Requireable<string | number>;
         export const placeholder: PropTypes.Requireable<string>;
         export const className: PropTypes.Requireable<string>;
         export const onItemSelect: PropTypes.Validator<(...args: any[]) => any>;

package/dist/components/Page/Page.d.ts

@@ -7,7 +7,7 @@ export default Page;
  */
 export type Breadcrumb = {
     name?: string | undefined;
-    icon?: string | Object | undefined;
+    icon?: string | any;
     link?: string | undefined;
 };
 /**

package/dist/components/Radio/Radio.d.ts

@@ -6,7 +6,7 @@ declare class Radio extends React.PureComponent<any, any, any> {
         isChecked: PropTypes.Validator<boolean>;
         isDisabled: PropTypes.Requireable<boolean>;
         name: PropTypes.Validator<string>;
-        value: PropTypes.Requireable<React.Key>;
+        value: PropTypes.Requireable<string | number>;
         onChange: PropTypes.Requireable<(...args: any[]) => any>;
     };
     constructor(props: any);

package/dist/components/RadioGroup/RadioGroup.d.ts

@@ -16,16 +16,15 @@ declare namespace RadioGroup {
         export const className: PropTypes.Requireable<string>;
         export const radioClassName: PropTypes.Requireable<string>;
         export const name: PropTypes.Requireable<string>;
-        export const selectedOption: PropTypes.Requireable<React.Key>;
+        export const selectedOption: PropTypes.Requireable<string | number>;
         export const isVertical: PropTypes.Requireable<boolean>;
         export const radioOptions: PropTypes.Validator<(PropTypes.InferProps<{
             text: PropTypes.Requireable<string>;
             info: PropTypes.Requireable<string>;
             isDisabled: PropTypes.Requireable<boolean>;
-            value: PropTypes.Requireable<React.Key>;
+            value: PropTypes.Requireable<string | number>;
         }> | null | undefined)[]>;
         export const onChange: PropTypes.Requireable<(...args: any[]) => any>;
     }
 }
 import PropTypes from "prop-types";
-import React from "react";

package/dist/components/Section/Section.d.ts

@@ -3,13 +3,12 @@ import { ButtonProps } from "../Button/Button.types";
 import { LoadingIndicatorProps } from "../LoadingIndicator/LoadingIndicator";
 import { RestPropped } from "../../types/general.types";
 import "./Section.scss";
-export interface SectionProps<TitleType, FooterType> extends RestPropped {
-    title?: string | TitleType;
+export interface SectionProps extends RestPropped {
+    title?: string;
     buttons?: ButtonProps[];
-    footer?: FooterType;
     className?: string;
     isLoading?: boolean;
     loadingIndicatorProps?: LoadingIndicatorProps;
 }
-export declare function Section<TitleType = unknown, FooterType = unknown>({ title, buttons, footer, children, className, isLoading, loadingIndicatorProps, ...restProps }: React.PropsWithChildren<SectionProps<TitleType, FooterType>>): JSX.Element;
+export declare function Section({ title, buttons, children, className, isLoading, loadingIndicatorProps, ...restProps }: React.PropsWithChildren<SectionProps>): JSX.Element;
 export default Section;

package/dist/components/Select/LegacySelect.d.ts

@@ -17,11 +17,11 @@ declare function LegacySelect({ className, value, name, placeholder, options, on
 declare namespace LegacySelect {
     export namespace propTypes {
         export const className: PropTypes.Requireable<string>;
-        export const value: PropTypes.Requireable<React.Key>;
+        export const value: PropTypes.Requireable<string | number>;
         export const name: PropTypes.Validator<string>;
         export const placeholder: PropTypes.Requireable<string>;
         export const options: PropTypes.Validator<(PropTypes.InferProps<{
-            value: PropTypes.Validator<React.Key>;
+            value: PropTypes.Validator<string | number>;
             text: PropTypes.Validator<string>;
             disabled: PropTypes.Requireable<boolean>;
         }> | null | undefined)[]>;
@@ -29,4 +29,3 @@ declare namespace LegacySelect {
     }
 }
 import PropTypes from "prop-types";
-import React from "react";

package/dist/components/Tabbar/Tabbar.d.ts

@@ -3,7 +3,7 @@ import { TabItemDetails } from "./TabbarItem";
 interface TabbarProps {
     tabs?: TabItemDetails[];
     selectedIndex?: number;
-    onSelect?(index: number): void;
+    onSelect?: (index: number) => void;
     className?: string;
 }
 export declare const Tabbar: ({ tabs, selectedIndex, onSelect, className }: TabbarProps) => JSX.Element;

package/dist/components/Tabbar/TabbarItem.d.ts

@@ -8,7 +8,7 @@ export interface TabItemDetails {
 interface TabbarItemProps extends TabItemDetails {
     index: number;
     isSelected?: boolean;
-    onSelect(index: number): void;
+    onSelect?: (index: number) => void;
     className?: string;
 }
 declare const TabbarItem: ({ title, index, isSelected, onSelect, className, badgeCount, isLoading, dataTestId, }: TabbarItemProps) => JSX.Element;

package/dist/components/ViewItem/ViewItem.d.ts

@@ -2,7 +2,7 @@
 import { TextProps } from "../Text/Text";
 import { RestPropped } from "../../types/general.types";
 import { ButtonProps } from "../Button/Button.types";
-export interface ViewItemProps<AccessoryType> extends RestPropped {
+export interface ViewItemProps<AccessoryType extends JSX.Element> extends RestPropped {
     titleProps?: TextProps;
     title?: string;
     titleAccessory?: AccessoryType;
@@ -12,5 +12,5 @@ export interface ViewItemProps<AccessoryType> extends RestPropped {
     className?: string;
     buttons?: ButtonProps[];
 }
-export declare function ViewItem<AccessoryType>({ titleProps, title, titleAccessory, contentProps, content, defaultContent, className, buttons, ...restProps }: ViewItemProps<AccessoryType>): JSX.Element;
+export declare function ViewItem<AccessoryType extends JSX.Element>({ titleProps, title, titleAccessory, contentProps, content, defaultContent, className, buttons, ...restProps }: ViewItemProps<AccessoryType>): JSX.Element;
 export default ViewItem;

package/dist/index.d.ts

@@ -1 +1,52 @@
+export { default as Acknowledgement, ACKNOWLEDGEMENT_TYPE_OPTIONS } from "./components/Acknowledgement/Acknowledgement";
+export { default as Avatar } from "./components/Avatar/Avatar";
+export { default as Badge } from "./components/Badge/Badge";
+export { default as Button } from "./components/Button/Button";
+export { BUTTON_ROLES, ButtonProps, BUTTON_TYPE, ButtonType } from "./components/Button/Button.types";
+export { ButtonIcon } from "./components/Button/ButtonIcon";
+export { PrimaryButton, PrimaryButtonProps } from "./components/ButtonV2/PrimaryButton";
+export { SecondaryButton, SecondaryButtonProps } from "./components/ButtonV2/SecondaryButton";
+export { TertiaryButton, TertiaryButtonProps } from "./components/ButtonV2/TertiaryButton";
+export { default as Carousel } from "./components/Carousel/Carousel";
+export { default as CenteredHero } from "./components/CenteredHero/CenteredHero";
+export { default as Checkbox } from "./components/Checkbox/Checkbox";
+export { ConfirmationDialog } from "./components/ConfirmationDialog/ConfirmationDialog";
+export { default as DatePicker } from "./components/Datepicker/Datepicker";
+export { default as Dropdown } from "./components/Dropdown/Dropdown";
+export { EmptyListMessage } from "./components/EmptyListMessage/EmptyListMessage";
+export { default as ErrorBlock } from "./components/ErrorBlock/ErrorBlock";
+export { default as InfoBlock } from "./components/InfoBlock/InfoBlock";
+export { InfoField } from "./components/InfoField/InfoField";
+export { INPUT_TYPES, default as Input } from "./components/Input/Input";
+export { default as Line } from "./components/Line/Line";
+export { default as ListItem, ListItemProps } from "./components/ListItem/ListItem";
+export { ListTable, ListTableProps, ListTablePropsConfiguration, ListTablePropsConfigurationField } from "./components/ListTable/ListTable";
+export { LoadingIndicator, LoadingIndicatorProps } from "./components/LoadingIndicator/LoadingIndicator";
+export { default as Menu } from "./components/Menu/Menu";
+export { MultiSelect } from "./components/MultiSelect/MultiSelect";
+export { NavLayout, NavMenuLayoutProps } from "./components/NavMenu/NavLayout";
+export { NavMenu } from "./components/NavMenu/NavMenu";
+export { NotificationBanner, NotificationBannerColor, NotificationBannerLinkProps } from "./components/NotificationBanner/NotificationBanner";
+export { default as Page } from "./components/Page/Page";
+export { default as CRUDPage } from "./components/Page/CRUDPage";
+export { default as PaginationMenu } from "./components/PaginationMenu/PaginationMenu";
+export { default as PreviewPhone } from "./components/PreviewPhone/PreviewPhone";
+export { default as Radio } from "./components/Radio/Radio";
+export { default as RadioGroup } from "./components/RadioGroup/RadioGroup";
+export { default as Section } from "./components/Section/Section";
+export { SettingsMenuButton, SettingsMenuButtonProps } from "./components/SettingsMenuButton/SettingsMenuButton";
+export { Spinner } from "./components/Spinner/Spinner";
+export { Steps } from "./components/Steps/Steps";
+export { default as Switcher } from "./components/Switcher/Switcher";
+export { default as Tabbar } from "./components/Tabbar/Tabbar";
+export { default as TabLinks } from "./components/TabLinks/TabLinks";
+export { default as Tag } from "./components/Tag/Tag";
+export { default as TagGroup } from "./components/Tag/TagGroup";
+export { default as TextArea } from "./components/Textarea/Textarea";
+export { default as TextEditor } from "./components/TextEditor/TextEditor";
+export { default as TextEditorV2 } from "./components/TextEditorV2/TextEditorV2";
+export { TextLink, TextLinkProps } from "./components/TextLink/TextLink";
+export { default as TextListItem } from "./components/TextListItem/TextListItem";
+export { Title, TitleStyle } from "./components/Title/Title";
+export { ViewItem, ViewItemProps } from "./components/ViewItem/ViewItem";
 export { default as Text } from "./components/Text/Text";