@typeolymp/ui-components 1.18.0 → 1.18.1

package/README.md

@@ -1,7 +1,11 @@
 # 💅🏼 ui-components
 The `ui-components` repository is a collection of [React](https://react.dev/) components, crafted with [Typescript](https://www.typescriptlang.org/) and [Styled Components](https://styled-components.com/). The components are organized according to the [Atomic Design system](https://bradfrost.com/blog/post/atomic-web-design/) and provides a versatile set of building blocks to create beautiful and consistent user interfaces.
 
-## Development
+## 📖 Table of Contents
+- [Development](https://github.com/TypeOlymp/ui-components/tree/main#-development)
+- [Contributing](https://github.com/TypeOlymp/ui-components/tree/main#-contributing)
+
+## 👨🏻‍💻 Development
 To get started with this project, follow these step:
 1. **Clone the repository:** Clone the [repository](https://github.com/TypeOlymp/ui-components) to your local machine.
 3. **Install dependencies:** Install the dependencies using `yarn install`
@@ -9,11 +13,12 @@ To get started with this project, follow these step:
 
 Open [http://localhost:6006](http://localhost:6006) with your browser to see the result.
 
-## Contributing
+## 👫 Contributing
 To contribute to the `ui-components` package, follow these step:
 1. **Clone the Repository:** Clone the [repository](https://github.com/TypeOlymp/ui-components) to your local machine.
 3. **Create a Branch:** Create a new branch for your changes using a descriptive name: `git checkout -b feature/my-new-feature`.
 4. **Make Changes:** Make your desired changes and improvements to the codebase.
 5. **Commit Changes:** Commit your changes with a clear and concise commit message: `git commit -m "Add a new feature"`.
 6. **Push Changes:** Push your changes to your development branch: `git push origin feature/my-new-feature`.
-7. **Open a Pull Request:** Visit the [repository](https://github.com/TypeOlymp/ui-components) and open a Pull Request. Describe your changes, and submit the pull request.
+7. **Update the CHANGELOG:** Update the `CHANGELOG.md` file with the new changes.
+8. **Open a Pull Request:** Visit the [repository](https://github.com/TypeOlymp/ui-components) and open a Pull Request. Describe your changes, and submit the pull request.

package/build/components/organisms/Chart/index.d.ts

@@ -1,15 +1,15 @@
 import { FC } from "react";
 import { Locale } from "@typeolymp/utils/enums";
-import { ExerciseResult, ChartType } from "./utils";
+import { ExerciseResult } from "./utils";
 declare type BasePropsType = {
     exerciseResults: ExerciseResult[];
     locale: Locale;
 };
 export declare type PropsType = (BasePropsType & {
-    type: Exclude<ChartType, "progress">;
+    type: "accuracy" | "hits" | "results" | "speed" | "time";
     nExercisesInCourse?: never;
 }) | (BasePropsType & {
-    type: ChartType.PROGRESS;
+    type: "progress";
     nExercisesInCourse: number;
 });
 declare const Chart: FC<PropsType>;

package/build/components/organisms/Chart/utils/enums.d.ts

@@ -5,11 +5,3 @@ export declare enum Period {
     "LAST_3_MONTHS" = "90d",
     "LAST_12_MONTHS" = "1y"
 }
-export declare enum ChartType {
-    "ACCURACY" = "accuracy",
-    "RESULTS" = "results",
-    "HITS" = "hits",
-    "SPEED" = "speed",
-    "PROGRESS" = "progress",
-    "TIME" = "time"
-}