stp-ui-kit 0.0.77 → 0.0.79

package/README.md

@@ -1,93 +1,153 @@
-# stp-ui-kit
+# 🎨 stp-ui-kit
 
+A custom UI Kit developed for the Smartestprep platform.  
+It provides a set of reusable, styled, and tested UI components to ensure consistent design and faster development across projects.
 
+---
 
-## Getting started
+## 📦 Installation
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+```bash
+npm install stp-ui-kit
+# or
+yarn add stp-ui-kit
+# or
+bun add stp-ui-kit
+```
+
+---
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+## 🚀 Usage
 
-## Add your files
+Import styles and components directly into your React project:
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+```tsx
+import { Button } from "stp-ui-kit";
+import "stp-ui-kit/dist/styles/index.css";
 
+export default function App() {
+  return <Button variant='primary'>Click Me</Button>;
+}
 ```
-cd existing_repo
-git remote add origin https://gitlab.com/smartest-prep/stp-ui-kit.git
-git branch -M main
-git push -uf origin main
+
+---
+
+## 📂 Project Structure
+
+```plaintext
+src/
+ ├─ assets/            # custom icons and static assets
+ ├─ components/        # UI components
+ │   ├─ data/
+ │   ├─ display/
+ │   ├─ feedback/
+ │   ├─ form/
+ │   ├─ layout/
+ │   ├─ navigation/
+ │   └─ ui/
+ ├─ lib/               # helpers, utils
+ ├─ styles/            # global styles, tokens, variables
+ │   ├─ _variables.scss
+ │   ├─ main.scss
+ │   └─ tokens.ts
+ ├─ App.tsx            # playground / dev entry
+ └─ index.ts           # main export file
 ```
 
-## Integrate with your tools
+---
+
+## 🛠 Tech Stack
+
+- React 18+ / 19+ – core UI framework
+- TypeScript – strongly typed components
+- TailwindCSS 4 + SCSS – styling and design tokens
+- Lucide-react – icon library
+- React Hook Form – form handling integration
+- Storybook 8 – interactive component documentation
+- Vite – development & build tooling
 
