techsbcn-storybook 0.26.3 → 2.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 techsbcn
+Copyright (c) 2026 techsbcn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,180 +1,140 @@
-# TSDX React w/ Storybook User Guide
+# techsbcn-storybook
 
-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.
+A React component library built by [TechsBCN](https://techsbcn.com) on top of Material UI. It provides a set of ready-to-use components — form fields, tables, layouts, navigation, modals and wrappers — designed to be consumed across internal projects with a consistent look and feel.
 
-> 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`.
+Components are developed and documented in [Storybook](https://storybook.js.org/) and shipped as an npm package.
 
-> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
+## Requirements
 
-## Commands
+- **Node.js** `>= 18`
+- **React** `>= 18` (declared as a peer dependency)
+- **Yarn** (the repository is pinned to Yarn 4 via `packageManager`)
 
-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:
+## Installation
 
 ```bash
-npm start # or yarn start
+yarn add techsbcn-storybook
 ```
 
-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:
+or
 
 ```bash
-yarn storybook
+npm install techsbcn-storybook
 ```
 
-This loads the stories from `./stories`.
+Because MUI, Emotion, React Hook Form, Yup, i18next, dayjs and Font Awesome are runtime dependencies of this library, they are installed automatically.
 
-> 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.
+## Usage
 
-### Example
+Import components directly from the package root:
 
-Then run the example inside another:
+```tsx
+import { TextFieldComponent, ButtonComponent, TableComponent } from 'techsbcn-storybook';
 
-```bash
-cd example
-npm i # or yarn to install dependencies
-npm start # or yarn start
+export const Example = () => (
+  <>
+    <TextFieldComponent name="email" label="Email" />
+    <ButtonComponent onClick={() => console.log('clicked')}>Send</ButtonComponent>
+  </>
+);
 ```
 
-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
+### Available component groups
 
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
+| Group | Components |
+| --- | --- |
+| **Fields** | `ButtonComponent`, `TextFieldComponent`, `TextSimpleComponent`, `SelectField`, `SelectAsyncField`, `DatePickerComponent` |
+| **Forms** | `LoginForm`, `ChangePasswordForm`, `ResetPasswordForm` |
+| **Tables** | `TableComponent`, `SimpleTableComponent`, `SearchComponent` |
+| **Layouts** | `MainLayoutSimple`, `AppHeader`, `AppSidebar`, `DrawerSidebar` |
+| **Navigation** | `VerticalNav`, `UserInfo` |
+| **Modals** | `ModalComponent` |
+| **Wrappers** | `MainWrapperComponent`, `PublicFormWrapper`, `TabsComponent`, `LinearProgressComponent`, `CardComponent` |
 
-### Jest
+See the Storybook documentation for the full API of each component.
 
-Jest tests are set up to run with `npm test` or `yarn test`.
+## Development
 
-### Bundle analysis
+### Getting started
 
-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`.
+```bash
+yarn install
+yarn storybook
+```
 
-#### Setup Files
+Storybook runs on [http://localhost:6006](http://localhost:6006) and hot-reloads on changes inside `src/`.
 
-This is the folder structure we set up for you:
+### Project structure
 
 ```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/       # Library source — grouped by category
+    fields/
+    forms/
+    layouts/
+    modals/
+    navigation/
+    tables/
+    wrappers/
+  content/          # Static assets (images, icons) used by stories
+  data/             # Mock data and enums used only by stories
+  helpers/          # Shared utilities and hooks
+  interfaces/       # Shared TypeScript interfaces
+  stories/          # Storybook stories
+  i18n.tsx          # Storybook-only i18n bootstrap
+  index.tsx         # Public entry point (barrel of every exported component)
+.storybook/         # Storybook configuration
+tsup.config.ts      # Build configuration (JS bundles)
+tsconfig.build.json # Build configuration (type declarations)
 ```
 
-#### React Testing Library
-
-We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
-
-### Rollup
+Only files under `src/components/` are shipped in the published package. Stories, mock data and the Storybook i18n bootstrap are excluded from the build.
 
-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.
+### Scripts
 
-### TypeScript
+| Script | Description |
+| --- | --- |
+| `yarn start` | Runs `tsup` in watch mode (rebuilds `dist/` on every change) |
+| `yarn build` | Produces the distributable output in `dist/`: CJS + ESM bundles, sourcemaps and type declarations |
+| `yarn storybook` | Starts Storybook in development mode |
+| `yarn build-storybook` | Builds the static Storybook site |
+| `yarn lint` | Runs ESLint with autofix over the codebase |
+| `yarn test` | Runs the Jest test suite |
+| `yarn size` | Reports the bundle size using [size-limit](https://github.com/ai/size-limit) |
+| `yarn analyze` | Opens the size-limit visual report |
 
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
+## Build pipeline
 
-## Continuous Integration
+The library is built in three steps, wired together in the `build` script:
 
-### GitHub Actions
+1. **`tsup`** bundles `src/index.tsx` into CommonJS (`dist/index.js`) and ES Modules (`dist/index.mjs`) using esbuild, with SCSS compiled through `esbuild-sass-plugin` and static assets (SVG/PNG) emitted as separate files.
+2. **`tsc -p tsconfig.build.json`** emits `.d.ts` declarations for the public API, excluding stories, tests, mock data and the Storybook i18n bootstrap.
+3. **`node strip-asset-imports-dts.mjs`** post-processes the emitted declarations to remove side-effect imports of `.scss`, `.css`, `.svg` and `.png` files, so consumers do not need loaders for those assets.
 
-Two actions are added by default:
+## Tech stack
 
-- `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)
+- **UI**: React 19, Material UI 9, Emotion, Font Awesome 7
+- **Forms & validation**: React Hook Form 7, Yup 1, `@hookform/resolvers`
+- **Dates**: `@mui/x-date-pickers`, `dayjs`
+- **i18n**: `i18next`, `react-i18next`, `i18next-browser-languagedetector`
+- **Routing (form components)**: `react-router-dom` 7
+- **Language & tooling**: TypeScript 6, ESLint 9 (flat config), Prettier 3, Jest 30, Storybook 10, tsup 8
 