-- [ ] [Set up project integrations](https://gitlab.com/smartest-prep/stp-ui-kit/-/settings/integrations)
+---
 
-## Collaborate with your team
+## 📖 Documentation
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+Run Storybook to explore and test components interactively:
 
-## Test and Deploy
+```bash
+npm run storybook
+```
+
+Build the static Storybook docs:
+
+```bash
+npm run build-storybook
+```
 
-Use the built-in continuous integration in GitLab.
+---
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+## 🧑‍💻 Development
 
-***
+- Start in dev mode
 
-# Editing this README
+  ```bash
+  npm run dev
+  ```
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+- Build library
 
-## Suggestions for a good README
+  ```bash
+  npm run build
+  ```
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+- Lint & format
 
-## Name
-Choose a self-explaining name for your project.
+  ```bash
+  npm run lint
+  npm run format
+  ```
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+- Generate tokens
+  ```bash
+  npm run generate-tokens
+  ```
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+---
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+# 🔑 Principles
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+- Fully typed components (.ts / .tsx only)
+- Consistent design system powered by tokens according to Figma designs
+- Use named exports only (`export const`)
+- Remove unused/deprecated components over time
+- Do not add new dependencies unless absolutely necessary (to avoid making the project heavy)
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+### 📦 Project Releases
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+- Always upgrade the version in `package.json` before publishing
+- Do **not** run `npm publish` for every minor change
+- Always run `npm run build` before publishing
+- All changes must be commited into repository
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+### 🛠 Local Development
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+- When developing locally with other projects, use `npm link`
+  ```bash
+  # inside stp-ui-kit
+  npm link
+  # inside your project
+  npm link stp-ui-kit
+  ```
+- After testing locally, publish the updated package if required
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## 🤝 Contributing
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+1. Clone the repo
+2. Install dependencies with `npm install`
+3. Run Storybook (`npm run storybook`)
+4. Add or update a component inside `src/components`
+5. Submit a pull request 🎉
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+---
 
-## License
-For open source projects, say how it is licensed.
+## 📜 License
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+MIT © Smartestprep

package/dist/components/display/OptionList/OptionList.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 export type ShadowLevel = "lower" | "higher";
 export interface OptionListItem {
     label: string;

package/dist/components/form/Calendar/Calendar.d.ts

@@ -0,0 +1,36 @@
+import { default as dayjs, Dayjs } from '../../../lib/dayjs';
+/** Public value types */
+export type SingleValue = Dayjs | null;
+export type RangeTuple = [Dayjs | null, Dayjs | null];
+export type RangeValue = RangeTuple | null;
+/** Shared props */
+export type BaseProps = {
+    multiMonth?: boolean;
+    onCard?: boolean;
+    initialMonth?: Dayjs;
+    minDate?: Dayjs;
+    maxDate?: Dayjs;
+    weekStartsOn?: 0 | 1;
+    className?: string;
+};
+/** Single-date props (default mode) */
+export type CalendarPropsSingle = BaseProps & {
+    allowRange?: false;
+    value?: SingleValue;
+    defaultValue?: SingleValue;
+    onChange?: (value: SingleValue) => void;
+};
+/** Range props (when allowRange is true) */
+export type CalendarPropsRange = BaseProps & {
+    allowRange: true;
+    value?: RangeValue;
+    defaultValue?: RangeValue;
+    onChange?: (value: RangeValue) => void;
+};
+/** Discriminated union of prop shapes */
+export type CalendarProps = CalendarPropsSingle | CalendarPropsRange;
+/** Narrowing helpers */
+export declare const asDay: (d: Dayjs | Date | null | undefined) => dayjs.Dayjs | null;
+/** Overloads for better DX */
+export declare function Calendar(props: CalendarPropsSingle): JSX.Element;
+export declare function Calendar(props: CalendarPropsRange): JSX.Element;

package/dist/components/form/Calendar/CalendarDay/CalendarDay.d.ts

@@ -0,0 +1,13 @@
+import { default as React } from 'react';
+export type CornerType = "start" | "end" | "both" | null;
+export interface CalendarDayProps extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, "onClick"> {
+    number: number;
+    isActive?: boolean;
+    isCorner?: boolean;
+    isInRange?: boolean;
+    cornerType?: CornerType;
+    onClick?: (dayNumber: number) => void;
+    disabled?: boolean;
+    className?: string;
+}
+export declare const CalendarDay: React.MemoExoticComponent<React.ForwardRefExoticComponent<CalendarDayProps & React.RefAttributes<HTMLButtonElement>>>;

package/dist/components/form/Calendar/CalendarDayHeader/CalendarDayHeader.d.ts

@@ -0,0 +1,2 @@
+declare const CalendarDayHeader: () => import("react/jsx-runtime").JSX.Element;
+export default CalendarDayHeader;

package/dist/components/form/Calendar/CalendarMonth/CalendarMonth.d.ts

@@ -0,0 +1,21 @@
+import { Dayjs } from '../../../../lib/dayjs';
+import { CornerType } from '../CalendarDay/CalendarDay';
+export interface CalendarMonthProps {
+    monthDate: Dayjs;
+    weekStartsOn: 0 | 1;
+    locale?: string;
+    minDate?: Dayjs;
+    maxDate?: Dayjs;
+    onSelectDay: (d: Dayjs) => void;
+    isInRange?: (d: Dayjs) => boolean;
+    isSelected?: (d: Dayjs) => boolean;
+    cornerType?: (d: Dayjs) => CornerType;
+    allowRange?: boolean;
+    showPrev?: boolean;
+    showNext?: boolean;
+    onPrev?: () => void;
+    onNext?: () => void;
+    prevDisabled?: boolean;
+    nextDisabled?: boolean;
+}
+export declare const CalendarMonth: import('react').MemoExoticComponent<({ monthDate, weekStartsOn, minDate, maxDate, onSelectDay, isInRange, isSelected, cornerType, allowRange, showPrev, showNext, onPrev, onNext, prevDisabled, nextDisabled, }: CalendarMonthProps) => import("react/jsx-runtime").JSX.Element>;

package/dist/components/form/Calendar/dateUtils.d.ts

@@ -0,0 +1,15 @@
+import { Dayjs } from '../../../lib/dayjs';
+export declare const startOfDay: (d: Dayjs) => Dayjs;
+export declare const endOfDay: (d: Dayjs) => Dayjs;
+export declare const isSameDay: (a?: Dayjs | null, b?: Dayjs | null) => boolean;
+export declare const isBefore: (a: Dayjs, b: Dayjs) => boolean;
+export declare const isAfter: (a: Dayjs, b: Dayjs) => boolean;
+export declare const clampDate: (d: Dayjs, min?: Dayjs, max?: Dayjs) => Dayjs;
+export declare const addMonths: (d: Dayjs, n: number) => Dayjs;
+export declare const addDays: (d: Dayjs, n: number) => Dayjs;
+/** 6×7 grid for a month view */
+export declare const daysInMonthGrid: (month: Dayjs, weekStartsOn: 0 | 1) => {
+    date: Dayjs;
+    inCurrentMonth: boolean;
+}[];
+export declare const isDisabled: (d: Dayjs, min?: Dayjs, max?: Dayjs) => boolean | undefined;

package/dist/components/form/FormItem/FormItemContext.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 export type FormItemState = "default" | "error" | "disabled" | "readOnly";
 export interface FormItemContextValue {
     state: FormItemState;

package/dist/components/form/RadioButton/RadioButton.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 interface RadioButtonProps extends React.InputHTMLAttributes<HTMLInputElement> {
     label?: string;
     error?: string;

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

@@ -5,3 +5,7 @@ export * from './Input/Input';
 export * from './Input/TextArea';
 export * from './RadioButton/RadioButton';
 export * from './Select/Select';
+export * from './Calendar/Calendar';
+export * from './Calendar/CalendarDay/CalendarDay';
+export * from './Calendar/CalendarMonth/CalendarMonth';
+export * from './Calendar/dateUtils';

package/dist/components/navigation/Collapse/Collapse.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 export interface NavItem {
     id: string;
     name: string;

package/dist/components/navigation/CourseCollapse/CourseCollapse.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 export interface CourseNavItem {
     id: string;
     name: string;

package/dist/lib/dayjs.d.ts

@@ -0,0 +1,3 @@
+import { default as dayjs } from 'dayjs';
+export default dayjs;
+export type { Dayjs } from 'dayjs';

package/dist/lib/useIsMobile.d.ts

@@ -0,0 +1 @@
+export declare const useIsMobile: () => boolean;