-## 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__) {
-}
-```
+## Publishing
 
-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`):
+The package is published to npm with only the `dist/` folder included (whitelisted through the `files` field in `package.json`). Before publishing, you can preview the tarball contents with:
 
 ```bash
-cd example # if not already in the example folder
-npm run build # builds to dist
-netlify deploy # deploy the dist folder
+npm pack --dry-run
 ```
 
-Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
+To publish a new version:
 
 ```bash
-netlify init
-# build command: yarn build && cd example && yarn && yarn build
-# directory to deploy: example/dist
-# pick yes for netlify.toml
+yarn build
+yarn npm publish
 ```
 
-## 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.
-
-## Including Styles
-
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
-
-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.
-
-## Publishing to NPM
-
-We recommend using [np](https://github.com/sindresorhus/np).
-
-## 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_.
-
-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"
-   },
-```
+## License
 
-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)
+[MIT](./LICENSE) © TechsBCN

package/dist/components/fields/ButtonComponent/ButtonComponent.d.ts

@@ -1,16 +1,16 @@
-import React from 'react';
-import './ButtonComponent.scss';
-export interface ButtonComponentProps {
-    className?: string;
-    label?: any;
-    startIcon?: React.ReactNode;
-    endIcon?: React.ReactNode;
-    onClick?: () => void;
-    loading?: boolean;
-    form?: string;
-    type?: 'button' | 'submit' | 'reset';
-    disabled?: boolean;
-    component?: any;
-    reverseColors?: boolean;
-}
-export declare const ButtonComponent: React.FC<ButtonComponentProps>;
+import React from 'react';
+
+export interface ButtonComponentProps {
+    className?: string;
+    label?: any;
+    startIcon?: React.ReactNode;
+    endIcon?: React.ReactNode;
+    onClick?: () => void;
+    loading?: boolean;
+    form?: string;
+    type?: 'button' | 'submit' | 'reset';
+    disabled?: boolean;
+    component?: any;
+    reverseColors?: boolean;
+}
+export declare const ButtonComponent: React.FC<ButtonComponentProps>;

package/dist/components/fields/DatePickerComponent/DatePickerComponent.d.ts

@@ -1,26 +1,26 @@
-import React from 'react';
-import './DatePickerComponent.scss';
-import { Dayjs } from 'dayjs';
-declare type CalendarPickerView = 'year' | 'day' | 'month';
-export interface DatePickerComponentProps {
-    id?: string;
-    label?: string;
-    name?: string;
-    value?: string | Dayjs | null;
-    className?: string;
-    inputFormat?: string;
-    required?: boolean;
-    disabled?: boolean;
-    error?: boolean;
-    startIcon?: React.ReactNode;
-    fullWidth?: boolean;
-    helperText?: string;
-    inputRef?: React.Ref<any>;
-    onChange: (value: any, keyboardInputValue?: string | undefined) => void;
-    noBorders?: boolean;
-    maxDate?: any;
-    minDate?: any;
-    views?: CalendarPickerView[];
-}
-export declare const DatePickerComponent: React.FC<DatePickerComponentProps>;
-export {};
+import React from 'react';
+
+import { Dayjs } from 'dayjs';
+declare type CalendarPickerView = 'year' | 'day' | 'month';
+export interface DatePickerComponentProps {
+    id?: string;
+    label?: string;
+    name?: string;
+    value?: string | Dayjs | null;
+    className?: string;
+    inputFormat?: string;
+    required?: boolean;
+    disabled?: boolean;
+    error?: boolean;
+    startIcon?: React.ReactNode;
+    fullWidth?: boolean;
+    helperText?: string;
+    inputRef?: React.Ref<any>;
+    onChange: (value: any, context?: any) => void;
+    noBorders?: boolean;
+    maxDate?: any;
+    minDate?: any;
+    views?: CalendarPickerView[];
+}
+export declare const DatePickerComponent: React.FC<DatePickerComponentProps>;
+export {};

package/dist/components/fields/SelectFieldComponent/SelectAsyncField.d.ts

@@ -1,28 +1,28 @@
-import React from 'react';
-import { SearchFilters } from '../../../interfaces';
-import './SelectField.scss';
-declare type MenuPlacement = 'bottom' | 'auto' | 'top';
-interface SelectAsyncFieldProps {
-    name: string;
-    placeholder?: string;
-    defaultOptions?: any[];
-    isMulti?: boolean;
-    className?: string;
-    disabled?: boolean;
-    onChange?: (value: any, name: string) => void;
-    onChangeValue?: (value: any) => void;
-    onChangeOption?: (value: any, label: string, extra?: any) => void;
-    searchPromise: (filters: SearchFilters) => Promise<any>;
-    invalid?: boolean;
-    isClearable?: boolean;
-    helperText?: string;
-    filters?: any;
-    inputRef?: React.Ref<any>;
-    label?: string;
-    menuPlacement?: MenuPlacement;
-    value?: any[];
-    getOptionLabel?: (option: any) => any;
-    noBorders?: boolean;
-}
-export declare const SelectAsyncField: React.FunctionComponent<SelectAsyncFieldProps>;
-export {};
+import React from 'react';
+import { SearchFilters } from '../../../interfaces';
+
+type MenuPlacement = 'bottom' | 'auto' | 'top';
+interface SelectAsyncFieldProps {
+    name: string;
+    placeholder?: string;
+    defaultOptions?: any[];
+    isMulti?: boolean;
+    className?: string;
+    disabled?: boolean;
+    onChange?: (value: any, name: string) => void;
+    onChangeValue?: (value: any) => void;
+    onChangeOption?: (value: any, label: string, extra?: any) => void;
+    searchPromise: (filters: SearchFilters) => Promise<any>;
+    invalid?: boolean;
+    isClearable?: boolean;
+    helperText?: string;
+    filters?: any;
+    inputRef?: React.Ref<any>;
+    label?: string;
+    menuPlacement?: MenuPlacement;
+    value?: any[];
+    getOptionLabel?: (option: any) => any;
+    noBorders?: boolean;
+}
+export declare const SelectAsyncField: React.FunctionComponent<SelectAsyncFieldProps>;
+export {};

package/dist/components/fields/SelectFieldComponent/SelectField.d.ts

@@ -1,29 +1,29 @@
-import React from 'react';
-import './SelectField.scss';
-declare type MenuPlacement = 'bottom' | 'auto' | 'top';
-interface SelectFieldProps {
-    name: string;
-    placeholder?: string;
-    options: any[];
-    defaultOptions?: any[];
-    isMulti?: boolean;
-    className?: string;
-    disabled?: boolean;
-    onChange?: (value: any, name: string) => void;
-    onChangeValue?: (value: any) => void;
-    onChangeOption?: (option: any, name?: string) => void;
-    invalid?: boolean;
-    isClearable?: boolean;
-    helperText?: string;
-    isSearchable?: boolean;
-    inputRef?: React.Ref<any>;
-    label?: string;
-    menuPlacement?: MenuPlacement;
-    isLoading?: boolean;
-    value?: any[];
-    getOptionLabel?: (option: any) => any;
-    addExtraOption?: any;
-    noBorders?: boolean;
-}
-export declare const SelectField: React.FunctionComponent<SelectFieldProps>;
-export {};
+import React from 'react';
+
+type MenuPlacement = 'bottom' | 'auto' | 'top';
+interface SelectFieldProps {
+    name: string;
+    placeholder?: string;
+    options: any[];
+    defaultOptions?: any[];
+    isMulti?: boolean;
+    className?: string;
+    disabled?: boolean;
+    onChange?: (value: any, name: string) => void;
+    onChangeValue?: (value: any) => void;
+    onChangeOption?: (option: any, name?: string) => void;
+    invalid?: boolean;
+    isClearable?: boolean;
+    helperText?: string;
+    isSearchable?: boolean;
+    inputRef?: React.Ref<any>;
+    label?: string;
+    menuPlacement?: MenuPlacement;
+    isLoading?: boolean;
+    value?: any[];
+    getOptionLabel?: (option: any) => any;
+    addExtraOption?: any;
+    noBorders?: boolean;
+}
+export declare const SelectField: React.FunctionComponent<SelectFieldProps>;
+export {};

package/dist/components/fields/TextFieldComponent/TextFieldComponent.d.ts

@@ -1,34 +1,34 @@
-import React from 'react';
-import { StandardTextFieldProps } from '@mui/material/';
-import './TextFieldComponent.scss';
-export declare type InputType = 'button' | 'checkbox' | 'color' | 'date' | 'datetime-local' | 'email' | 'file' | 'hidden' | 'image' | 'month' | 'number' | 'password' | 'radio' | 'range' | 'reset' | 'search' | 'submit' | 'tel' | 'text' | 'time' | 'url' | 'week';
-export interface TextFieldComponentProps extends StandardTextFieldProps {
-    id?: string;
-    label?: string;
-    name?: string;
-    value?: string | number;
-    className?: string;
-    type?: InputType;
-    placeholder?: string;
-    required?: boolean;
-    disabled?: boolean;
-    minNumber?: number;
-    maxNumber?: number;
-    error?: boolean;
-    startIcon?: React.ReactNode;
-    endIcon?: React.ReactNode;
-    fullWidth?: boolean;
-    helperText?: string;
-    textFieldRef?: any;
-    inputRef?: React.Ref<any>;
-    autoComplete?: string;
-    multiline?: boolean;
-    rows?: number;
-    maxLength?: number;
-    defaultValue?: string | number;
-    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
-    onKeyUp?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
-    step?: number | string;
-    noBorders?: boolean;
-}
-export declare const TextFieldComponent: React.FC<TextFieldComponentProps>;
+import React from 'react';
+import { StandardTextFieldProps } from '@mui/material';
+
+export type InputType = 'button' | 'checkbox' | 'color' | 'date' | 'datetime-local' | 'email' | 'file' | 'hidden' | 'image' | 'month' | 'number' | 'password' | 'radio' | 'range' | 'reset' | 'search' | 'submit' | 'tel' | 'text' | 'time' | 'url' | 'week';
+export interface TextFieldComponentProps extends StandardTextFieldProps {
+    id?: string;
+    label?: string;
+    name?: string;
+    value?: string | number;
+    className?: string;
+    type?: InputType;
+    placeholder?: string;
+    required?: boolean;
+    disabled?: boolean;
+    minNumber?: number;
+    maxNumber?: number;
+    error?: boolean;
+    startIcon?: React.ReactNode;
+    endIcon?: React.ReactNode;
+    fullWidth?: boolean;
+    helperText?: string;
+    textFieldRef?: any;
+    inputRef?: React.Ref<any>;
+    autoComplete?: string;
+    multiline?: boolean;
+    rows?: number;
+    maxLength?: number;
+    defaultValue?: string | number;
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    onKeyUp?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
+    step?: number | string;
+    noBorders?: boolean;
+}
+export declare const TextFieldComponent: React.FC<TextFieldComponentProps>;

package/dist/components/fields/TextSimpleComponent/TextSimpleComponent.d.ts

@@ -1,32 +1,32 @@
-import React from 'react';
-import { BoxProps } from '@mui/material/';
-import './TextSimpleComponent.scss';
-interface TextSimpleComponentProps {
-    label?: any | string;
-    skeletonLabel?: boolean;
-    isFormLabel?: boolean;
-    value?: any;
-    classNameLabel?: string;
-    className?: string;
-    error?: boolean;
-    startIcon?: React.ReactNode;
-    endIcon?: React.ReactNode;
-    helperText?: string;
-    noBorders?: boolean;
-    fullWidth?: boolean;
-    noMargin?: boolean;
-    isLoading?: boolean;
-    skeletonValue?: SkeletonProps;
-    componentBoxProps?: BoxProps;
-    valueBoxProps?: BoxProps;
-    labelBoxProps?: BoxProps;
-    helperBoxProps?: BoxProps;
-    labelMargin?: boolean;
-    valueInCenter?: boolean;
-}
-interface SkeletonProps {
-    useSkeleton: boolean;
-    mineSkeleton?: any;
-}
-export declare const TextSimpleComponent: React.FC<TextSimpleComponentProps>;
-export {};
+import React from 'react';
+import { BoxProps } from '@mui/material';
+
+interface TextSimpleComponentProps {
+    label?: any | string;
+    skeletonLabel?: boolean;
+    isFormLabel?: boolean;
+    value?: any;
+    classNameLabel?: string;
+    className?: string;
+    error?: boolean;
+    startIcon?: React.ReactNode;
+    endIcon?: React.ReactNode;
+    helperText?: string;
+    noBorders?: boolean;
+    fullWidth?: boolean;
+    noMargin?: boolean;
+    isLoading?: boolean;
+    skeletonValue?: SkeletonProps;
+    componentBoxProps?: BoxProps;
+    valueBoxProps?: BoxProps;
+    labelBoxProps?: BoxProps;
+    helperBoxProps?: BoxProps;
+    labelMargin?: boolean;
+    valueInCenter?: boolean;
+}
+interface SkeletonProps {
+    useSkeleton: boolean;
+    mineSkeleton?: any;
+}
+export declare const TextSimpleComponent: React.FC<TextSimpleComponentProps>;
+export {};